File: collections_info.rb

package info (click to toggle)
ruby-mongo 2.5.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 4,332 kB
  • sloc: ruby: 45,579; makefile: 5
file content (71 lines) | stat: -rw-r--r-- 2,189 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
# 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.

require 'mongo/operation/commands/collections_info/result'

module Mongo
  module Operation
    module Commands

      # A MongoDB operation to get a list of collections info in a database.
      #
      # @example Create the collections info operation.
      #   CollectionsInfo.new(:db_name => 'test-db')
      #
      # Initialization:
      #   param [ Hash ] spec The specifications for the collections info operation.
      #
      #   option spec :db_name [ String ] The name of the database whose collections
      #     info is requested.
      #   option spec :options [ Hash ] Options for the operation.
      #
      # @since 2.0.0
      class CollectionsInfo
        include Specifiable
        include ReadPreference
        include Executable

        # Execute the operation.
        #
        # @example Execute the operation.
        #   operation.execute(server)
        #
        # @param [ Mongo::Server ] server The server to send this operation to.
        #
        # @return [ Result ] The operation response, if there is one.
        #
        # @since 2.0.0
        def execute(server)
          if server.features.list_collections_enabled?
            ListCollections.new(spec).execute(server)
          else
            server.with_connection do |connection|
              Result.new(connection.dispatch([ message(server) ])).validate!
            end
          end
        end

        private

        def selector
          { :name => { '$not' => /system\.|\$/ } }
        end

        def query_coll
          Database::NAMESPACES
        end
      end
    end
  end
end