123456789_123456789_123456789_123456789_123456789_

Class: Mongo::Operation::Context Private

Do not use. This class is for internal use only.
Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::Mongo::CsotTimeoutHolder
Instance Chain:
self, ::Mongo::CsotTimeoutHolder
Inherits: Mongo::CsotTimeoutHolder
Defined in: lib/mongo/operation/context.rb

Overview

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.

Class Method Summary

::Mongo::CsotTimeoutHolder - Inherited

.new

Instance Attribute Summary

::Mongo::CsotTimeoutHolder - Inherited

#csot?, #deadline, #operation_timeouts, #timeout?, #timeout_expired?, #timeout_sec

Instance Method Summary

::Mongo::CsotTimeoutHolder - Inherited

#check_timeout!

Check whether the operation timeout expired, and raises an appropriate error if yes.
#remaining_timeout_ms, #remaining_timeout_ms!, #remaining_timeout_sec, #remaining_timeout_sec!, #calculate_deadline, #calculate_deadline_from_timeout_ms, #check_no_override_inside_transaction!

Instance Attribute Details

#aborting_transaction? ⇒ Boolean (readonly)

[ GitHub ] 

  


# File 'lib/mongo/operation/context.rb', line 105



def aborting_transaction?
  in_transaction? && session.aborting_transaction?
end


  








  

    #any_retry_writes?  ⇒ Boolean  (readonly)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/mongo/operation/context.rb', line 117



def any_retry_writes?
  modern_retry_writes? || legacy_retry_writes?
end


  








  

    #client   (readonly)
  

  [ GitHub ]


  

  


# File 'lib/mongo/operation/context.rb', line 68



attr_reader :client


  








  

    #committing_transaction?  ⇒ Boolean  (readonly)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/mongo/operation/context.rb', line 101



def committing_transaction?
  in_transaction? && session.committing_transaction?
end


  








  

    #decrypt?  ⇒ Boolean  (readonly)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/mongo/operation/context.rb', line 155



def decrypt?
  !!client&.encrypter
end


  








  

    #encrypt?  ⇒ Boolean  (readonly)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/mongo/operation/context.rb', line 147



def encrypt?
  client&.encrypter&.encrypt? || false
end


  








  

    #in_transaction?  ⇒ Boolean  (readonly)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/mongo/operation/context.rb', line 93



def in_transaction?
  session&.in_transaction? || false
end


  








  

    #legacy_retry_writes?  ⇒ Boolean  (readonly)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/mongo/operation/context.rb', line 113



def legacy_retry_writes?
  client && !client.options[:retry_writes] && client.max_write_retries > 0
end


  








  

    #modern_retry_writes?  ⇒ Boolean  (readonly)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/mongo/operation/context.rb', line 109



def modern_retry_writes?
  client && client.options[:retry_writes]
end


  








  

    #options   (readonly)
  

  [ GitHub ]


  

  


# File 'lib/mongo/operation/context.rb', line 71



attr_reader :options


  








  

    #retry?  ⇒ Boolean  (readonly)
  



  

    

Whether the operation is a retry (true) or an initial attempt (false).


  





  


  [ GitHub ]


  

  


# File 'lib/mongo/operation/context.rb', line 130



def retry?
  !!@is_retry
end


  








  

    #session   (readonly)
  

  [ GitHub ]


  

  


# File 'lib/mongo/operation/context.rb', line 69



attr_reader :session


  








  

    #starting_transaction?  ⇒ Boolean  (readonly)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/mongo/operation/context.rb', line 97



def starting_transaction?
  session&.starting_transaction? || false
end


  








  

    #view   (readonly)
  

  [ GitHub ]


  

  


# File 'lib/mongo/operation/context.rb', line 70



attr_reader :view


  







Instance Method Details



  

    #connection_global_id  
  

  [ GitHub ]


  

  


# File 'lib/mongo/operation/context.rb', line 89



def connection_global_id
  @connection_global_id || session&.pinned_connection_global_id
end


  








  

    #decrypt(cmd)   (readonly)
  

  [ GitHub ]


  

  


# File 'lib/mongo/operation/context.rb', line 159



def decrypt(cmd)
  encrypter.decrypt(cmd, self)
end


  








  

    #encrypt(db_name, cmd)   (readonly)
  

  [ GitHub ]


  

  


# File 'lib/mongo/operation/context.rb', line 151



def encrypt(db_name, cmd)
  encrypter.encrypt(db_name, cmd, self)
end


  








  

    #encrypter  
  

  [ GitHub ]


  

  


# File 'lib/mongo/operation/context.rb', line 163



def encrypter
  if client&.encrypter
    client.encrypter
  else
    raise Error::InternalDriverError, 'Encrypter should only be accessed when encryption is to be performed'
  end
end


  








  

    #inspect  
  

  [ GitHub ]


  

  


# File 'lib/mongo/operation/context.rb', line 171



def inspect
  "#<#{self.class} connection_global_id=#{connection_global_id.inspect} deadline=#{deadline.inspect} options=#{options.inspect} operation_timeouts=#{operation_timeouts.inspect}>"
end


  








  

    #refresh(connection_global_id: @connection_global_id, timeout_ms: nil, view: nil)  ⇒ Operation::Context 
  



  

    

Returns a new Context with the deadline refreshed and relative to the current moment.


  





  
Returns:





  [ GitHub ]


  

  


# File 'lib/mongo/operation/context.rb', line 77



def refresh(connection_global_id: @connection_global_id, timeout_ms: nil, view: nil)
  operation_timeouts = @operation_timeouts
  operation_timeouts = operation_timeouts.merge(operation_timeout_ms: timeout_ms) if timeout_ms

  self.class.new(client: client,
                 session: session,
                 connection_global_id: connection_global_id,
                 operation_timeouts: operation_timeouts,
                 view: view || self.view,
                 options: options)
end


  








  

    #server_api  
  

  [ GitHub ]


  

  


# File 'lib/mongo/operation/context.rb', line 121



def server_api
  if client
    client.options[:server_api]
  elsif options
    options[:server_api]
  end
end


  








  

    #with(**opts)  
  



  

    

Returns a new context with the parameters changed as per the provided arguments.


  





  
Parameters:


    
  
  • 
    opts
    (Hash)
—    
    

    a customizable set of options
    

    
  
    • 


    
Options Hash (**opts):

    
    
        
  • 
          :is_retry
          (true|false)
            — 
    

    Whether the operation is a retry or a first attempt.
    

            
    • 
    




  [ GitHub ]


  

  


# File 'lib/mongo/operation/context.rb', line 139



def with(**opts)
  dup.tap do |copy|
    opts.each do |k, v|
      copy.instance_variable_set("@#{k}", v)
    end
  end
end