Contents

# Copyright (C) 2014-2017 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
  module Operation
    module Commands

      # A MongoDB listIndexes command operation.
      #
      # @example Create the listIndexes command operation.
      #   ListIndexes.new({ db_name: 'test', coll_name: 'example' })
      #
      # @note A command is actually a query on the virtual '$cmd' collection.
      #
      # Initialization:
      #   param [ Hash ] spec The specifications for the command.
      #
      #   option spec :coll_name [ Hash ] The name of the collection whose index
      #     info is requested.
      #   option spec :db_name [ String ] The name of the database on which
      #     the command should be executed.
      #   option spec :options [ Hash ] Options for the command.
      #
      # @since 2.0.0
      class ListIndexes < Command

        private

        def selector
          (spec[SELECTOR] || {}).merge(listIndexes: coll_name)
        end
      end
    end
  end
end

require 'mongo/operation/commands/list_indexes/result'

Version data entries

4 entries across 4 versions & 2 rubygems

Version	Path
tdiary-5.0.8	vendor/bundle/gems/mongo-2.5.1/lib/mongo/operation/commands/list_indexes.rb
mongo-2.5.1	lib/mongo/operation/commands/list_indexes.rb
mongo-2.5.0	lib/mongo/operation/commands/list_indexes.rb
mongo-2.5.0.beta	lib/mongo/operation/commands/list_indexes.rb