mongo 1.12.5 → 2.0.0.beta

data/lib/mongo/database.rb

@@ -0,0 +1,224 @@
+# Copyright (C) 2014-2015 MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'mongo/database/view'
+
+module Mongo
+
+  # Represents a database on the db server and operations that can execute on
+  # it at this level.
+  #
+  # @since 2.0.0
+  class Database
+    extend Forwardable
+
+    # The admin database name.
+    #
+    # @since 2.0.0
+    ADMIN = 'admin'.freeze
+
+    # The "collection" that database commands operate against.
+    #
+    # @since 2.0.0
+    COMMAND = '$cmd'.freeze
+
+    # The default database options.
+    #
+    # @since 2.0.0
+    DEFAULT_OPTIONS = { :database => ADMIN }.freeze
+
+    # The name of the collection that holds all the collection names.
+    #
+    # @since 2.0.0
+    NAMESPACES = 'system.namespaces'.freeze
+
+    # @return [ Client ] client The database client.
+    attr_reader :client
+
+    # @return [ String ] name The name of the database.
+    attr_reader :name
+
+    # @return [ Hash ] options The options.
+    attr_reader :options
+
+    # Get cluster, read preference, and write concern from client.
+    def_delegators :@client,
+                   :cluster,
+                   :read_preference,
+                   :write_concern
+
+    # Check equality of the database object against another. Will simply check
+    # if the names are the same.
+    #
+    # @example Check database equality.
+    #   database == other
+    #
+    # @param [ Object ] other The object to check against.
+    #
+    # @return [ true, false ] If the objects are equal.
+    #
+    # @since 2.0.0
+    def ==(other)
+      return false unless other.is_a?(Database)
+      name == other.name
+    end
+
+    # Get a collection in this database by the provided name.
+    #
+    # @example Get a collection.
+    #   database[:users]
+    #
+    # @param [ String, Symbol ] collection_name The name of the collection.
+    # @param [ Hash ] options The options to the collection.
+    #
+    # @return [ Mongo::Collection ] The collection object.
+    #
+    # @since 2.0.0
+    def [](collection_name, options = {})
+      Collection.new(self, collection_name, options)
+    end
+    alias_method :collection, :[]
+
+    # Get all the names of the non system collections in the database.
+    #
+    # @example Get the collection names.
+    #   database.collection_names
+    #
+    # @return [ Array<String> ] The names of all non-system collections.
+    #
+    # @since 2.0.0
+    def collection_names(options = {})
+      View.new(self).collection_names(options)
+    end
+
+    # Get all the collections that belong to this database.
+    #
+    # @example Get all the collections.
+    #   database.collections
+    #
+    # @return [ Array<Mongo::Collection> ] All the collections.
+    #
+    # @since 2.0.0
+    def collections
+      collection_names.map { |name| collection(name) }
+    end
+
+    # Execute a command on the database.
+    #
+    # @example Execute a command.
+    #   database.command(:ismaster => 1)
+    #
+    # @param [ Hash ] operation The command to execute.
+    # @param [ Hash ] opts The command options.
+    #
+    # @option opts :read [ Hash ] The read preference for this command.
+    #
+    # @return [ Hash ] The result of the command execution.
+    def command(operation, opts = {})
+      preference = opts[:read] ? ServerSelector.get(opts[:read], options) : read_preference
+      server = preference.select_server(cluster)
+      Operation::Command.new({
+        :selector => operation,
+        :db_name => name,
+        :options => { :limit => -1 },
+        :read => preference
+      }).execute(server.context)
+    end
+
+    # Drop the database and all its associated information.
+    #
+    # @example Drop the database.
+    #   database.drop
+    #
+    # @return [ Result ] The result of the command.
+    #
+    # @since 2.0.0
+    def drop
+      command(:dropDatabase => 1)
+    end
+
+    # Instantiate a new database object.
+    #
+    # @example Instantiate the database.
+    #   Mongo::Database.new(client, :test)
+    #
+    # @param [ Mongo::Client ] client The driver client.
+    # @param [ String, Symbol ] name The name of the database.
+    # @param [ Hash ] options The options.
+    #
+    # @raise [ Mongo::Database::InvalidName ] If the name is nil.
+    #
+    # @since 2.0.0
+    def initialize(client, name, options = {})
+      raise Error::InvalidDatabaseName.new unless name
+      @client = client
+      @name = name.to_s.freeze
+      @options = options.freeze
+    end
+
+    # Get a pretty printed string inspection for the database.
+    #
+    # @example Inspect the database.
+    #   database.inspect
+    #
+    # @return [ String ] The database inspection.
+    #
+    # @since 2.0.0
+    def inspect
+      "<Mongo::Database:0x#{object_id} name=#{name}>"
+    end
+
+    # Get the Grid "filesystem" for this database.
+    #
+    # @example Get the GridFS.
+    #   database.fs
+    #
+    # @return [ Grid::FS ] The GridFS for the database.
+    #
+    # @since 2.0.0
+    def fs(options = {})
+      Grid::FS.new(self, options)
+    end
+
+    # Get the user view for this database.
+    #
+    # @example Get the user view.
+    #   database.users
+    #
+    # @return [ View::User ] The user view.
+    #
+    # @since 2.0.0
+    def users
+      Auth::User::View.new(self)
+    end
+
+    # Create a database for the provided client, for use when we don't want the
+    # client's original database instance to be the same.
+    #
+    # @api private
+    #
+    # @example Create a database for the client.
+    #   Database.create(client)
+    #
+    # @param [ Client ] client The client to create on.
+    #
+    # @return [ Database ] The database.
+    #
+    # @since 2.0.0
+    def self.create(client)
+      database = Database.new(client, client.options[:database], client.options)
+      client.instance_variable_set(:@database, database)
+    end
+  end
+end

