SDK Reference


Single-field indexes are automatically generated, but multi-field compound indexes need to be added by the DB admin before collections can be accessed with complex queries.

add an index

await db.addIndex([ [ "age" ], [ "height", "desc" ] ], "people")

get indexes of a collection

await db.getIndexes("people")

remove an index

await db.removeIndex([ [ "age" ], [ "height", "desc" ] ], "people")


__id__ is reserved to auto-index doc ids. __id__ field will not be indexed, and __id__ cannot be used in multi-field indexes.

You can, however, use __id__ to get a collection in descending order sorted by doc id.

await db.get("people", ["__id__", "desc"], 5)