class Mongo::Operation::Context
Context
for operations.
Holds various objects needed to make decisions about operation execution in a single container, and provides facade methods for the contained objects.
The context contains parameters for operations, and as such while an operation is being prepared nothing in the context should change. When the result of the operation is being processed, the data returned by the context may change (for example, because a transaction is aborted), but at that point the operation should no longer read anything from the context. Because context data may change during operation execution, context objects should not be reused for multiple operations.
@api private
Attributes
Public Class Methods
# File lib/mongo/operation/context.rb, line 38 def initialize(client: nil, session: nil, connection_global_id: nil, options: nil) if options if client raise ArgumentError, 'Client and options cannot both be specified' end if session raise ArgumentError, 'Session and options cannot both be specified' end end if connection_global_id && session&.pinned_connection_global_id raise ArgumentError, 'Trying to pin context to a connection when the session is already pinned to a connection.' end @client = client @session = session @connection_global_id = connection_global_id @options = options end
Public Instance Methods
# File lib/mongo/operation/context.rb, line 79 def aborting_transaction? in_transaction? && session.aborting_transaction? end
# File lib/mongo/operation/context.rb, line 91 def any_retry_writes? modern_retry_writes? || legacy_retry_writes? end
# File lib/mongo/operation/context.rb, line 75 def committing_transaction? in_transaction? && session.committing_transaction? end
# File lib/mongo/operation/context.rb, line 63 def connection_global_id @connection_global_id || session&.pinned_connection_global_id end
# File lib/mongo/operation/context.rb, line 125 def decrypt? !!client&.encrypter end
# File lib/mongo/operation/context.rb, line 121 def encrypt? client&.encrypter&.encrypt? || false end
# File lib/mongo/operation/context.rb, line 129 def encrypter if client&.encrypter client.encrypter else raise Error::InternalDriverError, 'Encrypter should only be accessed when encryption is to be performed' end end
# File lib/mongo/operation/context.rb, line 67 def in_transaction? session&.in_transaction? || false end
# File lib/mongo/operation/context.rb, line 87 def legacy_retry_writes? client && !client.options[:retry_writes] && client.max_write_retries > 0 end
# File lib/mongo/operation/context.rb, line 83 def modern_retry_writes? client && client.options[:retry_writes] end
Whether the operation is a retry (true) or an initial attempt (false).
# File lib/mongo/operation/context.rb, line 104 def retry? !!@is_retry end
# File lib/mongo/operation/context.rb, line 95 def server_api if client client.options[:server_api] elsif options options[:server_api] end end
# File lib/mongo/operation/context.rb, line 71 def starting_transaction? session&.starting_transaction? || false end
Returns a new context with the parameters changed as per the provided arguments.
@option opts [ true|false ] :is_retry Whether the operation is a retry
or a first attempt.
# File lib/mongo/operation/context.rb, line 113 def with(**opts) dup.tap do |copy| opts.each do |k, v| copy.instance_variable_set("@#{k}", v) end end end