mongo 2.4.1 → 2.14.0

data/lib/mongo/collection.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2016 MongoDB, Inc.
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -50,13 +50,10 @@ module Mongo
     # Delegate to the cluster for the next primary.
     def_delegators :cluster, :next_primary
 
-    # Convenience delegators to find.
-    def_delegators :find, :parallel_scan
-
     # Options that can be updated on a new Collection instance via the #with method.
     #
     # @since 2.1.0
-    CHANGEABLE_OPTIONS = [ :read, :read_concern, :write ].freeze
+    CHANGEABLE_OPTIONS = [ :read, :read_concern, :write, :write_concern ].freeze
 
     # Check if a collection is equal to another object. Will check the name and
     # the database for equality.
@@ -83,12 +80,28 @@ module Mongo
     # @param [ String, Symbol ] name The collection name.
     # @param [ Hash ] options The collection options.
     #
+    # @option options [ Hash ] :write Deprecated. Equivalent to :write_concern
+    #   option.
+    # @option options [ Hash ] :write_concern The write concern options.
+    #   Can be :w => Integer|String, :fsync => Boolean, :j => Boolean.
+    #
     # @since 2.0.0
     def initialize(database, name, options = {})
       raise Error::InvalidCollectionName.new unless name
+      if options[:write] && options[:write_concern] && options[:write] != options[:write_concern]
+        raise ArgumentError, "If :write and :write_concern are both given, they must be identical: #{options.inspect}"
+      end
       @database = database
       @name = name.to_s.freeze
-      @options = options.freeze
+      @options = options.dup
+=begin WriteConcern object support
+      if @options[:write_concern].is_a?(WriteConcern::Base)
+        # Cache the instance so that we do not needlessly reconstruct it.
+        @write_concern = @options[:write_concern]
+        @options[:write_concern] = @write_concern.options
+      end
+=end
+      @options.freeze
     end
 
     # Get the read concern for this collection instance.
@@ -100,7 +113,19 @@ module Mongo
     #
     # @since 2.2.0
     def read_concern
-      @read_concern ||= options[:read_concern]
+      options[:read_concern] || database.read_concern
+    end
+
+    # Get the server selector on this collection.
+    #
+    # @example Get the server selector.
+    #   collection.server_selector
+    #
+    # @return [ Mongo::ServerSelector ] The server selector.
+    #
+    # @since 2.0.0
+    def server_selector
+      @server_selector ||= ServerSelector.get(read_preference || database.server_selector)
     end
 
     # Get the read preference on this collection.
@@ -108,11 +133,11 @@ module Mongo
     # @example Get the read preference.
     #   collection.read_preference
     #
-    # @return [ Mongo::ServerSelector ] The read preference.
+    # @return [ Hash ] The read preference.
     #
     # @since 2.0.0
     def read_preference
-      @read_preference ||= ServerSelector.get(options[:read] || database.read_preference)
+      @read_preference ||= options[:read] || database.read_preference
     end
 
     # Get the write concern on this collection.
@@ -124,17 +149,40 @@ module Mongo
     #
     # @since 2.0.0
     def write_concern
-      @write_concern ||= WriteConcern.get(options[:write] || database.write_concern)
+      @write_concern ||= WriteConcern.get(
+        options[:write_concern] || options[:write] || database.write_concern)
+    end
+
+    # Get the write concern for the collection, given the session.
+    #
+    # If the session is in a transaction and the collection
+    # has an unacknowledged write concern, remove the write
+    # concern's :w option. Otherwise, return the unmodified
+    # write concern.
+    #
+    # @return [ Mongo::WriteConcern ] The write concern.
+    #
+    # @api private
+    def write_concern_with_session(session)
+      wc = write_concern
+      if session && session.in_transaction?
+        if wc && !wc.acknowledged?
+          opts = wc.options.dup
+          opts.delete(:w)
+          return WriteConcern.get(opts)
+        end
+      end
+      wc
     end
 
     # Provides a new collection with either a new read preference or new write concern
     # merged over the existing read preference / write concern.
     #
-    # @example Get a collection with changed read preference.
-    #   collection.with(:read => { :mode => :primary_preferred })
+    # @example Get a collection with a changed read preference.
+    #   collection.with(read: { mode: :primary_preferred })
     #
-    # @example Get a collection with changed write concern.
-    #   collection.with(:write => { w:  3 })
+    # @example Get a collection with a changed write concern.
+    #   collection.with(write_concern: { w:  3 })
 
     # @param [ Hash ] new_options The new options to use.
     #
@@ -145,7 +193,14 @@ module Mongo
       new_options.keys.each do |k|
         raise Error::UnchangeableCollectionOption.new(k) unless CHANGEABLE_OPTIONS.include?(k)
       end
-      Collection.new(database, name, options.merge(new_options))
+      options = @options.dup
+      if options[:write] && new_options[:write_concern]
+        options.delete(:write)
+      end
+      if options[:write_concern] && new_options[:write]
+        options.delete(:write_concern)
+      end
+      Collection.new(database, name, options.update(new_options))
     end
 
     # Is the collection capped?
@@ -157,7 +212,7 @@ module Mongo
     #
     # @since 2.0.0
     def capped?
-      database.command(:collstats => name).documents[0][CAPPED]
+      database.read_command(:collstats => name).documents[0][CAPPED]
     end
 
     # Force the collection to be created in the database.
@@ -165,21 +220,43 @@ module Mongo
     # @example Force the collection to be created.
     #   collection.create
     #
+    # @param [ Hash ] opts The options for the create operation.
+    #
+    # @option options [ Session ] :session The session to use for the operation.
+    # @option opts [ Hash ] :write_concern The write concern options.
+    #
     # @return [ Result ] The result of the command.
     #
     # @since 2.0.0
-    def create
+    def create(opts = {})
+      # Passing read options to create command causes it to break.
+      # Filter the read options out.
+      # TODO put the list of read options in a class-level constant when
+      # we figure out what the full set of them is.
+      options = Hash[self.options.reject do |key, value|
+        %w(read read_preference).include?(key.to_s)
+      end]
       operation = { :create => name }.merge(options)
       operation.delete(:write)
-      server = next_primary
-      if (options[:collation] || options[Operation::COLLATION]) && !server.features.collation_enabled?
-        raise Error::UnsupportedCollation.new
+      operation.delete(:write_concern)
+      client.send(:with_session, opts) do |session|
+        write_concern = if opts[:write_concern]
+          WriteConcern.get(opts[:write_concern])
+        else
+          self.write_concern
+        end
+        server = next_primary(nil, session)
+        if (options[:collation] || options[Operation::COLLATION]) && !server.with_connection { |connection| connection.features }.collation_enabled?
+          raise Error::UnsupportedCollation
+        end
+
+        Operation::Create.new({
+                                selector: operation,
+                                db_name: database.name,
+                                write_concern: write_concern,
+                                session: session
+                                }).execute(server, client: client)
       end
-      Operation::Commands::Create.new({
-                                        selector: operation,
-                                        db_name: database.name,
-                                        write_concern: write_concern
-                                      }).execute(server)
     end
 
     # Drop the collection. Will also drop all indexes associated with the
@@ -190,19 +267,36 @@ module Mongo
     # @example Drop the collection.
     #   collection.drop
     #
+    # @param [ Hash ] opts The options for the drop operation.
+    #
+    # @option options [ Session ] :session The session to use for the operation.
+    # @option opts [ Hash ] :write_concern The write concern options.
+    #
     # @return [ Result ] The result of the command.
     #
     # @since 2.0.0
-    def drop
-      Operation::Commands::Drop.new({
-                                      selector: { :drop => name },
-                                      db_name: database.name,
-                                      write_concern: write_concern
-                                    }).execute(next_primary)
-
+    def drop(opts = {})
+      client.send(:with_session, opts) do |session|
+        temp_write_concern = write_concern
+        write_concern = if opts[:write_concern]
+          WriteConcern.get(opts[:write_concern])
+        else
+          temp_write_concern
+        end
+        Operation::Drop.new({
+                              selector: { :drop => name },
+                              db_name: database.name,
+                              write_concern: write_concern,
+                              session: session
+                              }).execute(next_primary(nil, session), client: client)
+      end
     rescue Error::OperationFailure => ex
-      raise ex unless ex.message =~ /ns not found/
-      false
+      # NamespaceNotFound
+      if ex.code == 26 || ex.code.nil? && ex.message =~ /ns not found/
+        false
+      else
+        raise
+      end
     end
 
     # Find documents in the collection.
