模块:Mongo::Operation::Specific Private

包含在:
AggregateCollectionsInfoCommandCountCreateCreateIndexCreateUserDeleteDistinctDropDropDatabaseDropIndexExplainFindGetMoreIndexesInsertKillCursorsListCollectionsMapReduceOpMsgBaseParallelScanRemoveUserUpdateUpdateUserUsersInfo , WriteCommand
定义于:
构建/ruby-driver-v2.19/lib/ mongo /operation/shared/specified.rb

Overview

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

此模块包含便捷方法从规范中获取各种值的常用功能。

由于:

  • 2.0.0

常量摘要折叠

DB_NAME =

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

数据库名称字段。

由于:

  • 2.0.0

:db_name.冻结
DELETES =

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

用于删除的字段。

由于:

  • 2.0.0

:deletes.冻结
DELETE =

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

用于删除的字段。

由于:

  • 2.0.0

:删除.冻结
文档 =

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

文档字段。

由于:

  • 2.0.0

:documents.冻结
COLL_NAME =

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

集合名称字段。

由于:

  • 2.0.0

:coll_name.冻结
CURSOR_COUNT =

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

游标计数字段。

由于:

  • 2.0.0

:cursor_count.冻结
CURSOR_ID =

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

游标 ID 字段。

由于:

  • 2.0.0

:cursor_id.冻结
INDEX =

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

索引的字段。

由于:

  • 2.0.0

:index.冻结
INDEXES =

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

多个索引的字段。

由于:

  • 2.0.0

:indexes.冻结
INDEX_NAME =

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

索引名称字段。

由于:

  • 2.0.0

:index_name.冻结
OPERATION_ID =

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

操作 ID 常量。

由于:

  • 2.1.0

:operation_id.冻结
OPTIONS =

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

选项字段。

由于:

  • 2.0.0

:options.冻结
READ_CONCERN =

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

读关注选项。

由于:

  • 2.2.0

:read_concern.冻结
MAX_TIME_MS =

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

最长时间(毫秒)选项。

由于:

  • 2.2.5

:max_time_ms.冻结
SELECTOR =

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

选择器的字段。

由于:

  • 2.0.0

:selector.冻结
TO_RETURN =

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

要返回的数字字段。

由于:

  • 2.0.0

:to_return.冻结
UPDATES =

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

用于更新的字段。

由于:

  • 2.0.0

:updates.冻结
UPDATE =

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

用于更新的字段。

由于:

  • 2.0.0

:update.冻结
USER =

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

用户的字段名称。

由于:

  • 2.0.0

: user.冻结
USER_NAME =

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

用户名的字段名称。

由于:

  • 2.0.0

:user_name.冻结
WRITE_CONCERN =

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

写关注(write concern)的字段名称。

由于:

  • 2.0.0

:write_concern.冻结
READ =

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

读取偏好(read preference)的字段名称。

由于:

  • 2.0.0

:read.冻结
BYPASS_DOC_VALIDATION =

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

是否绕过文档级验证。

由于:

  • 2.2.0

:bypass_document_validation.冻结
COLLATION =

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

应用操作的排序规则。

由于:

  • 2.4.0

:collation.冻结

实例属性摘要折叠

实例方法摘要折叠

实例属性详细信息

# spec哈希(只读)

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

返回 spec 操作的规范。

返回:

  • (哈希)

    spec 操作的规范。

由于:

  • 2.0.0



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 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。

检查两个可指定操作的相等性。

例子:

操作是否相等?

operation == other

参数:

  • 其他 ( Object )

    其他操作。

返回:

  • ( true , false )

    对象是否相等。

由于:

  • 2.0.0



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 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。

该操作是否有已确认的写关注。

例子:

确定操作是否具有已确认的写入。

specifiable.array_filters

返回:

  • ( Boolean )

    该操作是否具有已确认的写关注。

由于:

  • 2.5.2



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 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。

由于:

  • 2.0.0



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 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。

数组筛选器。

参数:

返回:

  • ( Hash | nil )

    数组筛选器。

由于:

  • 2.5.2



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_validationtrue , false

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

是否绕过文档级验证。

例子:

获取bypass_document_validation 选项。

specifiable.bypass_documentation_validation.

返回:

  • ( true , false )

    是否绕过文档级验证。

由于:

  • 2.2.0



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_namestring

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

操作应发送到的集合的名称。

例子:

获取集合名称。

specifiable.coll_name

返回:

  • ( string )

    集合名称。

由于:

  • 2.0.0



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 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。

要应用操作的排序规则。

例子:

获取排序规则选项。

specifiable.collation.

返回:

  • (哈希)

    排序规则文档。

由于:

  • 2.4.0



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 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。

命令。

返回:

  • (哈希)

    命令。

由于:

  • 2.5.2



527
528
529
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第527行

def 命令(连接)
  选择器(连接)
end

# cursor_count整数

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

从规范中获取游标计数。

例子:

获取游标计数。

specifiable.cursor_count

返回:

  • ( Integer )

    游标计数。

由于:

  • 2.0.0



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。

例子:

获取游标 ID。

specifiable.cursor_id

返回:

  • ( Integer )

    游标 ID。

由于:

  • 2.0.0



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_namestring

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

操作应发送到的数据库的名称。

例子:

获取数据库名称。

specifiable.db_name

返回:

  • ( string )

    数据库名称。

由于:

  • 2.0.0



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 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。

从规范中获取删除文档。

例子:

获取删除文档。

specifiable.delete

返回:

  • (哈希)

    删除文档。

由于:

  • 2.0.0



211
212
213
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第211行

def 删除
  spec[删除]
end

# deletesArray<BSON::Document>

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

从规范中获取删除内容。

例子:

获取删除。

specifiable.deletes

返回:

  • ( Array<BSON::Document> )

    删除。

由于:

  • 2.0.0



199
200
201
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第199行

def 删除
  spec[删除]
end

# 个documentsArray<BSON::Document>

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

规范中的文档。

例子:

获取文档。

specifiable.documents

返回:

  • ( Array<BSON::Document> )

    文档。

由于:

  • 2.0.0



223
224
225
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第223行

def 文档
  spec[文档 (Document)]
end

#索引哈希

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

从规范中获取索引。

例子:

获取索引规范。

specifiable.index

返回:

  • (哈希)

    索引规范。

由于:

  • 2.0.0



259
260
261
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第259行

def 索引(index)
  spec[索引]
end

# index_namestring

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

从规范中获取索引名称。

例子:

获取索引名称。

specifiable.index_name

返回:

  • ( string )

    索引名称。

由于:

  • 2.0.0



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 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。

从规范中获取索引。

例子:

获取索引规范。

specifiable.indexes

返回:

  • (哈希)

    索引规范。

由于:

  • 2.0.0



283
284
285
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第283行

def 索引
  spec[索引]
end

#初始化(spec) ⇒对象

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

创建新的可指定操作。

例子:

创建新的可指定操作。

Specifiable.new(spec)

参数:

  • spec (哈希)

    操作规范。

另请参阅:

  • 各个操作的规范中所需的值。

由于:

  • 2.0.0



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 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。

从规范中获取最长时间(毫秒)值。

例子:

获取最长时间(以毫秒为单位)。

specifiable.max_time_ms

返回:

  • (哈希)

    最长时间(毫秒)值。

由于:

  • 2.2.5



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 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。

命名空间,由数据库名称和集合名称组成。

例子:

获取命名空间。

specifiable.namespace

返回:

  • ( string )

    命名空间。

由于:

  • 2.1.0



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。 用于监控中的链接操作。

例子:

获取操作 ID。

specifiable.operation_id

返回:

  • ( Integer )

    操作 ID。

由于:

  • 2.1.0



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 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。

获取在特定连接上执行操作的选项。

参数:

返回:

  • (哈希)

    选项。

由于:

  • 2.0.0



323
324
325
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第323行

def 选项(连接)
  spec[选项] || {}
end

#已订购?true , false

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

操作是否有序。

例子:

获取有序值,默认为 true。

specifiable.ordered?

返回:

  • ( true , false )

    操作是否有序。

由于:

  • 2.1.0



482
483
484
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第482行

def 已订购?
  !!(@spec.获取(:ordered, true))
end

# readMongo::ServerSelector

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

此操作的读取偏好。

例子:

获取读取偏好。

specifiable.read

返回:

由于:

  • 2.0.0



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。

从规范中获取读关注文档。

例子:

获取读关注。

specifiable.read_concern

返回:

  • (哈希)

    读关注文档。

由于:

  • 2.2.0



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 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。

在特定连接上执行的规范中的选择器。

参数:

返回:

  • (哈希)

    选择器规范

由于:

  • 2.0.0



386
387
388
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第386行

def 选择器(连接)
  spec[选择器]
end

# session会话

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

用于操作的会话。

例子:

获取会话。

specifiable.session

返回:

由于:

  • 2.5.0



506
507
508
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第506行

def 会话
  @spec[:session]
end

#to_returnInteger

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

从服务器请求的文档数量。

例子:

从规范中获取返回值。

specifiable.to_return

返回:

  • ( Integer )

    要返回的文档数量。

由于:

  • 2.0.0



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 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。

该操作的事务编号。

例子:

获取ACID 事务编号。

specifiable.txn_num

返回:

  • ( Integer )

    事务编号。

由于:

  • 2.5.0



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 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。

规范中的更新文档。

例子:

获取更新文档。

返回:

  • (哈希)

    更新文档。

由于:

  • 2.0.0



420
421
422
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第420行

def update
  spec[更新(UPDATE)]
end

#updatesArray<BSON::Document>

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

更新规范中的文档。

例子:

获取更新文档。

返回:

  • ( Array<BSON::Document> )

    更新文档。

由于:

  • 2.0.0



409
410
411
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第409行

def 更新
  spec[更新(UPDATES)]
end

# userAuth::User

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

用于用户相关操作的用户。

例子:

获取用户。

specifiable.user

返回:

由于:

  • 2.0.0



432
433
434
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第432行

def user
  spec[用户]
end

# user_namestring

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

规范中的用户名。

例子:

获取用户名。

specifiable.user_name

返回:

  • ( string )

    用户名。

由于:

  • 2.0 .



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_concernMongo::WriteConcern

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

用于此操作的写关注。

例子:

获取写关注(write concern)。

specifiable.write_concern

返回:

由于:

  • 2.0.0



456
457
458
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/shared/specified.rb', 第456行

def write_concern
  @spec[WRITE_CONCERN]
end