bts_index_compact() function

The bts_index_compact() function deletes all documents from the bts index that are marked as deleted.

Syntax

bts_index_compact('index_name ')
index_name
The name of the bts index for which you want to delete rows.

Usage

Use the bts_index_compact() function to delete documents from a bts index that was created with the default deletion mode parameter of delete="deferred". The bts_index_compact() function releases space in the index by immediately deleting the rows marked as deleted. The index is unavailable while it is rewritten. Optionally, you can include the index storage space path and file name, the database name, and the owner name in addition to the index name, separated by forward slash (/) characters.

Documents marked as deleted can also be deleted with the oncheck utility. For oncheck syntax and information about optimizing the bts index, see delete index parameter.

Return codes

t
The operation was successful.
f
The operation was unsuccessful.

Example

The following example compacts the bts index desc_idx:
EXECUTE FUNCTION bts_index_compact('desc_idx');