Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ReadPreference

The ReadPreference class is a class that represents a MongoDB ReadPreference and is used to construct connections.ReadPreference类是表示MongoDB ReadPreferent的类,用于构造连接。

see

https://docs.mongodb.com/manual/core/read-preference/

Hierarchy继承层级

  • ReadPreference

Index索引

Constructors构造函数

  • Parameters参数

    • mode: ReadPreferenceMode

      A string describing the read preference mode (primary|primaryPreferred|secondary|secondaryPreferred|nearest)描述读取首选项模式的字符串(primary|primaryPreferred|secondary|secondryPreferred|nearest

    • Optional tags: TagSet[]

      A tag set used to target reads to members with the specified tag(s). 一个标记集,用于将读取目标指向具有指定标记的成员。tagSet is not available if using read preference mode primary.如果使用读取首选项模式,则tagSet不可用。

    • Optional options: ReadPreferenceOptions

      Additional read preference options其他读取首选项

    Returns 返回 ReadPreference

Properties属性

hedge?: HedgeOptions
maxStalenessSeconds?: number
minWireVersion?: number
tags?: TagSet[]
NEAREST: "nearest" = ReadPreferenceMode.nearest
PRIMARY: "primary" = ReadPreferenceMode.primary
PRIMARY_PREFERRED: "primaryPreferred" = ReadPreferenceMode.primaryPreferred
SECONDARY: "secondary" = ReadPreferenceMode.secondary
SECONDARY_PREFERRED: "secondaryPreferred" = ReadPreferenceMode.secondaryPreferred
nearest: ReadPreference = ...
primary: ReadPreference = ...
primaryPreferred: ReadPreference = ...
secondary: ReadPreference = ...
secondaryPreferred: ReadPreference = ...

Accessors访问器

Methods方法

  • Check if the two ReadPreferences are equivalent检查两个ReadPreferences是否等效

    Parameters参数

    • readPreference: ReadPreference

      The read preference with which to check equality用于检查相等性的读取首选项

    Returns 返回 boolean

  • isValid(mode?: string): boolean
  • Validate if a mode is legal验证模式是否合法

    Parameters参数

    • Optional mode: string

      The string representing the read preference mode.表示读取首选项模式的字符串。

    Returns 返回 boolean

  • secondaryOk(): boolean
  • slaveOk(): boolean
  • Construct a ReadPreference given an options object.构造给定选项对象的ReadPreference。

    Parameters参数

    • Optional options: ReadPreferenceFromOptions

      The options object from which to extract the read preference.从中提取读取首选项的选项对象。

    Returns 返回 undefined | ReadPreference

  • isValid(mode: string): boolean
  • Validate if a mode is legal验证模式是否合法

    Parameters参数

    • mode: string

      The string representing the read preference mode.表示读取首选项模式的字符串。

    Returns 返回 boolean

Generated using TypeDoc