mongo4cats-kernel
API
Generated with
mongo4cats-kernel/mongo4cats/mongo4cats.operations/Index

Index

mongo4cats.operations.Index
See theIndex companion object
class Index(indexes: List[Bson]) extends Serializable

Attributes

Companion
object
Graph
Supertypes
trait AsJavaConverters
trait Serializable
class Object
trait Matchable
class Any
Known subtypes
object Index

Members list

Value members

Constructors

def this()

Concrete methods

def ascending(fieldName: String): Index

Create an index key for an ascending index on the given field.

Create an index key for an ascending index on the given field.

Value parameters

fieldName

the field name

Attributes

Returns

the index specification https://docs.mongodb.com/manual/core/index-single/#single-field-indexes

def ascending(fieldNames: Seq[String]): Index

Create an index key for an ascending index on the given fields.

Create an index key for an ascending index on the given fields.

Value parameters

fieldNames

the field names, which must contain at least one

Attributes

Returns

the index specification https://docs.mongodb.com/manual/core/index-single/#single-field-indexes

def combinedWith(anotherIndex: Index): Index

Combines 2 indexes together to create a compound index specifications. If any field names are repeated, the last one takes precedence.

Combines 2 indexes together to create a compound index specifications. If any field names are repeated, the last one takes precedence.

Value parameters

anotherIndex

the index to be combined with

Attributes

Returns

the index specification

def descending(fieldName: String): Index

Create an index key for an descending index on the given field.

Create an index key for an descending index on the given field.

Value parameters

fieldName

the field name

Attributes

Returns

the index specification https://docs.mongodb.com/manual/core/index-single/#single-field-indexes

def descending(fieldNames: Seq[String]): Index

Create an index key for an descending index on the given fields.

Create an index key for an descending index on the given fields.

Value parameters

fieldNames

the field names, which must contain at least one

Attributes

Returns

the index specification https://docs.mongodb.com/manual/core/index-single/#single-field-indexes

override def equals(other: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that

the object to compare against this object for equality.

Attributes

Returns

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Any
def geo2d(fieldName: String): Index

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.

Value parameters

fieldName

the field to create a 2d index on

Attributes

Returns

the index specification https://docs.mongodb.com/manual/core/2d/

def geo2dsphere(fieldName: String): Index

Create an index key for an 2dsphere index on the given field.

Create an index key for an 2dsphere index on the given field.

Value parameters

fieldName

the field name

Attributes

Returns

the index specification https://docs.mongodb.com/manual/core/2dsphere/

def geo2dsphere(fieldNames: Seq[String]): Index

Create an index key for an 2dsphere index on the given fields.

Create an index key for an 2dsphere index on the given fields.

Value parameters

fieldNames

the field names, which must contain at least one

Attributes

Returns

the index specification https://docs.mongodb.com/manual/core/2dsphere/

override def hashCode(): Int

Calculates a hash code value for the object.

Calculates a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns

the hash code value for this object.

Definition Classes
Any
def hashed(fieldName: String): Index

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

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

Value parameters

fieldName

the field to create a hashed index on

Attributes

Returns

the index specification https://docs.mongodb.com/manual/core/index-hashed/

def text(fieldName: String): Index

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

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

Value parameters

fieldName

the field to create a text index on

Attributes

Returns

the index specification https://docs.mongodb.com/manual/core/index-text/

def text: Index

Create an index key for a text index on every field that contains string data.

Create an index key for a text index on every field that contains string data.

Attributes

Returns

the index specification https://docs.mongodb.com/manual/core/index-text/

override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Any

Inherited methods

def asJava[K, V](m: Map[K, V]): ConcurrentMap[K, V]

Attributes

Inherited from:
AsJavaConverters
def asJava[K, V](m: Map[K, V]): Map[K, V]

Attributes

Inherited from:
AsJavaConverters
def asJava[K, V](m: Map[K, V]): Map[K, V]

Attributes

Inherited from:
AsJavaConverters
def asJava[A](s: Set[A]): Set[A]

Attributes

Inherited from:
AsJavaConverters
def asJava[A](s: Set[A]): Set[A]

Attributes

Inherited from:
AsJavaConverters
def asJava[A](s: Seq[A]): List[A]

Attributes

Inherited from:
AsJavaConverters
def asJava[A](s: Seq[A]): List[A]

Attributes

Inherited from:
AsJavaConverters
def asJava[A](b: Buffer[A]): List[A]

Attributes

Inherited from:
AsJavaConverters
def asJava[A](i: Iterable[A]): Iterable[A]

Attributes

Inherited from:
AsJavaConverters
def asJava[A](i: Iterator[A]): Iterator[A]

Attributes

Inherited from:
AsJavaConverters
def asJavaCollection[A](i: Iterable[A]): Collection[A]

Attributes

Inherited from:
AsJavaConverters
def asJavaDictionary[K, V](m: Map[K, V]): Dictionary[K, V]

Attributes

Inherited from:
AsJavaConverters
def asJavaEnumeration[A](i: Iterator[A]): Enumeration[A]

Attributes

Inherited from:
AsJavaConverters
Generated with