@@ -216,6 +310,10 @@ module Mongo
     # @param [ Hash ] filter The filter to use in the find.
     # @param [ Hash ] options The options for the find.
     #
+    # @option options [ true, false ] :allow_disk_use When set to true, the
+    #   server can write temporary data to disk while executing the find
+    #   operation. This option is only available on MongoDB server versions
+    #   4.4 and newer.
     # @option options [ true, false ] :allow_partial_results Allows the query to get partial
     #   results if some shards are down.
     # @option options [ Integer ] :batch_size The number of documents returned in each batch
@@ -238,6 +336,7 @@ module Mongo
     # @option options [ Hash ] :sort The key and direction pairs by which the result set
     #   will be sorted.
     # @option options [ Hash ] :collation The collation to use.
+    # @option options [ Session ] :session The session to use.
     #
     # @return [ CollectionView ] The collection view.
     #
@@ -254,25 +353,71 @@ module Mongo
     # @param [ Array<Hash> ] pipeline The aggregation pipeline.
     # @param [ Hash ] options The aggregation options.
     #
-    # @option options [ true, false ] :allow_disk_use Set to true if disk usage is allowed during
-    #   the aggregation.
-    # @option options [ Integer ] :batch_size The number of documents to return per batch.
-    # @option options [ Integer ] :max_time_ms The maximum amount of time in milliseconds to allow the
-    #   aggregation to run.
-    # @option options [ true, false ] :use_cursor Indicates whether the command will request that the server
-    #   provide results using a cursor.
+    # @option options [ true, false ] :allow_disk_use Set to true if disk
+    #   usage is allowed during the aggregation.
+    # @option options [ Integer ] :batch_size The number of documents to return
+    #   per batch.
     # @option options [ true, false ] :bypass_document_validation Whether or
     #   not to skip document level validation.
     # @option options [ Hash ] :collation The collation to use.
+    # @option options [ String ] :comment Associate a comment with the aggregation.
+    # @option options [ String ] :hint The index to use for the aggregation.
+    # @option options [ Integer ] :max_time_ms The maximum amount of time in
+    #   milliseconds to allow the aggregation to run.
+    # @option options [ true, false ] :use_cursor Indicates whether the command
+    #   will request that the server provide results using a cursor. Note that
+    #   as of server version 3.6, aggregations always provide results using a
+    #   cursor and this option is therefore not valid.
+    # @option options [ Session ] :session The session to use.
     #
     # @return [ Aggregation ] The aggregation object.
     #
     # @since 2.1.0
     def aggregate(pipeline, options = {})
-      View.new(self, {}).aggregate(pipeline, options)
+      View.new(self, {}, options).aggregate(pipeline, options)
+    end
+
+    # As of version 3.6 of the MongoDB server, a ``$changeStream`` pipeline
+    # stage is supported in the aggregation framework. This stage allows users
+    # to request that notifications are sent for all changes to a particular
+    # collection.
+    #
+    # @example Get change notifications for a given collection.
+    #   collection.watch([{ '$match' => { operationType: { '$in' => ['insert', 'replace'] } } }])
+    #
+    # @param [ Array<Hash> ] pipeline Optional additional filter operators.
+    # @param [ Hash ] options The change stream options.
+    #
+    # @option options [ String ] :full_document Allowed values: ‘default’,
+    #   ‘updateLookup’. Defaults to ‘default’. When set to ‘updateLookup’,
+    #   the change notification for partial updates will include both a delta
+    #   describing the changes to the document, as well as a copy of the entire
+    #   document that was changed from some time after the change occurred.
+    # @option options [ BSON::Document, Hash ] :resume_after Specifies the
+    #   logical starting point for the new change stream.
+    # @option options [ Integer ] :max_await_time_ms The maximum amount of time
+    #   for the server to wait on new documents to satisfy a change stream query.
+    # @option options [ Integer ] :batch_size The number of documents to return
+    #   per batch.
+    # @option options [ BSON::Document, Hash ] :collation The collation to use.
+    # @option options [ Session ] :session The session to use.
+    # @option options [ BSON::Timestamp ] :start_at_operation_time Only return
+    #   changes that occurred at or after the specified timestamp. Any command run
+    #   against the server will return a cluster time that can be used here.
+    #   Only recognized by server versions 4.0+.
+    #
+    # @note A change stream only allows 'majority' read concern.
+    # @note This helper method is preferable to running a raw aggregation with
+    #   a $changeStream stage, for the purpose of supporting resumability.
+    #
+    # @return [ ChangeStream ] The change stream object.
+    #
+    # @since 2.5.0
+    def watch(pipeline = [], options = {})
+      View::ChangeStream.new(View.new(self, {}, options), pipeline, nil, options)
     end
 
