Module: Mongo::Operation::Specifiable Private

Do not use. This module is for internal use only.

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In: `Aggregate`, `Aggregate::OpMsg`, `CollectionsInfo`, `Command`, `Command::OpMsg`, `Count`, `Count::OpMsg`, `Create`, `Create::OpMsg`, `CreateIndex`, `CreateIndex::OpMsg`, `CreateSearchIndexes`, `CreateSearchIndexes::OpMsg`, `CreateUser`, `CreateUser::OpMsg`, `Delete`, `Delete::OpMsg`, `Distinct`, `Distinct::OpMsg`, `Drop`, `Drop::OpMsg`, `DropDatabase`, `DropDatabase::OpMsg`, `DropIndex`, `DropIndex::OpMsg`, `DropSearchIndex`, `DropSearchIndex::OpMsg`, `Explain`, `Explain::OpMsg`, `Find`, `Find::OpMsg`, `GetMore`, `GetMore::OpMsg`, `Indexes`, `Indexes::OpMsg`, `Insert`, `Insert::OpMsg`, `KillCursors`, `KillCursors::OpMsg`, `ListCollections`, `ListCollections::OpMsg`, `MapReduce`, `MapReduce::OpMsg`, `OpMsgBase`, `ParallelScan`, `ParallelScan::OpMsg`, `RemoveUser`, `RemoveUser::OpMsg`, `Update`, `Update::OpMsg`, `UpdateSearchIndex`, `UpdateSearchIndex::OpMsg`, `UpdateUser`, `UpdateUser::OpMsg`, `UsersInfo`, `UsersInfo::OpMsg`, `WriteCommand`, `WriteCommand::OpMsg`
Defined in:	lib/mongo/operation/shared/specifiable.rb

Overview

This module contains common functionality for convenience methods getting various values from the spec.

Since:

2.0.0

Constant Summary

BYPASS_DOC_VALIDATION =

Whether to bypass document level validation.
Since:
- 2.2.0
# File 'lib/mongo/operation/shared/specifiable.rb', line 141
```
:bypass_document_validation.freeze
```
COLLATION =

A collation to apply to the operation.
Since:
- 2.4.0
# File 'lib/mongo/operation/shared/specifiable.rb', line 146
```
:collation.freeze
```
COLL_NAME =

The field for collection name.
Since:
- 2.0.0
# File 'lib/mongo/operation/shared/specifiable.rb', line 51
```
:coll_name.freeze
```
CURSOR_COUNT =

The field for cursor count.
Since:
- 2.0.0
# File 'lib/mongo/operation/shared/specifiable.rb', line 56
```
:cursor_count.freeze
```
CURSOR_ID =

The field for cursor id.
Since:
- 2.0.0
# File 'lib/mongo/operation/shared/specifiable.rb', line 61
```
:cursor_id.freeze
```
DB_NAME =

The field for database name.
Since:
- 2.0.0
# File 'lib/mongo/operation/shared/specifiable.rb', line 31
```
:db_name.freeze
```
DELETE =

The field for delete.
Since:
- 2.0.0
# File 'lib/mongo/operation/shared/specifiable.rb', line 41
```
:delete.freeze
```
DELETES =

The field for deletes.
Since:
- 2.0.0
# File 'lib/mongo/operation/shared/specifiable.rb', line 36
```
:deletes.freeze
```
DOCUMENTS =

The field for documents.
Since:
- 2.0.0
# File 'lib/mongo/operation/shared/specifiable.rb', line 46
```
:documents.freeze
```
INDEX =

The field for an index.
Since:
- 2.0.0
# File 'lib/mongo/operation/shared/specifiable.rb', line 66
```
:index.freeze
```
INDEXES =

The field for multiple indexes.
Since:
- 2.0.0
# File 'lib/mongo/operation/shared/specifiable.rb', line 71
```
:indexes.freeze
```
INDEX_NAME =

The field for index names.
Since:
- 2.0.0
# File 'lib/mongo/operation/shared/specifiable.rb', line 76
```
:index_name.freeze
```
MAX_TIME_MS =

The max time ms option.
Since:
- 2.2.5
# File 'lib/mongo/operation/shared/specifiable.rb', line 96
```
:max_time_ms.freeze
```
OPERATION_ID =

The operation id constant.
Since:
- 2.1.0
# File 'lib/mongo/operation/shared/specifiable.rb', line 81
```
:operation_id.freeze
```
OPTIONS =

The field for options.
Since:
- 2.0.0
# File 'lib/mongo/operation/shared/specifiable.rb', line 86
```
:options.freeze
```
READ =

The field name for the read preference.
Since:
- 2.0.0
# File 'lib/mongo/operation/shared/specifiable.rb', line 136
```
:read.freeze
```
READ_CONCERN =

The read concern option.
Since:
- 2.2.0
# File 'lib/mongo/operation/shared/specifiable.rb', line 91
```
:read_concern.freeze
```
SELECTOR =

The field for a selector.
Since:
- 2.0.0
# File 'lib/mongo/operation/shared/specifiable.rb', line 101
```
:selector.freeze
```
TO_RETURN =

The field for number to return.
Since:
- 2.0.0
# File 'lib/mongo/operation/shared/specifiable.rb', line 106
```
:to_return.freeze
```
UPDATE =

The field for update.
Since:
- 2.0.0
# File 'lib/mongo/operation/shared/specifiable.rb', line 116
```
:update.freeze
```
UPDATES =

The field for updates.
Since:
- 2.0.0
# File 'lib/mongo/operation/shared/specifiable.rb', line 111
```
:updates.freeze
```
USER =

The field name for a user.
Since:
- 2.0.0
# File 'lib/mongo/operation/shared/specifiable.rb', line 121
```
:user.freeze
```
USER_NAME =

The field name for user name.
Since:
- 2.0.0
# File 'lib/mongo/operation/shared/specifiable.rb', line 126
```
:user_name.freeze
```
WRITE_CONCERN =

The field name for a write concern.
Since:
- 2.0.0
# File 'lib/mongo/operation/shared/specifiable.rb', line 131
```
:write_concern.freeze
```

Instance Attribute Summary

#acknowledged_write? ⇒ Boolean readonly Internal use only

Does the operation have an acknowledged write concern.
#ordered? ⇒ true, false readonly Internal use only

Whether the operation is ordered.
#spec ⇒ Hash readonly Internal use only

Instance Method Summary

#==(other) ⇒ true, false (also: #eql?) Internal use only

Check equality of two specifiable operations.
#apply_collation(selector, connection, collation) Internal use only
#array_filters(connection) ⇒ Hash | nil Internal use only

The array filters.
#bypass_document_validation ⇒ true, false Internal use only

Whether or not to bypass document level validation.
#coll_name ⇒ String Internal use only

The name of the collection to which the operation should be sent.
#collation ⇒ Hash Internal use only

The collation to apply to the operation.
#command(connection) ⇒ Hash Internal use only

The command.
#cursor_count ⇒ Integer Internal use only

Get the cursor count from the spec.
#cursor_id ⇒ Integer Internal use only

The id of the cursor created on the server.
#db_name ⇒ String Internal use only

The name of the database to which the operation should be sent.
#delete ⇒ Hash Internal use only

Get the delete document from the specification.
#deletes ⇒ Array<BSON::Document> Internal use only

Get the deletes from the specification.
#documents ⇒ Array<BSON::Document> Internal use only

The documents to in the specification.
#eql?(other)

Alias for #==.
#index ⇒ Hash Internal use only

Get the index from the specification.
#index_id ⇒ String Internal use only

Get the index id from the spec.
#index_name ⇒ String Internal use only

Get the index name from the spec.
#indexes ⇒ Hash Internal use only

Get the indexes from the specification.
#initialize(spec) Internal use only

Create the new specifiable operation.
#max_time_ms ⇒ Hash Internal use only

Get the max time ms value from the spec.
#namespace ⇒ String Internal use only

The namespace, consisting of the db name and collection name.
#operation_id ⇒ Integer Internal use only

Get the operation id for the operation.
#options(connection) ⇒ Hash Internal use only

Get the options for executing the operation on a particular connection.
#read ⇒ Mongo::ServerSelector Internal use only

The read preference for this operation.
#read_concern ⇒ Hash Internal use only

Get the read concern document from the spec.
#selector(connection) ⇒ Hash Internal use only

The selector from the specification for execution on a particular connection.
#session ⇒ Session Internal use only

The session to use for the operation.
#to_return ⇒ Integer Internal use only

The number of documents to request from the server.
#txn_num ⇒ Integer Internal use only

The transaction number for the operation.
#update ⇒ Hash Internal use only

The update document from the spec.
#updates ⇒ Array<BSON::Document> Internal use only

The update documents from the spec.
#user ⇒ Auth::User Internal use only

The user for user related operations.
#user_name ⇒ String Internal use only

The user name from the specification.
#write_concern ⇒ Mongo::WriteConcern Internal use only

The write concern to use for this operation.

Instance Attribute Details

#acknowledged_write? ⇒ `Boolean` (readonly)

Does the operation have an acknowledged write concern.

Examples:

Determine whether the operation has an acknowledged write.

specifiable.array_filters

Returns:

(Boolean) —

Whether or not the operation has an acknowledged write concern.

Since:

2.5.2

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 559


def acknowledged_write?
  write_concern.nil? || write_concern.acknowledged?
end

#ordered? ⇒ `true`, `false` (readonly)

Whether the operation is ordered.

Examples:

Get the ordered value, true is the default.

specifiable.ordered?

Returns:

(true, false) —

Whether the operation is ordered.

Since:

2.1.0

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 489


def ordered?
  !!(@spec.fetch(:ordered, true))
end

#spec ⇒ `Hash` (readonly)

Returns:

(Hash) —

spec The specification for the operation.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 149


attr_reader :spec

Instance Method Details

#==(other) ⇒ `true`, `false` Also known as: #eql?

Check equality of two specifiable operations.

Examples:

Are the operations equal?

operation == other

Parameters:

other (Object) —

The other operation.

Returns:

(true, false) —

Whether the objects are equal.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 161


def ==(other)
  return false unless other.is_a?(Specifiable)
  spec == other.spec
end

#apply_collation(selector, connection, collation)

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 563


def apply_collation(selector, connection, collation)
  if collation
    unless connection.features.collation_enabled?
      raise Error::UnsupportedCollation
    end
    selector = selector.merge(collation: collation)
  end
  selector
end

#array_filters(connection) ⇒ `Hash` | `nil`

The array filters.

Parameters:

connection (Server::Connection) —

The connection that the operation will be executed on.

Returns:

(Hash | nil) —

The array filters.

Since:

2.5.2

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 546


def array_filters(connection)
  sel = selector(connection)
  sel[Operation::ARRAY_FILTERS] if sel
end

#bypass_document_validation ⇒ `true`, `false`

Whether or not to bypass document level validation.

Examples:

Get the bypass_document_validation option.

specifiable.bypass_documentation_validation.

Returns:

(true, false) —

Whether to bypass document level validation.

Since:

2.2.0

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 368


def bypass_document_validation
  spec[BYPASS_DOC_VALIDATION]
end

#coll_name ⇒ `String`

The name of the collection to which the operation should be sent.

Examples:

Get the collection name.

specifiable.coll_name

Returns:

(String) —

::Mongo::Collection name.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 235


def coll_name
  spec.fetch(COLL_NAME)
end

#collation ⇒ `Hash`

The collation to apply to the operation.

Examples:

Get the collation option.

specifiable.collation.

Returns:

(Hash) —

The collation document.

Since:

2.4.0

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 380


def collation
  send(self.class::IDENTIFIER).first[COLLATION]
end

#command(connection) ⇒ `Hash`

The command.

Returns:

(Hash) —

The command.

Since:

2.5.2

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 534


def command(connection)
  selector(connection)
end

#cursor_count ⇒ `Integer`

Get the cursor count from the spec.

Examples:

Get the cursor count.

specifiable.cursor_count

Returns:

(Integer) —

The cursor count.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 175


def cursor_count
  spec[CURSOR_COUNT]
end

#cursor_id ⇒ `Integer`

The id of the cursor created on the server.

Examples:

Get the cursor id.

specifiable.cursor_id

Returns:

(Integer) —

The cursor id.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 247


def cursor_id
  spec[CURSOR_ID]
end

#db_name ⇒ `String`

The name of the database to which the operation should be sent.

Examples:

Get the database name.

specifiable.db_name

Returns:

(String) —

::Mongo::Database name.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 187


def db_name
  spec[DB_NAME]
end

