Class

io.scalajs.npm.mongodb

CollectionOptions

Related Doc: package mongodb

Permalink

class CollectionOptions extends Object

Mongo Collection Retrieval Options

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

Instance Constructors

  1. new CollectionOptions(w: UndefOr[String] = js.undefined, wtimeout: UndefOr[Boolean] = js.undefined, j: UndefOr[Boolean] = js.undefined, raw: UndefOr[Boolean] = js.undefined, pkFactory: UndefOr[Boolean] = js.undefined, readPreference: UndefOr[Boolean] = js.undefined, serializeFunctions: UndefOr[Boolean] = js.undefined, strict: UndefOr[Boolean] = js.undefined, capped: UndefOr[Boolean] = js.undefined, autoIndexId: UndefOr[String] = js.undefined, size: UndefOr[Boolean] = js.undefined, max: UndefOr[Boolean] = js.undefined, flags: UndefOr[Boolean] = js.undefined, storageEngine: UndefOr[Boolean] = js.undefined, validator: UndefOr[Boolean] = js.undefined, validationLevel: UndefOr[Boolean] = js.undefined, validationAction: UndefOr[Boolean] = js.undefined, indexOptionDefaults: UndefOr[Boolean] = js.undefined, viewOn: UndefOr[Boolean] = js.undefined, pipeline: UndefOr[Boolean] = js.undefined, collation: UndefOr[Boolean] = js.undefined)

    Permalink

    w

    number | string null optional - The write concern.

    wtimeout

    number null optional - The write concern timeout.

    j

    boolean false optional - Specify a journal write concern.

    raw

    boolean false optional - Return document results as raw BSON buffers.

    pkFactory

    object null optional - A primary key factory object for generation of custom _id keys.

    readPreference

    ReadPreference | string null optional - The preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST).

    serializeFunctions

    boolean false optional - Serialize functions on any object.

    strict

    boolean false optional - Returns an error if the collection does not exist

    capped

    boolean false optional - Create a capped collection.

    autoIndexId

    boolean true optional - Create an index on the _id field of the document, True by default on MongoDB 2.2 or higher off for version < 2.2.

    size

    number null optional - The size of the capped collection in bytes.

    max

    number null optional - The maximum number of documents in the capped collection.

    flags

    number null optional - Optional. Available for the MMAPv1 storage engine only to set the usePowerOf2Sizes and the noPadding flag.

    storageEngine

    object null optional - Allows users to specify configuration to the storage engine on a per-collection basis when creating a collection on MongoDB 3.0 or higher.

    validator

    object null optional - Allows users to specify validation rules or expressions for the collection. For more information, see Document Validation on MongoDB 3.2 or higher.

    validationLevel

    string null optional - Determines how strictly MongoDB applies the validation rules to existing documents during an update on MongoDB 3.2 or higher.

    validationAction

    string null optional - Determines whether to error on invalid documents or just warn about the violations but allow invalid documents to be inserted on MongoDB 3.2 or higher.

    indexOptionDefaults

    object null optional - Allows users to specify a default configuration for indexes when creating a collection on MongoDB 3.2 or higher.

    viewOn

    string null optional - The name of the source collection or view from which to create the view. The name is not the full namespace of the collection or view; i.e. does not include the database name and implies the same database as the view to create on MongoDB 3.4 or higher.

    pipeline

    array null optional - An array that consists of the aggregation pipeline stage. create creates the view by applying the specified pipeline to the viewOn collection or view on MongoDB 3.4 or higher.

    collation

    object null optional - Specify collation (MongoDB 3.4 or higher) settings for update operation (see 3.4 documentation for available fields).

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 autoIndexId: UndefOr[String]

    Permalink

    boolean true optional - Create an index on the _id field of the document, True by default on MongoDB 2.2 or higher off for version < 2.2.

  6. val capped: UndefOr[Boolean]

    Permalink

    boolean false optional - Create a capped collection.

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. val collation: UndefOr[Boolean]

    Permalink

    object null optional - Specify collation (MongoDB 3.4 or higher) settings for update operation (see 3.4 documentation for available fields).

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

    Permalink
    Definition Classes
    AnyRef

  10. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  12. val flags: UndefOr[Boolean]

    Permalink

    number null optional - Optional.

    number null optional - Optional. Available for the MMAPv1 storage engine only to set the usePowerOf2Sizes and the noPadding flag.

  13. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  14. def hasOwnProperty(v: String): Boolean

    Permalink
    Definition Classes
    Object

  15. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  16. val indexOptionDefaults: UndefOr[Boolean]

    Permalink

    object null optional - Allows users to specify a default configuration for indexes when creating a collection on MongoDB 3.2 or higher.

  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  18. def isPrototypeOf(v: Object): Boolean

    Permalink
    Definition Classes
    Object

  19. val j: UndefOr[Boolean]

    Permalink

    boolean false optional - Specify a journal write concern.

  20. val max: UndefOr[Boolean]

    Permalink

    number null optional - The maximum number of documents in the capped collection.

  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 pipeline: UndefOr[Boolean]

    Permalink

    array null optional - An array that consists of the aggregation pipeline stage.

    array null optional - An array that consists of the aggregation pipeline stage. create creates the view by applying the specified pipeline to the viewOn collection or view on MongoDB 3.4 or higher.

  25. val pkFactory: UndefOr[Boolean]

    Permalink

    object null optional - A primary key factory object for generation of custom _id keys.

  26. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object

  27. val raw: UndefOr[Boolean]

    Permalink

    boolean false optional - Return document results as raw BSON buffers.

  28. val readPreference: UndefOr[Boolean]

    Permalink

    ReadPreference | string null optional - The preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST).

  29. val serializeFunctions: UndefOr[Boolean]

    Permalink

    boolean false optional - Serialize functions on any object.

  30. val size: UndefOr[Boolean]

    Permalink

    number null optional - The size of the capped collection in bytes.

  31. val storageEngine: UndefOr[Boolean]

    Permalink

    object null optional - Allows users to specify configuration to the storage engine on a per-collection basis when creating a collection on MongoDB 3.0 or higher.

  32. val strict: UndefOr[Boolean]

    Permalink

    boolean false optional - Returns an error if the collection does not exist

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

    Permalink
    Definition Classes
    AnyRef

  34. def toLocaleString(): String

    Permalink
    Definition Classes
    Object

  35. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  36. val validationAction: UndefOr[Boolean]

    Permalink

    string null optional - Determines whether to error on invalid documents or just warn about the violations but allow invalid documents to be inserted on MongoDB 3.2 or higher.

  37. val validationLevel: UndefOr[Boolean]

    Permalink

    string null optional - Determines how strictly MongoDB applies the validation rules to existing documents during an update on MongoDB 3.2 or higher.

  38. val validator: UndefOr[Boolean]

    Permalink

    object null optional - Allows users to specify validation rules or expressions for the collection.

    object null optional - Allows users to specify validation rules or expressions for the collection. For more information, see Document Validation on MongoDB 3.2 or higher.

  39. def valueOf(): Any

    Permalink
    Definition Classes
    Object

  40. val viewOn: UndefOr[Boolean]

    Permalink

    string null optional - The name of the source collection or view from which to create the view.

    string null optional - The name of the source collection or view from which to create the view. The name is not the full namespace of the collection or view; i.e. does not include the database name and implies the same database as the view to create on MongoDB 3.4 or higher.

  41. val w: UndefOr[String]

    Permalink

    number | string null optional - The write concern.

  42. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  43. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  44. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  45. val wtimeout: UndefOr[Boolean]

    Permalink

    number null optional - The write concern timeout.

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped