- Publicity: Public Only All
tsearch2-driver-procs.tcl
Procedures for tsearch full text engine driver
- Location:
- packages/tsearch2-driver/tcl/tsearch2-driver-procs.tcl
- Created:
- 2004-06-05
- Author:
- Dave Bauer <dave@thedesignexperience.org>
- CVS Identification:
$Id: tsearch2-driver-procs.tcl,v 1.41.2.12 2022/09/12 16:26:11 antoniop Exp $
Procedures in this file
- tsearch2::build_query_tcl (public)
- tsearch2::index (public)
- tsearch2::summary (public)
- tsearch2::unindex (public)
- tsearch2::update_index (public, deprecated)
Detailed information
tsearch2::build_query_tcl (public)
tsearch2::build_query_tcl [ -query query ]
Convert conjunctions to query characters for tsearch2 and => & not => ! or => | space => | (or)
- Switches:
- -query (optional)
- string to convert
- Returns:
- returns formatted query string for tsearch2 tsquery
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- build_query_tcl
tsearch2::index (public)
tsearch2::index object_id txt title keywords
Add or update an object in the full text index.
- Parameters:
- object_id (required)
- txt (required)
- title (required)
- keywords (required)
- Returns:
- nothing
- Author:
- Dave Bauer <dave@thedesignexperience.org>
- Created:
- 2004-06-05
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- index_unindex
tsearch2::summary (public)
tsearch2::summary query txt
Highlights matching terms.
- Parameters:
- query (required)
- txt (required)
- Returns:
- summary containing search query terms
- Error:
- Author:
- Dave Bauer <dave@thedesignexperience.org>
- Created:
- 2004-06-05
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- summary
tsearch2::unindex (public)
tsearch2::unindex object_id
Remove item from FTS index
- Parameters:
- object_id (required)
- Returns:
- nothing
- Author:
- Dave Bauer <dave@thedesignexperience.org>
- Created:
- 2004-06-05
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- index_unindex
tsearch2::update_index (public, deprecated)
tsearch2::update_index [ args... ]
Deprecated. Invoking this procedure generates a warning.
update full text index DEPRECATED: modern SQL supports upsert idioms
- Returns:
- nothing
- Author:
- Dave Bauer <dave@thedesignexperience.org>
- Created:
- 2004-06-05
- See Also:
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.