SQLITE3_VTAB_COLLATION(3)

NAME
sqlite3_vtab_collation - Determine The Collation For a Virtual Table Constraint

SYNOPSIS
#include <sqlite3.h>
const char *
sqlite3_vtab_collation(sqlite3_index_info*, int);

DESCRIPTION
This function may only be called from within a call to the xBestIndex method of a virtual table. This function returns a pointer to a string that is the name of the appropriate collation sequence to use for text comparisons on the constraint identified by its arguments.

The first argument must be the pointer to the sqlite3_index_info object that is the first parameter to the xBestIndex() method. The second argument must be an index into the aConstraint[] array belonging to the sqlite3_index_info structure passed to xBestIndex.

Important: The first parameter must be the same pointer that is passed into the xBestMethod() method. The first parameter may not be a pointer to a different sqlite3_index_info object, even an exact copy.

The return value is computed as follows:

1.

    If the constraint comes from a WHERE clause expression that contains a COLLATE operator, then the name of the collation specified by that COLLATE operator is returned.

2.

    If there is no COLLATE operator, but the column that is the subject of the constraint specifies an alternative collating sequence via a COLLATE clause on the column definition within the CREATE TABLE statement that was passed into sqlite3_declare_vtab(), then the name of that alternative collating sequence is returned.

3.

    Otherwise, "BINARY" is returned.

IMPLEMENTATION NOTES
These declarations were extracted from the interface documentation at line 9515.

    SQLITE_API SQLITE_EXPERIMENTAL const char *sqlite3_vtab_collation(sqlite3_index_info*,int);

SEE ALSO
sqlite3_declare_vtab(3), sqlite3_index_info(3)