-    # Get a count of matching documents in the collection.
+    # Gets an estimated number of matching documents in the collection.
     #
     # @example Get the count.
     #   collection.count(name: 1)
@@ -286,14 +431,67 @@ module Mongo
     # @option options [ Integer ] :skip The number of documents to skip before counting.
     # @option options [ Hash ] :read The read preference options.
     # @option options [ Hash ] :collation The collation to use.
+    # @option options [ Session ] :session The session to use.
     #
     # @return [ Integer ] The document count.
     #
     # @since 2.1.0
+    #
+    # @deprecated Use #count_documents or estimated_document_count instead. However, note that the
+    #   following operators will need to be substituted when switching to #count_documents:
+    #     * $where should be replaced with $expr (only works on 3.6+)
+    #     * $near should be replaced with $geoWithin with $center
+    #     * $nearSphere should be replaced with $geoWithin with $centerSphere
     def count(filter = nil, options = {})
       View.new(self, filter || {}, options).count(options)
     end
 
+    # Gets the number of documents matching the query. Unlike the deprecated
+    # #count method, this will return the exact number of documents matching
+    # the filter (or exact number of documents in the collection, if no filter
+    # is provided) rather than an estimate.
+    #
+    # Use #estimated_document_count to retrieve an estimate of the number
+    # of documents in the collection using the collection metadata.
+    #
+    # @param [ Hash ] filter A filter for matching documents.
+    # @param [ Hash ] options Options for the operation.
+    #
+    # @option opts :skip [ Integer ] The number of documents to skip.
+    # @option opts :hint [ Hash ] Override default index selection and force
+    #   MongoDB to use a specific index for the query. Requires server version 3.6+.
+    # @option opts :limit [ Integer ] Max number of docs to count.
+    # @option opts :max_time_ms [ Integer ] The maximum amount of time to allow the
+    #   command to run.
+    # @option opts [ Hash ] :read The read preference options.
+    # @option opts [ Hash ] :collation The collation to use.
+    #
+    # @return [ Integer ] The document count.
+    #
+    # @since 2.6.0
+    def count_documents(filter = {}, options = {})
+      View.new(self, filter, options).count_documents(options)
+    end
+
+    # Gets an estimate of the number of documents in the collection using the
+    # collection metadata.
+    #
+    # Use #count_documents to retrieve the exact number of documents in the
+    # collection, or to count documents matching a filter.
+    #
+    # @param [ Hash ] options Options for the operation.
+    #
+    # @option opts :max_time_ms [ Integer ] The maximum amount of time to allow
+    #   the command to run for on the server.
+    # @option opts [ Hash ] :read The read preference options.
+    #
+    # @return [ Integer ] The document count.
+    #
+    # @since 2.6.0
+    def estimated_document_count(options = {})
+      View.new(self, {}, options).estimated_document_count(options)
+    end
+
     # Get a list of distinct values for a specific field.
     #
     # @example Get the distinct values.
@@ -306,6 +504,7 @@ module Mongo
     # @option options [ Integer ] :max_time_ms The maximum amount of time to allow the command to run.
     # @option options [ Hash ] :read The read preference options.
     # @option options [ Hash ] :collation The collation to use.
+    # @option options [ Session ] :session The session to use.
     #
     # @return [ Array<Object> ] The list of distinct values.
     #
@@ -322,6 +521,8 @@ module Mongo
     #
     # @param [ Hash ] options Options for getting a list of all indexes.
     #
+    # @option options [ Session ] :session The session to use.
+    #
     # @return [ View::Index ] The index view.
     #
     # @since 2.0.0
@@ -347,22 +548,40 @@ module Mongo
     #   collection.insert_one({ name: 'test' })
     #
     # @param [ Hash ] document The document to insert.
