Interface: CreateIndexDefinition
The definition of an index. This is used with createIndex when creating indexes.
Properties
allowEmpty
• Optional
allowEmpty: boolean
If true
, indexing empty values will not emit a warning. Defaults to false
.
jsonPointer
• jsonPointer: string
A JSON Pointer pointing at the sub value inside each value to index over.
For example, one might index over users' ages like so:
createIndex({name: 'usersByAge', keyPrefix: '/user/', jsonPointer: '/age'})
name
• name: string
The name of the index. This is used when you scan over an index.
prefix
• Optional
prefix: string
The prefix, if any, to limit the index over. If not provided the values of all keys are indexed.