const classafMongo::Index
sys::Obj afMongo::Index
Represents a MongoDB index.
- ASC
const static Int ASC := 1
Use in
key
arguments to denote sort order.- DESC
const static Int DESC := -1
Use in
key
arguments to denote sort order.- create
This create(Str:Obj key, Bool? unique := (Bool?)false, Str:Obj options := ([Str:Obj])[:])
Creates this index.
key
is a map of fields to index type. Values may either be the standard Mongo1
and-1
for ascending / descending or the stringsASC
/DESC
.@see http://docs.mongodb.org/manual/reference/command/createIndexes/
- drop
This drop(Bool checked := true)
Drops this index.
@see http://docs.mongodb.org/manual/reference/command/dropIndexes/
- ensure
Bool ensure(Str:Obj key, Bool? unique := null, Str:Obj options := ([Str:Obj])[:])
Ensures this index exists. If the index does not exist, it is created. If it exists but with a different key / options, it is dropped and re-created.
unique
if not specified, defaults tofalse
.Returns
true
if the index was (re)-created,false
if nothing changed.- exists
Bool exists()
Returns
true
if this index exists.- info
Returns index info.
@see http://docs.mongodb.org/manual/reference/method/db.collection.getIndexes/
- make
new make(ConnectionManager conMgr, Str collectionQname, Str indexName, |This? f := null)
Creates an
Index
with the given details.- name
const Str name
The name of this index.