object Indexes
A factory for defining index keys. A convenient way to use this class is to statically import all of its methods, which allows usage like:
collection.createIndex(compoundIndex(ascending("x"), descending("y")))
- Since
1.0
- Alphabetic
- By Inheritance
- Indexes
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- def ascending(fieldNames: String*): Bson
Create an index key for an ascending index on the given fields.
Create an index key for an ascending index on the given fields.
- fieldNames
the field names, which must contain at least one
- returns
the index specification
- See also
- def compoundIndex(indexes: Bson*): Bson
create a compound index specifications.
create a compound index specifications. If any field names are repeated, the last one takes precedence.
- indexes
the index specifications
- returns
the compound index specification
- See also
- def descending(fieldNames: String*): Bson
Create an index key for an ascending index on the given fields.
Create an index key for an ascending index on the given fields.
- fieldNames
the field names, which must contain at least one
- returns
the index specification
- See also
- def geo2d(fieldName: String): Bson
Create an index key for a 2d index on the given field.
Create an index key for a 2d index on the given field.
Note: A 2d index is for data stored as points on a two-dimensional plane. The 2d index is intended for legacy coordinate pairs used in MongoDB 2.2 and earlier.
- fieldName
the field to create a 2d index on
- returns
the index specification
- See also
- def geo2dsphere(fieldNames: String*): Bson
Create an index key for an 2dsphere index on the given fields.
Create an index key for an 2dsphere index on the given fields.
- fieldNames
the field names, which must contain at least one
- returns
the index specification
- See also
- def hashed(fieldName: String): Bson
Create an index key for a hashed index on the given field.
Create an index key for a hashed index on the given field.
- fieldName
the field to create a hashed index on
- returns
the index specification
- See also
- def text(fieldName: String): Bson
Create an index key for a text index on the given field.
Create an index key for a text index on the given field.
- fieldName
the field to create a text index on
- returns
the index specification
- See also
This is the documentation for the MongoDB Scala driver.
Driver structure
The mongodb scala driver.
To get started you need a MongoClient instance, either from a connection string or via a org.mongodb.scala.MongoClientSettings.
Notable packages include: