interface BtreeIndex {
    bySpace?: boolean;
    cursorable?: boolean;
    indexType?: "btree";
    properties: string[];
}

Properties

bySpace?: boolean

Whether to make the index space-specific

cursorable?: boolean

Whether the index can be used for cursor-based pagination

indexType?: "btree"

The B-tree index supports the following operations;

  • less than,
  • less than or equal,
  • equality (is equal),
  • larger than or equal, and
  • larger than. By enabling the index to be cursorable, you can use it to efficiently query with custom sort options, and queries will emit cursors that can be used to paginate through the results.
properties: string[]

List of properties to define the index across