const classafMongo::Index

sys::Obj
  afMongo::Index

Represents a MongoDB index.

ASC

Source

const static Int ASC := 1

Use in key arguments to denote sort order.

DESC

Source

const static Int DESC := -1

Use in key arguments to denote sort order.

create

Source

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 Mongo 1 and -1 for ascending / descending or the strings ASC / DESC.

@see http://docs.mongodb.org/manual/reference/command/createIndexes/

drop

Source

This drop(Bool checked := true)

Drops this index.

@see http://docs.mongodb.org/manual/reference/command/dropIndexes/

ensure

Source

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 to false.

Returns true if the index was (re)-created, false if nothing changed.

exists

Source

Bool exists()

Returns true if this index exists.

info

Source

Str:Obj? info()

Returns index info.

@see http://docs.mongodb.org/manual/reference/method/db.collection.getIndexes/

make

Source

new make(ConnectionManager conMgr, Str collectionQname, Str indexName, |This? f := null)

Creates an Index with the given details.

name

Source

const Str name

The name of this index.