类：Mongo::URI::OptionsMapper Private

继承：
对象
  • 对象
显示全部
包括：
Loggable
定义于：
lib/ Mongo/uri/options_mapper.rb

Overview

此类是私有 API 的一部分。 应尽可能避免使用此类，因为它将来可能会被删除或更改。

在 URI 选项和 Ruby 选项之间执行映射。

该类包含：

  • 定义如何将 URI 选项转换为 Ruby 选项的映射。
  • 从小写 URI 选项名称到规范大小写 URI 选项名称的映射。
  • 将 URI 选项值转换为 Ruby 选项值的方法（convert_* 方法）。 当给定的输入无效时，它们通常会发出警告并返回 nil。
  • 将 Ruby 选项值转换为标准化 MongoClient 选项的方法（revert_* 方法）。 这些假设输入有效，通常不执行验证。

URI 选项名称不区分大小写。 Ruby 选项被指定为符号（尽管在客户端选项中使用无关访问）。

由于：

  • 2.0.0

常量摘要折叠

URI_OPTION_MAP =

此常量是私有 API 的一部分。 应尽可能避免使用此常量，因为它将来可能会被删除或更改。

用于存储 URI 选项参数到转换策略的映射的哈希

由于：

  • 2.0.0

{}
URI_OPTION_CANONICAL_NAMES =

此常量是私有 API 的一部分。 应尽可能避免使用此常量，因为它将来可能会被删除或更改。

返回从小写到规范 URI 选项名称的 Map。

返回：

  • (Hash<String, String>) —

    从小写映射到规范 URI 选项名称。

由于：

  • 2.0.0

{}

Loggable中包含的常量

Loggable::PREFIX

实例属性摘要折叠

类方法摘要折叠

实例方法摘要折叠

Loggable中包含的方法

#log_debug 、 #log_error 、 #log_ Fatal 、 #log_info 、 #log_warn 、 #logger

构造函数详情

#initialize (**opts) ⇒ OptionsMapper

此方法是私有 API 的一部分。 您应尽可能避免使用此方法，因为它将来可能会被删除或更改。

实例化选项映射器。

参数：

  • opts (哈希) —

    一组可自定义的选项

选项哈希 ( **opts )：

  • :logger （记录器） —

    要使用的自定义记录器。

由于：

  • 2.0.0



43
44
45
 
# File 'lib/ Mongo/uri/options_mapper.rb', line 43

def 初始化(**opts)
  @options = opts
end

实例属性详细信息

# options ⇒哈希（只读）

此方法是私有 API 的一部分。 您应尽可能避免使用此方法，因为它将来可能会被删除或更改。

返回 选项。

返回：

  • (哈希) —

    选项。

由于：

  • 2.0.0



48
49
50
 
# File 'lib/ Mongo/uri/options_mapper.rb', line 48

def 选项
  @options
end

类方法详细信息

。uri_option(uri_key, name, ** 额外的) ⇒ 对象

此方法是私有 API 的一部分。 您应尽可能避免使用此方法，因为它将来可能会被删除或更改。

用于在 URI_OPTION_MAP 中注册 MongoDB URI 选项的简单内部 dsl。

参数：

  • uri_key ( string ) —

    要注册的MongoDB URI 选项。

  • 名称 (符号) —

    驱动程序中该选项的名称。

  • 额外的 (哈希) —

    额外的选项。

    • : 群组 [Symbol] 选项所在的嵌套哈希。
    • :type [ 符号 ] 要转换值的函数名称。

由于：

  • 2.0.0



205
206
207
208
 
# File 'lib/ Mongo/uri/options_mapper.rb', line 205

def self.uri_option(uri_key, 名称, **额外的)
  URI_OPTION_MAP[uri_key.Downcase] = { 名称： 名称 }.update(额外的)
  URI_OPTION_CANONICAL_NAMES[uri_key.Downcase] = uri_key
end

实例方法详细信息

# add_uri_option (key, value, uri_options) ⇒对象

此方法是私有 API 的一部分。 您应尽可能避免使用此方法，因为它将来可能会被删除或更改。

向 uri 选项哈希添加一个选项。

Acquires a target for the option based on group.
Transforms the value.
Merges the option into the target.

参数：

  • key ( string ) —

    URI 选项名称。

  • 值 ( string ) —

    选项的值。

  • uri_options (哈希) —

    基本选项目标。

由于：

  • 2.0.0



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/ Mongo/uri/options_mapper.rb', line 59

