Product Documentation

Full-Text Search

Previous Topic

Next Topic

ctdbStartFTIBackgroundLoad

Starts a background index loader for the Full-Text Index (FTI).

Declaration

CTDBRET ctdbLOCAL ctdbStartFTIBackgroundLoad(pCTDBFTI pFTI)

Description

  • pFTI - [IN] Full-Text Index handle.

Options

In addition to the existing FTI options:

CTDB_FTI_OPTION_IGNORE_EXISTING - ignore existing record.

The following FTI option has been added:

CTDB_FTI_OPTION_BACKLOAD_EXISTING - load existing record in background.

The setting is persisted so that, in the case of an Alter Table that requires rebuilding the index, the behavior will be the one specified at creation time.

Note: It is not possible to delete an FTI for which a background load has been started and still not finished. Attempting this operation causes the ctdbAlterTable() to fail with error CTDBRET_LOADISACTIVE (4166, new error code).

This function was originally named ctdbFTIStartBackgroundLoad, which has been deprecated.

Return Values

Value

Symbolic Constant

Explanation

0

NO_ERROR

Successful operation.

See c-tree Plus Error Codes for a complete listing of valid c-tree Plus error values.

Example

ctdbSetFTIOption(pFTI, CTDB_FTI_OPTION_UPD, NULL, CTDB_FTI_OPTION_BACKLOAD_EXISTING)

See Also

TOCIndex