Class

io.scalajs.npm.mongodb

IndexOptions

Related Doc: package mongodb

Permalink

class IndexOptions extends Object

Index Options

Annotations
@RawJSType() @ScalaJSDefined()
Linear Supertypes
Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. IndexOptions
  2. Object
  3. Any
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new IndexOptions(w: UndefOr[|[Int, String]] = js.undefined, wtimeout: UndefOr[Int] = js.undefined, j: UndefOr[Boolean] = js.undefined, unique: UndefOr[Boolean] = js.undefined, sparse: UndefOr[Boolean] = js.undefined, background: UndefOr[Boolean] = js.undefined, dropDups: UndefOr[Boolean] = js.undefined, min: UndefOr[Int] = js.undefined, max: UndefOr[Int] = js.undefined, v: UndefOr[Int] = js.undefined, expireAfterSeconds: UndefOr[Int] = js.undefined, name: UndefOr[Int] = js.undefined, partialFilterExpression: UndefOr[Any] = js.undefined)

    Permalink

    w

    The write concern (number | string; default: null).

    wtimeout

    The write concern timeout (default: null).

    j

    Specify a journal write concern (default: false).

    unique

    Creates an unique index (default: false).

    sparse

    Creates a sparse index (default: false).

    background

    Creates the index in the background, yielding whenever possible (default: false).

    dropDups

    A unique index cannot be created on a key that has pre-existing duplicate values. If you would like to create the index anyway keeping the first document the database indexes and deleting all subsequent documents that have duplicate value (default: false).

    min

    For geospatial indexes set the lower bound for the co-ordinates (default: null).

    max

    For geospatial indexes set the high bound for the co-ordinates (default: null).

    v

    Specify the format version of the indexes (default: null).

    expireAfterSeconds

    Allows you to expire data on indexes applied to a data (MongoDB 2.2 or higher) (default: null).

    name

    Override the auto-generated index name (useful if the resulting name is larger than 128 bytes) (default: null)

    partialFilterExpression

    Creates a partial index based on the given filter object (MongoDB 3.2 or higher)

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. val background: UndefOr[Boolean]

    Permalink

    Creates the index in the background, yielding whenever possible (default: false).

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. val dropDups: UndefOr[Boolean]

    Permalink

    A unique index cannot be created on a key that has pre-existing duplicate values.

    A unique index cannot be created on a key that has pre-existing duplicate values. If you would like to create the index anyway keeping the first document the database indexes and deleting all subsequent documents that have duplicate value (default: false).

  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  10. val expireAfterSeconds: UndefOr[Int]

    Permalink

    Allows you to expire data on indexes applied to a data (MongoDB 2.2 or higher) (default: null).

  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. def hasOwnProperty(v: String): Boolean

    Permalink
    Definition Classes
    Object
  14. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  16. def isPrototypeOf(v: Object): Boolean

    Permalink
    Definition Classes
    Object
  17. val j: UndefOr[Boolean]

    Permalink

    Specify a journal write concern (default: false).

  18. val max: UndefOr[Int]

    Permalink

    For geospatial indexes set the high bound for the co-ordinates (default: null).

  19. val min: UndefOr[Int]

    Permalink

    For geospatial indexes set the lower bound for the co-ordinates (default: null).

  20. val name: UndefOr[Int]

    Permalink

    Override the auto-generated index name (useful if the resulting name is larger than 128 bytes) (default: null)

  21. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  22. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  24. val partialFilterExpression: UndefOr[Any]

    Permalink

    Creates a partial index based on the given filter object (MongoDB 3.2 or higher)

  25. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object
  26. val sparse: UndefOr[Boolean]

    Permalink

    Creates a sparse index (default: false).

  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  28. def toLocaleString(): String

    Permalink
    Definition Classes
    Object
  29. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  30. val unique: UndefOr[Boolean]

    Permalink

    Creates an unique index (default: false).

  31. val v: UndefOr[Int]

    Permalink

    Specify the format version of the indexes (default: null).

  32. def valueOf(): Any

    Permalink
    Definition Classes
    Object
  33. val w: UndefOr[|[Int, String]]

    Permalink

    The write concern (number | string; default: null).

  34. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. val wtimeout: UndefOr[Int]

    Permalink

    The write concern timeout (default: null).

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped