模块:Mongo::Operation::Specific Private
- 包含在:
- Aggregate 、 CollectionsInfo 、 Command 、 Count 、 Create 、 CreateIndex 、 CreateUser 、 Delete 、 Distinct 、 Drop 、 DropDatabase 、 DropIndex 、 Explain 、 Find 、 GetMore 、 Indexes 、 Insert 、 KillCursors 、 ListCollections 、 MapReduce 、 OpMsgBase 、 ParallelScan 、 RemoveUser 、 Update 、 UpdateUser 、 UsersInfo , WriteCommand
- 定义于:
- 构建/ruby-driver-v2.19/lib/ mongo /operation/shared/specified.rb
Overview
该模块是私有 API 的一部分。 您应尽可能避免使用此模块,因为它将来可能会被删除或更改。
此模块包含便捷方法从规范中获取各种值的常用功能。
常量摘要折叠
- DB_NAME =
此常量是私有 API 的一部分。 应尽可能避免使用此常量,因为它将来可能会被删除或更改。
数据库名称字段。
:db_name.冻结
- DELETES =
此常量是私有 API 的一部分。 应尽可能避免使用此常量,因为它将来可能会被删除或更改。
用于删除的字段。
:deletes.冻结
- DELETE =
此常量是私有 API 的一部分。 应尽可能避免使用此常量,因为它将来可能会被删除或更改。
用于删除的字段。
:删除.冻结
- 文档 =
此常量是私有 API 的一部分。 应尽可能避免使用此常量,因为它将来可能会被删除或更改。
文档字段。
:documents.冻结
- COLL_NAME =
此常量是私有 API 的一部分。 应尽可能避免使用此常量,因为它将来可能会被删除或更改。
集合名称字段。
:coll_name.冻结
- CURSOR_COUNT =
此常量是私有 API 的一部分。 应尽可能避免使用此常量,因为它将来可能会被删除或更改。
游标计数字段。
:cursor_count.冻结
- CURSOR_ID =
此常量是私有 API 的一部分。 应尽可能避免使用此常量,因为它将来可能会被删除或更改。
游标 ID 字段。
:cursor_id.冻结
- INDEX =
此常量是私有 API 的一部分。 应尽可能避免使用此常量,因为它将来可能会被删除或更改。
索引的字段。
:index.冻结
- INDEXES =
此常量是私有 API 的一部分。 应尽可能避免使用此常量,因为它将来可能会被删除或更改。
多个索引的字段。
:indexes.冻结
- INDEX_NAME =
此常量是私有 API 的一部分。 应尽可能避免使用此常量,因为它将来可能会被删除或更改。
索引名称字段。
:index_name.冻结
- OPERATION_ID =
此常量是私有 API 的一部分。 应尽可能避免使用此常量,因为它将来可能会被删除或更改。
操作 ID 常量。
:operation_id.冻结
- OPTIONS =
此常量是私有 API 的一部分。 应尽可能避免使用此常量,因为它将来可能会被删除或更改。
选项字段。
:options.冻结
- READ_CONCERN =
此常量是私有 API 的一部分。 应尽可能避免使用此常量,因为它将来可能会被删除或更改。
读关注选项。
:read_concern.冻结
- MAX_TIME_MS =
此常量是私有 API 的一部分。 应尽可能避免使用此常量,因为它将来可能会被删除或更改。
最长时间(毫秒)选项。
:max_time_ms.冻结
- SELECTOR =
此常量是私有 API 的一部分。 应尽可能避免使用此常量,因为它将来可能会被删除或更改。
选择器的字段。
:selector.冻结
- TO_RETURN =
此常量是私有 API 的一部分。 应尽可能避免使用此常量,因为它将来可能会被删除或更改。
要返回的数字字段。
:to_return.冻结
- UPDATES =
此常量是私有 API 的一部分。 应尽可能避免使用此常量,因为它将来可能会被删除或更改。
用于更新的字段。
:updates.冻结
- UPDATE =
此常量是私有 API 的一部分。 应尽可能避免使用此常量,因为它将来可能会被删除或更改。
用于更新的字段。
:update.冻结
- USER =
此常量是私有 API 的一部分。 应尽可能避免使用此常量,因为它将来可能会被删除或更改。
用户的字段名称。
: user.冻结
- USER_NAME =
此常量是私有 API 的一部分。 应尽可能避免使用此常量,因为它将来可能会被删除或更改。
用户名的字段名称。
:user_name.冻结
- WRITE_CONCERN =
此常量是私有 API 的一部分。 应尽可能避免使用此常量,因为它将来可能会被删除或更改。
写关注(write concern)的字段名称。
:write_concern.冻结
- READ =
此常量是私有 API 的一部分。 应尽可能避免使用此常量,因为它将来可能会被删除或更改。
读取偏好(read preference)的字段名称。
:read.冻结
- BYPASS_DOC_VALIDATION =
此常量是私有 API 的一部分。 应尽可能避免使用此常量,因为它将来可能会被删除或更改。
是否绕过文档级验证。
:bypass_document_validation.冻结
- COLLATION =
此常量是私有 API 的一部分。 应尽可能避免使用此常量,因为它将来可能会被删除或更改。
应用操作的排序规则。
:collation.冻结
实例属性摘要折叠
-
# spec ⇒ 哈希
只读
private
Spec 操作的规范。
实例方法摘要折叠
-
# == (other) ⇒ true, false (又名:#eql?)
private
检查两个可指定操作的相等性。
-
#已确认写入? ⇒ 布尔
private
该操作是否有已确认的写关注。
- # apply_collation (selector, connection, collation) ⇒ 对象 private
-
# array_filters (connection) ⇒ 哈希 | nil
private
数组筛选器。
-
#bypass_document_validation ⇒ true, false
private
是否绕过文档级验证。
-
# coll_name ⇒ string
private
操作应发送到的集合的名称。
-
#排序规则 ⇒ 哈希
private
要应用操作的排序规则。
-
# command (connection) ⇒ Hash
private
命令。
-
#cursor_count ⇒ Integer
private
从规范中获取游标计数。
-
# cursor_id = "Integer"
private
在服务器上创建的游标的 ID。
-
# db_name ⇒ string
private
操作应发送到的数据库的名称。
-
# delete ⇒ 哈希
private
从规范中获取删除文档。
-
# deletes ⇒ Array<BSON::Document>
private
从规范中获取删除内容。
-
# 个documents ⇒ Array<BSON::Document>
private
规范中的文档。
-
#索引⇒ 哈希
private
从规范中获取索引。
-
# index_name ⇒ string
private
从规范中获取索引名称。
-
#indexes ⇒ Hash
private
从规范中获取索引。
-
#初始化(spec) ⇒ 对象
private
创建新的可指定操作。
-
# max_time_ms ⇒ 哈希
private
从规范中获取最长时间(毫秒)值。
-
#命名空间⇒ string
private
命名空间,由数据库名称和集合名称组成。
-
#operation_id ⇒ Integer
private
获取操作的操作 ID。
-
# options (connection) ⇒ Hash
private
获取在特定连接上执行操作的选项。
-
#已订购? ⇒ true, false
private
操作是否有序。
-
# read ⇒ Mongo::ServerSelector
private
此操作的读取偏好。
-
# read_concern ⇒ 哈希
private
从规范中获取读关注文档。
-
#选择器(连接)⇒ 哈希
private
在特定连接上执行的规范中的选择器。
-
#session ⇒ Session
private
用于操作的会话。
-
# to_return ⇒ 整数
private
从服务器请求的文档数量。
-
# txn_num ⇒ 整数
private
该操作的事务编号。
-
# update ⇒ 哈希
private
规范中的更新文档。
-
#updates ⇒ Array<BSON::Document>
private
更新规范中的文档。
-
# user ⇒ Auth::User
private
用于用户相关操作的用户。
-
# user_name ⇒ string
private
规范中的用户名。
-
# write_concern ⇒ Mongo::WriteConcern
private
用于此操作的写关注。
实例属性详细信息
# spec ⇒哈希(只读)
此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。
返回 spec 操作的规范。
149 150 151 |
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第149行 def spec @spec end |
实例方法详细信息
# == (other) ⇒ true , false也称为: eql?
此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。
检查两个可指定操作的相等性。
161 162 163 164 |
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第161行 def ==(其他) return false 除非 其他.is_a?(可指定) spec == 其他.spec end |
#已确认写入? ⇒布尔
此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。
该操作是否有已确认的写关注。
552 553 554 |
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第552行 def 已确认_写入? write_concern.nil? || write_concern.已确认? end |
# apply_collation (selector, connection, collation) ⇒对象
此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。
556 557 558 559 560 561 562 563 564 |
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第556行 def apply_collation(选择器, 连接, 排序规则) if 排序规则 除非 连接.功能.collation_enabled? 提高 错误::UnsupportedCollation end 选择器 = 选择器.合并(merge)(排序规则: 排序规则) end 选择器 end |
# array_filters (connection) ⇒哈希 | nil
此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。
数组筛选器。
539 540 541 542 |
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第539行 def array_filters(连接) sel = 选择器(连接) sel[操作::ARRAY_FILTERS] if sel end |
#bypass_document_validation ⇒ true , false
此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。
是否绕过文档级验证。
361 362 363 |
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第361行 def bypass_document_validation spec[BYPASS_DOC_VALIDATION] end |
# coll_name ⇒ string
此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。
操作应发送到的集合的名称。
235 236 237 |
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第235行 def coll_name spec.获取(COLL_NAME) end |
#排序规则 ⇒哈希
此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。
要应用操作的排序规则。
373 374 375 |
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第373行 def 排序规则 发送(self.class::IDENTIFIER).first[排序规则] end |
# command (connection) ⇒ Hash
此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。
命令。
527 528 529 |
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第527行 def 命令(连接) 选择器(连接) end |
# cursor_count ⇒整数
此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。
从规范中获取游标计数。
175 176 177 |
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第175行 def cursor_count spec[CURSOR_COUNT] end |
# cursor_id = " Integer "
此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。
在服务器上创建的游标的 ID。
247 248 249 |
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第247行 def cursor_id spec[CURSOR_ID] end |
# db_name ⇒ string
此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。
操作应发送到的数据库的名称。
187 188 189 |
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第187行 def db_name spec[DB_NAME] end |
# 删除 ⇒哈希
此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。
从规范中获取删除文档。
211 212 213 |
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第211行 def 删除 spec[删除] end |
# deletes ⇒ Array<BSON::Document>
此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。
从规范中获取删除内容。
199 200 201 |
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第199行 def 删除 spec[删除] end |
# 个documents ⇒ Array<BSON::Document>
此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。
规范中的文档。
223 224 225 |
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第223行 def 文档 spec[文档 (Document)] end |
#索引⇒哈希
此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。
从规范中获取索引。
259 260 261 |
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第259行 def 索引(index) spec[索引] end |
# index_name ⇒ string
此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。
从规范中获取索引名称。
271 272 273 |
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第271行 def index_name spec[INDEX_NAME] end |
#个索引⇒哈希
此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。
从规范中获取索引。
283 284 285 |
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第283行 def 索引 spec[索引] end |
#初始化(spec) ⇒对象
此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。
创建新的可指定操作。
298 299 300 |
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第298行 def 初始化(spec) @spec = spec end |
# max_time_ms ⇒哈希
此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。
从规范中获取最长时间(毫秒)值。
349 350 351 |
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第349行 def max_time_ms spec[MAX_TIME_MS] end |
#命名空间⇒ string
此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。
命名空间,由数据库名称和集合名称组成。
494 495 496 |
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第494行 def namespace " #{ db_name } . #{ coll_name } " end |
# operation_id =" Integer "
此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。
获取操作的操作 ID。 用于监控中的链接操作。
311 312 313 |
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第311行 def operation_id spec[OPERATION_ID] end |
# options (connection) ⇒ Hash
此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。
获取在特定连接上执行操作的选项。
323 324 325 |
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第323行 def (连接) spec[选项] || {} end |
#已订购? ⇒ true , false
此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。
操作是否有序。
482 483 484 |
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第482行 def 已订购? !!(@spec.获取(:ordered, true)) end |
# read ⇒ Mongo::ServerSelector
此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。
此操作的读取偏好。
468 469 470 471 472 |
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第468行 def 读 @read ||= 开始 ServerSelector.获取(spec[读取]) if spec[读取] end end |
# read_concern ⇒哈希
此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。
该文档可能包括 afterClusterTime。
从规范中获取读关注文档。
337 338 339 |
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第337行 def read_concern spec[READ_CONCERN] end |
#选择器(连接)⇒哈希
此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。
在特定连接上执行的规范中的选择器。
386 387 388 |
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第386行 def 选择器(连接) spec[选择器] end |
# session ⇒会话
此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。
用于操作的会话。
506 507 508 |
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第506行 def 会话 @spec[:session] end |
#to_return ⇒ Integer
此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。
从服务器请求的文档数量。
398 399 400 |
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第398行 def to_return spec[TO_RETURN] end |
# txn_num ⇒整数
此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。
该操作的事务编号。
518 519 520 |
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第518行 def txn_num @spec[:txn_num] end |
# update ⇒哈希
此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。
规范中的更新文档。
420 421 422 |
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第420行 def update spec[更新(UPDATE)] end |
#updates ⇒ Array<BSON::Document>
此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。
更新规范中的文档。
409 410 411 |
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第409行 def 更新 spec[更新(UPDATES)] end |
# user ⇒ Auth::User
此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。
用于用户相关操作的用户。
432 433 434 |
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第432行 def user spec[用户] end |
# user_name ⇒ string
此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。
规范中的用户名。
444 445 446 |
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第444行 def user_name spec[USER_NAME] end |
# write_concern ⇒ Mongo::WriteConcern
此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。
用于此操作的写关注。
456 457 458 |
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第456行 def write_concern @spec[WRITE_CONCERN] end |