Class

io.scalajs.npm.mongodb

DbOptions

Related Doc: package mongodb

Permalink

class DbOptions extends Object

Database Options

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

Instance Constructors

  1. new DbOptions(authSource: UndefOr[String] = js.undefined, w: UndefOr[|[Int, String]] = js.undefined, wtimeout: UndefOr[Int] = js.undefined, j: UndefOr[Boolean] = js.undefined, forceServerObjectId: UndefOr[Boolean] = js.undefined, serializeFunctions: UndefOr[Boolean] = js.undefined, ignoreUndefined: UndefOr[Boolean] = js.undefined, raw: UndefOr[Boolean] = js.undefined, promoteLongs: UndefOr[Boolean] = js.undefined, promoteBuffers: UndefOr[Boolean] = js.undefined, promoteValues: UndefOr[Boolean] = js.undefined, bufferMaxEntries: UndefOr[Int] = js.undefined, readPreference: UndefOr[ReadPreference] = js.undefined, pkFactory: UndefOr[Any] = js.undefined, promiseLibrary: UndefOr[Any] = js.undefined, readConcern: UndefOr[Any] = js.undefined, level: UndefOr[Any] = js.undefined)

    Permalink

    authSource

    string null optional If the database authentication is dependent on another databaseName.

    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.

    forceServerObjectId

    boolean false optional Force server to assign _id values instead of driver.

    serializeFunctions

    boolean false optional Serialize functions on any object.

    ignoreUndefined

    Boolean false optional Specify if the BSON serializer should ignore undefined fields.

    raw

    boolean false optional Return document results as raw BSON buffers.

    promoteLongs

    boolean true optional Promotes Long values to number if they fit inside the 53 bits resolution.

    promoteBuffers

    boolean false optional Promotes Binary BSON values to native Node Buffers.

    promoteValues

    boolean true optional Promotes BSON values to native types where possible, set to false to only receive wrapper types.

    bufferMaxEntries

    number -1 optional Sets a cap on how many operations the driver will buffer up before giving up on getting a working connection, default is -1 which is unlimited.

    readPreference

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

    pkFactory

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

    promiseLibrary

    object null optional A Promise library class the application wishes to use such as Bluebird, must be ES6 compatible

    readConcern

    object null optional Specify a read concern for the collection. (only MongoDB 3.2 or higher supported) Name Type Default Description

    level

    object 'local' optional Specify a read concern level for the collection operations, one of [local|majority]. (only MongoDB 3.2 or higher supported)

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

    Permalink

    string null optional If the database authentication is dependent on another databaseName.

  6. val bufferMaxEntries: UndefOr[Int]

    Permalink

    number -1 optional Sets a cap on how many operations the driver will buffer up before giving up on getting a working connection, default is -1 which is unlimited.

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. val forceServerObjectId: UndefOr[Boolean]

    Permalink

    boolean false optional Force server to assign _id values instead of driver.

  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. val ignoreUndefined: UndefOr[Boolean]

    Permalink

    Boolean false optional Specify if the BSON serializer should ignore undefined fields.

  16. final def isInstanceOf[T0]: Boolean

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

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

    Permalink

    boolean false optional Specify a journal write concern.

  19. val level: UndefOr[Any]

    Permalink

    object 'local' optional Specify a read concern level for the collection operations, one of [local|majority].

    object 'local' optional Specify a read concern level for the collection operations, one of [local|majority]. (only MongoDB 3.2 or higher supported)

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

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

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

    Permalink
    Definition Classes
    AnyRef
  23. val pkFactory: UndefOr[Any]

    Permalink

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

  24. val promiseLibrary: UndefOr[Any]

    Permalink

    object null optional A Promise library class the application wishes to use such as Bluebird, must be ES6 compatible

  25. val promoteBuffers: UndefOr[Boolean]

    Permalink

    boolean false optional Promotes Binary BSON values to native Node Buffers.

  26. val promoteLongs: UndefOr[Boolean]

    Permalink

    boolean true optional Promotes Long values to number if they fit inside the 53 bits resolution.

  27. val promoteValues: UndefOr[Boolean]

    Permalink

    boolean true optional Promotes BSON values to native types where possible, set to false to only receive wrapper types.

  28. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object
  29. val raw: UndefOr[Boolean]

    Permalink

    boolean false optional Return document results as raw BSON buffers.

  30. val readConcern: UndefOr[Any]

    Permalink

    object null optional Specify a read concern for the collection.

    object null optional Specify a read concern for the collection. (only MongoDB 3.2 or higher supported) Name Type Default Description

  31. val readPreference: UndefOr[ReadPreference]

    Permalink

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

  32. val serializeFunctions: UndefOr[Boolean]

    Permalink

    boolean false optional Serialize functions on any object.

  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. def valueOf(): Any

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

    Permalink

    number | string null optional The write concern.

  38. final def wait(): Unit

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

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

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

    Permalink

    number null optional The write concern timeout.

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped