123456789_123456789_123456789_123456789_123456789_

Module: Mongo::Operation::Specifiable Private

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

Overview

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

Since:

  • 2.0.0

Constant Summary

Instance Attribute Summary

Instance Method Summary

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 542



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 468



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 141



attr_reader :spec


  








  

    #txn_num  ⇒ Integer  (rw)
  



  

    

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 504



def txn_num
  @spec[:txn_num]
end


  








  

    #txn_num=(num)   (rw)
  



  

    
  





  
Since:


    
  
  • 
    
    

    2.0.0
    

    
  
    • 





  [ GitHub ]


  

  


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



def txn_num=(num)
  @spec[:txn_num] = num
end


  







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 153



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 546



def apply_collation(selector, _connection, collation)
  selector = selector.merge(collation: collation) if collation
  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 529



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 361



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:



Since:


    
  
  • 
    
    

    2.0.0
    

    
  
    • 





  [ GitHub ]


  

  


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



def coll_name
  spec[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 373



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 517



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 168



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 240



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:



Since:


    
  
  • 
    
    

    2.0.0
    

    
  
    • 





  [ GitHub ]


  

  


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



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 204



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 192



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 216



def documents
  spec[DOCUMENTS]
end


  








  

    #eql?(other)  
  



  

    

Alias for #==.


  



  [ GitHub ]


  

  


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



alias 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 252



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 259



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 271



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 283



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.
    

    
  
    • 


  
See Also:

  
    
      
  • individual operations for the values they require in their
specs.
    • 
      


Since:


    
  
  • 
    
    

    2.0.0
    

    
  
    • 





  [ GitHub ]


  

  


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



def initialize(spec)
  @spec = spec
end


  








  

    #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 349



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 480



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 311



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 323



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


  








  

    #read  ⇒ Mongo::ServerSelector 
  



  

    

The read preference for this operation.


  





    

    
Examples:

        


Get the read preference.



      
specifiable.read

  


Returns:



Since:


    
  
  • 
    
    

    2.0.0
    

    
  
    • 





  [ GitHub ]


  

  


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



def read
  @read ||= (ServerSelector.get(spec[READ]) if spec[READ])
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 337



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 386



def selector(_connection)
  spec[SELECTOR]
end


  








  

    #session  ⇒ Session 
  



  

    

The session to use for the operation.


  





    

    
Examples:

        


Get the session.



      
specifiable.session

  


Returns:



Since:


    
  
  • 
    
    

    2.5.0
    

    
  
    • 





  [ GitHub ]


  

  


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



def session
  @spec[:session]
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 408



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 397



def updates
  spec[UPDATES]
end


  








  

    #user  ⇒ Auth::User 
  



  

    

The user for user related operations.


  





    

    
Examples:

        


Get the user.



      
specifiable.user

  


Returns:



Since:


    
  
  • 
    
    

    2.0.0
    

    
  
    • 





  [ GitHub ]


  

  


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



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 432



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:



Since:


    
  
  • 
    
    

    2.0.0
    

    
  
    • 





  [ GitHub ]


  

  


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



def write_concern
  @spec[WRITE_CONCERN]
end