#delete ⇒ `Hash`

Get the delete document from the specification.

Examples:

Get the delete document.

specifiable.delete

Returns:

(Hash) —

The delete document.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 211


def delete
  spec[DELETE]
end

#deletes ⇒ `Array`<`BSON::Document`>

Get the deletes from the specification.

Examples:

Get the deletes.

specifiable.deletes

Returns:

(Array<BSON::Document>) —

The deletes.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 199


def deletes
  spec[DELETES]
end

#documents ⇒ `Array`<`BSON::Document`>

The documents to in the specification.

Examples:

Get the documents.

specifiable.documents

Returns:

(Array<BSON::Document>) —

The documents.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 223


def documents
  spec[DOCUMENTS]
end

#eql?(other)

Alias for #==.

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 165


alias_method :eql?, :==

#index ⇒ `Hash`

Get the index from the specification.

Examples:

Get the index specification.

specifiable.index

Returns:

(Hash) —

The index specification.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 259


def index
  spec[INDEX]
end

#index_id ⇒ `String`

Get the index id from the spec.

Returns:

(String) —

The index id.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 266


def index_id
  spec[:index_id]
end

#index_name ⇒ `String`

Get the index name from the spec.

Examples:

Get the index name.

specifiable.index_name

Returns:

(String) —

The index name.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 278


def index_name
  spec[INDEX_NAME]
end

#indexes ⇒ `Hash`

Get the indexes from the specification.

Examples:

Get the index specifications.

specifiable.indexes

Returns:

(Hash) —

The index specifications.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 290


def indexes
  spec[INDEXES]
end

#initialize(spec)

Create the new specifiable operation.

Examples:

Create the new specifiable operation.

Specifiable.new(spec)

Parameters:

spec (Hash) —

The operation specification.

#max_time_ms ⇒ `Hash`

Get the max time ms value from the spec.

Examples:

Get the max time ms.

specifiable.max_time_ms

Returns:

(Hash) —

The max time ms value.

Since:

2.2.5

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 356


def max_time_ms
  spec[MAX_TIME_MS]
end

#namespace ⇒ `String`

The namespace, consisting of the db name and collection name.

Examples:

Get the namespace.

specifiable.namespace

Returns:

(String) —

The namespace.

Since:

2.1.0

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 501


def namespace
  "#{db_name}.#{coll_name}"
end

#operation_id ⇒ `Integer`

Get the operation id for the operation. Used for linking operations in monitoring.

Examples:

Get the operation id.

specifiable.operation_id

Returns:

(Integer) —

The operation id.

Since:

2.1.0

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 318


def operation_id
  spec[OPERATION_ID]
end

#options(connection) ⇒ `Hash`

Get the options for executing the operation on a particular connection.

Parameters:

connection (Server::Connection) —

The connection that the operation will be executed on.

Returns:

(Hash) —

The options.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 330


def options(connection)
  spec[OPTIONS] || {}
end

#read ⇒ Mongo::ServerSelector

The read preference for this operation.

Examples:

Get the read preference.

specifiable.read

Returns:

(Mongo::ServerSelector) —

The read preference.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 475


def read
  @read ||= begin
    ServerSelector.get(spec[READ]) if spec[READ]
  end
end

#read_concern ⇒ `Hash`

Note:

The document may include afterClusterTime.

Get the read concern document from the spec.

Examples:

Get the read concern.

specifiable.read_concern

Returns:

(Hash) —

The read concern document.

Since:

2.2.0

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 344


def read_concern
  spec[READ_CONCERN]
end

#selector(connection) ⇒ `Hash`

The selector from the specification for execution on a particular connection.

Parameters:

connection (Server::Connection) —

The connection that the operation will be executed on.

Returns:

(Hash) —

The selector spec.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 393


def selector(connection)
  spec[SELECTOR]
end

#session ⇒ Session

The session to use for the operation.

Examples:

Get the session.

specifiable.session

Returns:

(Session) —

The session.

Since:

2.5.0

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 513


def session
  @spec[:session]
end

#to_return ⇒ `Integer`

The number of documents to request from the server.

Examples:

Get the to return value from the spec.

specifiable.to_return

Returns:

(Integer) —

The number of documents to return.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 405


def to_return
  spec[TO_RETURN]
end

