Module: Mongo::Operation::Executable Private
Do not use. This module is for internal use only.
Relationships & Source Files | |
Extension / Inclusion / Inheritance Descendants | |
Included In:
Aggregate::OpMsg ,
Command::OpMsg ,
Count::OpMsg ,
Create::OpMsg ,
CreateIndex::OpMsg ,
CreateSearchIndexes::OpMsg ,
CreateUser::OpMsg ,
Delete::OpMsg ,
Distinct::OpMsg ,
Drop::OpMsg ,
DropDatabase::OpMsg ,
DropIndex::OpMsg ,
DropSearchIndex::OpMsg ,
Explain::OpMsg ,
Find::OpMsg ,
GetMore::OpMsg ,
Indexes::OpMsg ,
Insert::OpMsg ,
KillCursors::OpMsg ,
ListCollections::OpMsg ,
MapReduce::OpMsg ,
OpMsgBase ,
ParallelScan::OpMsg ,
RemoveUser::OpMsg ,
Update::OpMsg ,
UpdateSearchIndex::OpMsg ,
UpdateUser::OpMsg ,
UsersInfo::OpMsg ,
WriteCommand::OpMsg
| |
Super Chains via Extension / Inclusion / Inheritance | |
Instance Chain:
self,
ResponseHandling
|
|
Defined in: | lib/mongo/operation/shared/executable.rb |
Overview
Shared executable behavior of operations.
Constant Summary
-
NETWORK_ERRORS =
[ Error::SocketError, Error::SocketTimeoutError ].freeze
Instance Method Summary
- #do_execute(connection, context, options = {}) Internal use only
- #execute(connection, context:, options: {}) Internal use only
- #build_message(connection, context) private Internal use only
- #check_for_network_error private Internal use only
-
#dispatch_message(connection, context, options = {})
private
Internal use only
Returns a
::Mongo::Protocol::Message
or nil as reply. - #get_result(connection, context, options = {}) private Internal use only
- #process_result(result, connection) private Internal use only
- #process_result_for_sdam(result, connection) private Internal use only
- #result_class private Internal use only
ResponseHandling
- Included
#add_error_labels | Adds error labels to exceptions raised in the yielded to block, which should perform MongoDB operations and raise Mongo::Errors on failure. |
#add_server_diagnostics | Yields to the block and, if the block raises an exception, adds a note to the exception with the address of the specified server. |
#maybe_add_retryable_write_error_label! | A method that will add the RetryableWriteError label to an error if any of the following conditions are true: |
#unpin_maybe | Unpins the session and/or the connection if the yielded to block raises errors that are required to unpin the session and the connection. |
#validate_result |
Instance Method Details
#build_message(connection, context) (private)
# File 'lib/mongo/operation/shared/executable.rb', line 110
def (connection, context) msg = (connection) if server_api = context.server_api msg = msg.maybe_add_server_api(server_api) end msg end
#check_for_network_error (private)
# File 'lib/mongo/operation/shared/executable.rb', line 157
def check_for_network_error yield rescue *NETWORK_ERRORS session&.dirty! raise end
#dispatch_message(connection, context, options = {}) (private)
Returns a ::Mongo::Protocol::Message
or nil as reply.
# File 'lib/mongo/operation/shared/executable.rb', line 100
def (connection, context, = {}) = (connection, context) = .maybe_encrypt(connection, context) reply = connection.dispatch([ ], context, ) [reply, connection.description, connection.global_id] end
#do_execute(connection, context, options = {})
# File 'lib/mongo/operation/shared/executable.rb', line 31
def do_execute(connection, context, = {}) session&.materialize_if_needed unpin_maybe(session, connection) do add_error_labels(connection, context) do check_for_network_error do add_server_diagnostics(connection) do get_result(connection, context, ).tap do |result| if session if session.in_transaction? && connection.description.load_balancer? then if session.pinned_connection_global_id unless session.pinned_connection_global_id == connection.global_id raise( Error::InternalDriverError, "Expected operation to use connection #{session.pinned_connection_global_id} but it used #{connection.global_id}" ) end else session.pin_to_connection(connection.global_id) connection.pin end end if session.snapshot? && !session. session. = result. end end if result.has_cursor_id? && connection.description.load_balancer? then if result.cursor_id == 0 connection.unpin else connection.pin end end process_result(result, connection) end end end end end end
#execute(connection, context:, options: {})
# File 'lib/mongo/operation/shared/executable.rb', line 77
def execute(connection, context:, options: {}) if Lint.enabled? unless connection.is_a?(Mongo::Server::Connection) raise Error::LintError, "Connection argument is of wrong type: #{connection}" end end do_execute(connection, context, ).tap do |result| validate_result(result, connection, context) end end
#get_result(connection, context, options = {}) (private)
# File 'lib/mongo/operation/shared/executable.rb', line 95
def get_result(connection, context, = {}) result_class.new(* (connection, context, )) end
#process_result(result, connection) (private)
# File 'lib/mongo/operation/shared/executable.rb', line 118
def process_result(result, connection) connection.server.update_cluster_time(result) process_result_for_sdam(result, connection) if session session.process(result) end result end
#process_result_for_sdam(result, connection) (private)
# File 'lib/mongo/operation/shared/executable.rb', line 130
def process_result_for_sdam(result, connection) if (result.not_master? || result.node_recovering?) && connection.generation >= connection.server.pool.generation(service_id: connection.service_id) then if result.node_shutting_down? keep_pool = false else # Max wire version needs to be examined while the server is known keep_pool = connection.description.server_version_gte?('4.2') end connection.server.unknown!( keep_connection_pool: keep_pool, generation: connection.generation, service_id: connection.service_id, topology_version: result.topology_version, ) connection.server.scan_semaphore.signal end end
#result_class (private)
# File 'lib/mongo/operation/shared/executable.rb', line 91
def result_class Result end