-    # @param [ Hash ] options The insert options.
+    # @param [ Hash ] opts The insert options.
+    #
+    # @option opts [ Session ] :session The session to use for the operation.
     #
     # @return [ Result ] The database response wrapper.
     #
     # @since 2.0.0
-    def insert_one(document, options = {})
-      write_with_retry do
-        Operation::Write::Insert.new(
-          :documents => [ document ],
-          :db_name => database.name,
-          :coll_name => name,
-          :write_concern => write_concern,
-          :bypass_document_validation => !!options[:bypass_document_validation],
-          :options => options,
-          :id_generator => client.options[:id_generator]
-        ).execute(next_primary)
+    def insert_one(document, opts = {})
+      QueryCache.clear_namespace(namespace)
+
+      client.send(:with_session, opts) do |session|
+        write_concern = if opts[:write_concern]
+          WriteConcern.get(opts[:write_concern])
+        else
+          write_concern_with_session(session)
+        end
+
+        if document.nil?
+          raise ArgumentError, "Document to be inserted cannot be nil"
+        end
+
+        write_with_retry(session, write_concern) do |server, txn_num|
+          Operation::Insert.new(
+            :documents => [ document ],
+            :db_name => database.name,
+            :coll_name => name,
+            :write_concern => write_concern,
+            :bypass_document_validation => !!opts[:bypass_document_validation],
+            :options => opts,
+            :id_generator => client.options[:id_generator],
+            :session => session,
+            :txn_num => txn_num
+          ).execute(server, client: client)
+        end
       end
     end
 
@@ -374,10 +593,14 @@ module Mongo
     # @param [ Array<Hash> ] documents The documents to insert.
     # @param [ Hash ] options The insert options.
     #
+    # @option options [ Session ] :session The session to use for the operation.
+    #
     # @return [ Result ] The database response wrapper.
     #
     # @since 2.0.0
     def insert_many(documents, options = {})
+      QueryCache.clear_namespace(namespace)
+
       inserts = documents.map{ |doc| { :insert_one => doc }}
       bulk_write(inserts, options)
     end
@@ -396,6 +619,7 @@ module Mongo
     #   Can be :w => Integer, :fsync => Boolean, :j => Boolean.
     # @option options [ true, false ] :bypass_document_validation Whether or
     #   not to skip document level validation.
+    # @option options [ Session ] :session The session to use for the set of operations.
     #
     # @return [ BulkWrite::Result ] The result of the operation.
     #
@@ -413,6 +637,9 @@ module Mongo
     # @param [ Hash ] options The options.
     #
     # @option options [ Hash ] :collation The collation to use.
+    # @option options [ Session ] :session The session to use.
+    # @option options [ Hash | String ] :hint The index to use for this operation.
+    #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
     #
     # @return [ Result ] The response from the database.
     #
@@ -430,6 +657,9 @@ module Mongo
     # @param [ Hash ] options The options.
     #
     # @option options [ Hash ] :collation The collation to use.
+    # @option options [ Session ] :session The session to use.
+    # @option options [ Hash | String ] :hint The index to use for this operation.
+    #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
     #
     # @return [ Result ] The response from the database.
     #
@@ -452,12 +682,13 @@ module Mongo
     #
     # @option options [ Integer ] :max_time_ms The maximum amount of time to allow the command
     #   to run in milliseconds.
+    # @option options [ Session ] :session The session to use.
     #
     # @return [ Array<Cursor> ] An array of cursors.
     #
     # @since 2.1
     def parallel_scan(cursor_count, options = {})
-      find.send(:parallel_scan, cursor_count, options)
+      find({}, options).send(:parallel_scan, cursor_count, options)
     end
 
     # Replaces a single document in the collection with the new document.
@@ -474,6 +705,9 @@ module Mongo
     # @option options [ true, false ] :bypass_document_validation Whether or
     #   not to skip document level validation.
     # @option options [ Hash ] :collation The collation to use.
+    # @option options [ Session ] :session The session to use.
+    # @option options [ Hash | String ] :hint The index to use for this operation.
+    #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
     #
     # @return [ Result ] The response from the database.
     #