data/lib/mongo/database/view.rb

@@ -0,0 +1,101 @@
+# Copyright (C) 2014-2015 MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+  class Database
+
+    # A class representing a view of a database.
+    #
+    # @since 2.0.0
+    class View
+      extend Forwardable
+      include Enumerable
+
+      def_delegators :@database, :cluster, :read_preference
+      def_delegators :cluster, :next_primary
+
+      # @return [ Integer ] batch_size The size of the batch of results
+      #   when sending the listCollections command.
+      attr_reader :batch_size
+
+      # @return [ Integer ] limit The limit when sending a command.
+      attr_reader :limit
+
+      # @return [ Collection ] collection The command collection.
+      attr_reader :collection
+
+      # Get all the names of the non system collections in the database.
+      #
+      # @example Get the collection names.
+      #   database.collection_names
+      #
+      # @param [ Hash ] options Options for the listCollections command.
+      #
+      # @option options [ Integer ] :batch_size  The batch size for results
+      #   returned from the listCollections command.
+      #
+      # @return [ Array<String> ] The names of all non-system collections.
+      #
+      # @since 2.0.0
+      def collection_names(options = {})
+        @batch_size = options[:batch_size]
+        server = next_primary
+        collections_info(server).collect do |info|
+          server.context.features.list_collections_enabled? ?
+            info['name'] : info['name'].sub("#{@database.name}.", '')
+        end
+      end
+
+      # Create the new database view.
+      #
+      # @example Create the new database view.
+      #   View::Index.new(database)
+      #
+      # @param [ Database ] database The database.
+      #
+      # @since 2.0.0
+      def initialize(database)
+        @database = database
+        @batch_size =  nil
+        @limit = -1
+        @collection = @database[Database::COMMAND]
+      end
+
+      private
+
+      def collections_info(server, &block)
+        cursor = Cursor.new(self, send_initial_query(server), server).to_enum
+        cursor.each do |doc|
+          yield doc
+        end if block_given?
+        cursor
+      end
+
+      def collections_info_spec
+        { selector: {
+            listCollections: 1,
+            cursor: batch_size ? { batchSize: batch_size } : {} },
+          db_name: @database.name }
+      end
+
+      def initial_query_op
+        Operation::Read::CollectionsInfo.new(collections_info_spec)
+      end
+
+      def send_initial_query(server)
+        initial_query_op.execute(server.context)
+      end
+    end
+  end
+end

data/lib/mongo/error.rb

@@ -0,0 +1,81 @@
+# Copyright (C) 2014-2015 MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+  # Base error class for all Mongo related errors.
+  #
+  # @since 2.0.0
+  class Error < StandardError
+
+    # The error code field.
+    #
+    # @since 2.0.0
+    CODE = 'code'.freeze
+
+    # An error field, MongoDB < 2.6
+    #
+    # @since 2.0.0
+    ERR = '$err'.freeze
+
+    # An error field, MongoDB < 2.4
+    #
+    # @since 2.0.0
+    ERROR = 'err'.freeze
+
+    # The standard error message field, MongoDB 3.0+
+    #
+    # @since 2.0.0
+    ERRMSG = 'errmsg'.freeze
+
+    # The constant for the writeErrors array.
+    #
+    # @sicne 2.0.0
+    WRITE_ERRORS = 'writeErrors'.freeze
+
+    # The constant for write concern errors.
+    #
+    # @since 2.0.0
+    WRITE_CONCERN_ERROR = 'writeConcernError'.freeze
+
+    # Constant for an unknown error.
+    #
+    # @since 2.0.0
+    UNKNOWN_ERROR = 8.freeze
+
+    # Constant for a bad value error.
+    #
+    # @since 2.0.0
+    BAD_VALUE = 2.freeze
+  end
+end
+
+require 'mongo/error/parser'
+require 'mongo/error/bulk_write_failure'
+require 'mongo/error/operation_failure'
+require 'mongo/error/empty_batch'
+require 'mongo/error/invalid_bulk_operation'
+require 'mongo/error/invalid_collection_name'
+require 'mongo/error/invalid_database_name'
+require 'mongo/error/invalid_document'
+require 'mongo/error/invalid_file'
+require 'mongo/error/invalid_nonce'
+require 'mongo/error/invalid_replacement_document'
+require 'mongo/error/invalid_signature'
+require 'mongo/error/invalid_update_document'
+require 'mongo/error/max_bson_size'
+require 'mongo/error/max_message_size'
+require 'mongo/error/need_primary_server'
+require 'mongo/error/socket_error'
+require 'mongo/error/socket_timeout_error'
+require 'mongo/error/unsupported_features'

data/lib/mongo/error/bulk_write_failure.rb

@@ -0,0 +1,41 @@
+# Copyright (C) 2014-2015 MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+  class Error
+
+    # Exception raised if there are write errors upon executing the bulk
+    # operation.
+    #
+    # @since 2.0.0
+    class BulkWriteFailure < Error
+
+      # @return [ BSON::Document ] result The error result.
+      attr_reader :result
+
+      # Instantiate the new exception.
+      #
+      # @example Instantiate the exception.
+      #   Mongo::Error::BulkWriteFailure.new(response)
+      #
+      # @params [ Hash ] result A processed response from the server
+      #   reporting results of the operation.
+      #
+      # @since 2.0.0
+      def initialize(result)
+        @result = result
+      end
+    end
+  end
+end