Packages

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

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Indexes
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. 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

    indexes

  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  7. 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

    compoundIndex

  8. 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

    indexes

  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. 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

    2d index

  12. 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

    2dsphere Index

  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  15. 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

    hashed index

  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. 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

    text index

  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def geoHaystack(fieldName: String, additional: Bson): Bson

    Create an index key for a geohaystack index on the given field.

    Create an index key for a geohaystack index on the given field.

    Note: For queries that use spherical geometry, a 2dsphere index is a better option than a haystack index. 2dsphere indexes allow field reordering; geoHaystack indexes require the first field to be the location field. Also, geoHaystack indexes are only usable via commands and so always return all results at once..

    fieldName

    the field to create a geoHaystack index on

    additional

    the additional field that forms the geoHaystack index key

    returns

    the index specification

    Annotations
    @deprecated
    Deprecated

    (Since version 4.2.1) geoHaystack is deprecated in MongoDB 4.4

    See also

    geoHaystack index

Inherited from AnyRef

Inherited from Any

Ungrouped