#txn_num ⇒ `Integer`

The transaction number for the operation.

Examples:

Get the transaction number.

specifiable.txn_num

Returns:

(Integer) —

The transaction number.

Since:

2.5.0

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 525


def txn_num
  @spec[:txn_num]
end

#update ⇒ `Hash`

The update document from the spec.

Examples:

Get the update document.

Returns:

(Hash) —

The update document.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 427


def update
  spec[UPDATE]
end

#updates ⇒ `Array`<`BSON::Document`>

The update documents from the spec.

Examples:

Get the update documents.

Returns:

(Array<BSON::Document>) —

The update documents.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 416


def updates
  spec[UPDATES]
end

#user ⇒ Auth::User

The user for user related operations.

Examples:

Get the user.

specifiable.user

Returns:

(Auth::User) —

The user.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 439


def user
  spec[USER]
end

#user_name ⇒ `String`

The user name from the specification.

Examples:

Get the user name.

specifiable.user_name

Returns:

(String) —

The user name.

Since:

2.0.

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 451


def user_name
  spec[USER_NAME]
end

#write_concern ⇒ Mongo::WriteConcern

The write concern to use for this operation.

Examples:

Get the write concern.

specifiable.write_concern

Returns:

(Mongo::WriteConcern) —

The write concern.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/operation/shared/specifiable.rb', line 463


def write_concern
  @spec[WRITE_CONCERN]
end

Module: Mongo::Operation::Specifiable Private

Overview

Constant Summary

Instance Attribute Summary

Instance Method Summary

Instance Attribute Details

#acknowledged_write? ⇒ Boolean (readonly)

#ordered? ⇒ true, false (readonly)

#spec ⇒ Hash (readonly)

Instance Method Details

#==(other) ⇒ true, false Also known as: #eql?

#apply_collation(selector, connection, collation)

#array_filters(connection) ⇒ Hash | nil

#bypass_document_validation ⇒ true, false

#coll_name ⇒ String

#collation ⇒ Hash

#command(connection) ⇒ Hash

#cursor_count ⇒ Integer

#cursor_id ⇒ Integer

#db_name ⇒ String

#delete ⇒ Hash

#deletes ⇒ Array<BSON::Document>

#documents ⇒ Array<BSON::Document>

#eql?(other)

#index ⇒ Hash

#index_id ⇒ String

#index_name ⇒ String

#indexes ⇒ Hash

#initialize(spec)

#max_time_ms ⇒ Hash

#namespace ⇒ String

#operation_id ⇒ Integer

#options(connection) ⇒ Hash

#read ⇒ Mongo::ServerSelector

#read_concern ⇒ Hash

#selector(connection) ⇒ Hash

#session ⇒ Session

#to_return ⇒ Integer

#txn_num ⇒ Integer

#update ⇒ Hash

#updates ⇒ Array<BSON::Document>

#user ⇒ Auth::User

#user_name ⇒ String

#write_concern ⇒ Mongo::WriteConcern

#acknowledged_write? ⇒ `Boolean` (readonly)

#ordered? ⇒ `true`, `false` (readonly)

#spec ⇒ `Hash` (readonly)

#==(other) ⇒ `true`, `false` Also known as: #eql?

#array_filters(connection) ⇒ `Hash` | `nil`

#bypass_document_validation ⇒ `true`, `false`

#coll_name ⇒ `String`

#collation ⇒ `Hash`

#command(connection) ⇒ `Hash`

#cursor_count ⇒ `Integer`

#cursor_id ⇒ `Integer`

#db_name ⇒ `String`

#delete ⇒ `Hash`

#deletes ⇒ `Array`<`BSON::Document`>

#documents ⇒ `Array`<`BSON::Document`>

#index ⇒ `Hash`

#index_id ⇒ `String`

#index_name ⇒ `String`

#indexes ⇒ `Hash`

#max_time_ms ⇒ `Hash`

#namespace ⇒ `String`

#operation_id ⇒ `Integer`

#options(connection) ⇒ `Hash`

#read_concern ⇒ `Hash`

#selector(connection) ⇒ `Hash`

#to_return ⇒ `Integer`

#txn_num ⇒ `Integer`

#update ⇒ `Hash`

#updates ⇒ `Array`<`BSON::Document`>

#user_name ⇒ `String`