Generated Index Functions

The following functions are generated for each index (classname_indexname) specified in the schema:

classname_indexname_create() Build the tree index for an index declared as voluntary
classname_indexname_drop() Removes the tree index for an index declared as voluntary
classname_indexname_index_cursor() Create a cursor for cursor search and navigation functions
classname_indexname_find() Search the database for an exact match of the specified index values

classname_indexname_search()

Search the database based on a specified opcode

classname_indexname_pattern_size()

Allocate a buffer that is used for a state machine within eXtremeDB

classname_indexname_pattern_search()

Initiates the pattern search

classname_indexname_pattern_next()

Initiates the pattern search

classname_indexname_locate()

Uses the element values of the object referenced by handle to position the tree index internal pointers

classname_indexname_compare(tree)

Compares the value(s) referenced by the current position of the index cursor with value(s) supplied by the application

classname_indexname_next_match(patricia)(scalar)

Advances the cursor to the next record matching the key value

classname_indexname_next_match(patricia)(bit array)

Advances the cursor to the next record matching the key value

classname_indexname_next_match(patricia)(string)(vector)

Advances the cursor to the next record matching the key value

classname_indexname_prefix_match(patricia)(scalar)

Finds the first object whose index matches the number of bits specified

classname_indexname_prefix_match(patricia)(bit array)

Finds the first object whose index matches the number of bits specified

classname_indexname_prefix_match(patricia)(string)(vector)

Finds the first object whose index matches the number of bits specified

classname_indexname_longest_match(patricia)(scalar)

Finds the last object whose index has the ‘deepest’ match with the key value specified in ‘mask’

classname_indexname_longest_match(patricia)(bit array)

Finds the last object whose index has the ‘deepest’ match with the key value specified in ‘mask’

classname_indexname_longest_match(patricia)(string/vector)

Finds the last object whose index has the ‘deepest’ match with the key value specified in ‘mask’

classname_indexname_exact_match(patricia)(scalar)

Finds the first object whose index matches the number of bits in the key value specified in ‘mask'

classname_indexname_exact_match(patricia)(bit array)

Finds the first object whose index matches the number of bits in the key value specified in ‘mask'

classname_indexname_exact_match(patricia)(string/vector)

Finds the first object whose index matches the number of bits in the key value specified in ‘mask'

classname_indexname_get_index(index on vector)

Returns the index identifier for the index associated with the cursor