Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BtreeIndex

Hierarchy

  • BtreeIndex

Index

Properties

Optional cursorable

cursorable: undefined | false | true

Whether the index can be used for cursor-based pagination

Optional indexType

indexType: undefined | "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

properties: string[]

List of properties to define the index across