Full-Text Search

c-treeDB FTS API

This section provides reference information about the c-treeDB API functions that support Full-Text Search.

The following c-treeDB API functions are available for Full-Text Search:

• ctdbAddFTI - Add a new Full-Text Search Index to a table.
• ctdbAddFTIField - Add a new field to a Full-Text Search Index.
• ctdbAddFTIFieldByName - Add a new field to an FTS Index.
• ctdbAllocFTI - Allocate memory for a new Full-Text Search handle.
• ctdbCheckFTIBackgroundLoad - Check the status of the background index loader for the FTI.
• ctdbDelFTI - Delete a table's Full-Text Search configuration.
• ctdbFreeFTI - Release all resources associated with a Full-Text Search handle.
• ctdbFTSearchOff - Disable and free an existing Full-Text Search.
• ctdbFTSearchOn - Set up a new Full-Text Search.
• ctdbGetFTI - Retrieve the Full-Text Search handle.
• ctdbGetFTIByName - Retrieve the index handle given the index name.
• ctdbGetFTIByUID - Retrieve an FTI by its unique ID.
• ctdbGetFTIField - Retrieve the field handle of the field indicated by FieldNumber.
• ctdbGetFTIFieldCount - Retrieve the number of segments associated with this index.
• ctdbGetFTIFieldMode - Return the field mode specified when adding the field to the FTI.
• ctdbGetFTIHandle - Return the Full-Text Search handle or NULL on failure.
• ctdbGetFTIName - Retrieve the name of the FTI.
• ctdbGetFTINbr - Get the number of an FTI in the FTI list.
• ctdbGetFTINbrByName - Retrieve the index number given the index name.
• ctdbGetFTIStatus - Retrieve the status of the index handle.
• ctdbGetTableFTICount - Retrieve the number of FTS indices associated with the table.
• ctdbIsFTSearchOn - Indicate if a Full-Text Search is active or not.
• ctdbSetDefaultFTI - Disable and free an existing Full-Text Search.
• ctdbSetFTICndxExpr - Set the conditional expression for this Full Text Index.
• ctdbSetFTIOption - Allows several Full-Text Search values to be set depending on the option.
• ctdbStartFTIBackgroundLoad - Starts a background index loader for the FTI.

In This Chapter ctdbAddFTI ctdbAddFTIField ctdbAddFTIFieldByName ctdbAllocFTI ctdbCheckFTIBackgroundLoad ctdbDelFTI ctdbFreeFTI ctdbFTSearchOff ctdbFTSearchOn ctdbGetFTI ctdbGetFTIByName ctdbGetFTIByUID ctdbGetFTIField ctdbGetFTIFieldCount ctdbGetFTIFieldMode ctdbGetFTIHandle ctdbGetFTIName ctdbGetFTINbr ctdbGetFTINbrByName ctdbGetFTIStatus ctdbGetTableFTICount ctdbIsFTSearchOn ctdbSetDefaultFTI ctdbSetFTICndxExpr ctdbSetFTIOption ctdbStartFTIBackgroundLoad c-treeDB - FTI Background Initial Load