@@ -488,7 +722,7 @@ module Mongo
     #   collection.update_many({ name: 'test'}, '$set' => { name: 'test1' })
     #
     # @param [ Hash ] filter The filter to use.
-    # @param [ Hash ] update The update statement.
+    # @param [ Hash | Array<Hash> ] update The update document or pipeline.
     # @param [ Hash ] options The options.
     #
     # @option options [ true, false ] :upsert Whether to upsert if the
@@ -496,6 +730,11 @@ module Mongo
     # @option options [ true, false ] :bypass_document_validation Whether or
     #   not to skip document level validation.
     # @option options [ Hash ] :collation The collation to use.
+    # @option options [ Array ] :array_filters A set of filters specifying to which array elements
+    #   an update should apply.
+    # @option options [ Session ] :session The session to use.
+    # @option options [ Hash | String ] :hint The index to use for this operation.
+    #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
     #
     # @return [ Result ] The response from the database.
     #
@@ -510,7 +749,7 @@ module Mongo
     #   collection.update_one({ name: 'test'}, '$set' => { name: 'test1'})
     #
     # @param [ Hash ] filter The filter to use.
-    # @param [ Hash ] update The update statement.
+    # @param [ Hash | Array<Hash> ] update The update document or pipeline.
     # @param [ Hash ] options The options.
     #
     # @option options [ true, false ] :upsert Whether to upsert if the
@@ -518,6 +757,11 @@ module Mongo
     # @option options [ true, false ] :bypass_document_validation Whether or
     #   not to skip document level validation.
     # @option options [ Hash ] :collation The collation to use.
+    # @option options [ Array ] :array_filters A set of filters specifying to which array elements
+    #   an update should apply.
+    # @option options [ Session ] :session The session to use.
+    # @option options [ Hash | String ] :hint The index to use for this operation.
+    #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
     #
     # @return [ Result ] The response from the database.
     #
@@ -543,12 +787,15 @@ module Mongo
     # @option options [ Hash ] :write_concern The write concern options.
     #   Defaults to the collection's write concern.
     # @option options [ Hash ] :collation The collation to use.
+    # @option options [ Session ] :session The session to use.
+    # @option options [ Hash | String ] :hint The index to use for this operation.
+    #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
     #
     # @return [ BSON::Document, nil ] The document, if found.
     #
     # @since 2.1.0
     def find_one_and_delete(filter, options = {})
-      find(filter, options).find_one_and_delete
+      find(filter, options).find_one_and_delete(options)
     end
 
     # Finds a single document via findAndModify and updates it, returning the original doc unless
@@ -561,7 +808,7 @@ module Mongo
     #   collection.find_one_and_update({ name: 'test' }, { "$set" => { name: 'test1' }}, :return_document => :after)
     #
     # @param [ Hash ] filter The filter to use.
-    # @param [ BSON::Document ] update The update statement.
+    # @param [ Hash | Array<Hash> ] update The update document or pipeline.
     # @param [ Hash ] options The options.
     #
     # @option options [ Integer ] :max_time_ms The maximum amount of time to allow the command
@@ -576,6 +823,11 @@ module Mongo
     # @option options [ Hash ] :write_concern The write concern options.
     #   Defaults to the collection's write concern.
     # @option options [ Hash ] :collation The collation to use.
+    # @option options [ Array ] :array_filters A set of filters specifying to which array elements
+    #   an update should apply.
+    # @option options [ Session ] :session The session to use.
+    # @option options [ Hash | String ] :hint The index to use for this operation.
+    #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
     #
     # @return [ BSON::Document ] The document.
     #
@@ -609,6 +861,9 @@ module Mongo
     # @option options [ Hash ] :write_concern The write concern options.
     #   Defaults to the collection's write concern.
     # @option options [ Hash ] :collation The collation to use.
+    # @option options [ Session ] :session The session to use.
+    # @option options [ Hash | String ] :hint The index to use for this operation.
+    #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
     #
     # @return [ BSON::Document ] The document.
     #
@@ -628,5 +883,14 @@ module Mongo
     def namespace
       "#{database.name}.#{name}"
     end
+
+    # Whether the collection is a system collection.
+    #
+    # @return [ Boolean ] Whether the system is a system collection.
+    #
+    # @api private
+    def system_collection?
+      name.start_with?('system.')
+    end
   end
 end