def add_uri_option(key, 值, uri_options)
  策略 = URI_OPTION_MAP[key.Downcase]
  if 策略.nil?
    log_warn(“ 在 URI ' #{ @string } ' 上 不支持 URI 选项 ' #{ key } } '。它将被忽略。 ")
    return
  end

  GROUP = 策略[:group]
  目标 = if GROUP
             uri_options[GROUP] || {}
           else
             uri_options
           end
  值 = apply_transform(key, 值, 策略[:type])
  # 有时，此处的值为零，例如，如果我们正在处理
  # 读取偏好标签或身份验证机制属性以及所有
  # 其中的数据无效。 忽略此类选项。
  merge_uri_option(目标, 值, 策略[:name]) 除非 值.nil?

  return 除非 GROUP && !目标.空？ && !uri_options.键？(GROUP)

  uri_options[GROUP] = 目标
end

# ruby_to_smc (opts) ⇒哈希

此方法是私有 API 的一部分。 您应尽可能避免使用此方法，因为它将来可能会被删除或更改。

将提供的Ruby选项转换为“标准化 MongoClient 选项”。

参数：

  • opts (哈希) —

    要转换的 Ruby 选项。

返回：

  • (哈希) —

    标准化 MongoClient 选项。

由于：

  • 2.0.0



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/ Mongo/uri/options_mapper.rb', line 117

def ruby_to_smc(opts)
  rv = {}
  URI_OPTION_MAP.每 do |uri_key, spec|
    if spec[:group]
      v = opts[spec[:group]]
      v &&= v[spec[:name]]
    else
      v = opts[spec[:name]]
    end
    来年 if v.nil?

    if 类型 = spec[:type]
      v = 发送(" revert_ #{ type } ", v)
    end
    canonical_key = URI_OPTION_CANONICAL_NAMES[uri_key]
    提高 ArgumentError, "选项#{ uri_key }未知" 除非 canonical_key

    rv[canonical_key] = v
  end
  # 对于默认为 true 的选项，如果为 true，请删除该值。
  %w[retryReads retryWrites].每 do |k|
    rv.删除(k) if rv[k]
  end
  # 当身份验证源为 $external 时，删除默认为
  #（或要求）该身份验证源。
  rv.删除(' authSource ') if %w[MONGODB-AWS].包括？(rv[' authMechanism ']) && rv[' authSource '] == ' $external '
  # ssl 和 tls 是别名，删除 ssl 别名
  rv.删除(' ssl ')
  # TODO: 如果 authSource 与数据库相同，删除，
  # 要求此方法知道客户端中指定的数据库。
  rv
end

# ruby_to_string (opts) ⇒哈希

此方法是私有 API 的一部分。 您应尽可能避免使用此方法，因为它将来可能会被删除或更改。

将提供的Ruby选项转换为其在 URI string中的表示形式。

参数：

  • opts (哈希) —

    要转换的 Ruby 选项。

返回：

  • (哈希) —

    URI string哈希。

由于：

  • 2.0.0



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/ Mongo/uri/options_mapper.rb', line 155

def ruby_to_string(opts)
  rv = {}
  URI_OPTION_MAP.每 do |uri_key, spec|
    if spec[:group]
      v = opts[spec[:group]]
      v &&= v[spec[:name]]
    else
      v = opts[spec[:name]]
    end
    来年 if v.nil?

    if 类型 = spec[:type]
      v = 发送(" stringify_ #{ type } ", v)
    end
    canonical_key = URI_OPTION_CANONICAL_NAMES[uri_key]
    提高 ArgumentError, "选项#{ uri_key }未知" 除非 canonical_key

    rv[canonical_key] = v
  end
  # 对于默认为 true 的选项，如果为 true，请删除该值。
  %w[retryReads retryWrites].每 do |k|
    rv.删除(k) if rv[k]
  end
  # 当身份验证源为 $external 时，删除默认为
  #（或要求）该身份验证源。
  rv.删除(' authSource ') if %w[MONGODB-AWS].包括？(rv[' authMechanism ']) && rv[' authSource '] == ' $external '
  # ssl 和 tls 是别名，删除 ssl 别名
  rv.删除(' ssl ')
  # TODO: 如果 authSource 与数据库相同，删除，
  # 要求此方法知道客户端中指定的数据库。
  rv
end

# smc_to_Ruby (opts) ⇒对象

此方法是私有 API 的一部分。 您应尽可能避免使用此方法，因为它将来可能会被删除或更改。

由于：

  • 2.0.0



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/ Mongo/uri/options_mapper.rb', line 83

def smc_to_Ruby(opts)
  uri_options = {}

  opts.每 do |key, 值|
    策略 = URI_OPTION_MAP[key.Downcase]
    if 策略.nil?
      log_warn(“ 在 URI ' #{ @string } ' 上 不支持 URI 选项 ' #{ key } } '。它将被忽略。 ")
      return
    end

    GROUP = 策略[:group]
    目标 = if GROUP
               uri_options[GROUP] || {}
             else
               uri_options
             end

    值 = apply_transform(key, 值, 策略[:type])
    # 有时，此处的值为零，例如，如果我们正在处理
    # 读取偏好标签或身份验证机制属性以及所有
    # 其中的数据无效。 忽略此类选项。
    merge_uri_option(目标, 值, 策略[:name]) 除非 值.nil?

    uri_options[GROUP] = 目标 if GROUP && !目标.空？ && !uri_options.键？(GROUP)
  end

  uri_options
end