Class: Mongo::Database::View

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, Forwardable
Instance Chain: self, `::Mongo::Cursor::NonTailable`, `::Mongo::CursorHost`, `::Mongo::Retryable`, Enumerable
Inherits:	Object
Defined in:	lib/mongo/database/view.rb

Overview

A class representing a view of a database.

Since:

2.0.0

Class Method Summary

.new(database, options = {}) ⇒ View constructor

Create the new database view.

Instance Attribute Summary

#batch_size ⇒ Integer readonly
#collection ⇒ Collection readonly
#database readonly Internal use only Internal use only
#limit ⇒ Integer readonly
#operation_timeout_ms ⇒ Integer | nil | The timeout_ms value that was passed as an option to the view. readonly Internal use only Internal use only

`::Mongo::CursorHost` - Included

#cursor	Returns the cursor associated with this view, if any.
#timeout_mode

Instance Method Summary

#aggregate(pipeline, options = {}) ⇒ Collection::View::Aggregation Internal use only Internal use only

Execute an aggregation on the database view.
#collection_names(options = {}) ⇒ Array<String>

Get all the names of the non-system collections in the database.
#list_collections(options = {}) ⇒ Array<Hash>

Get info on all the collections in the database.
#operation_timeouts(opts = {}) ⇒ Hash Internal use only Internal use only
#timeout_ms ⇒ Integer | nil

The timeout_ms value to use for this operation; either specified as an option to the view, or inherited from the database.
#collections_info(session, server_selector, options = {}, &block) private
#collections_info_spec(session, options = {}) private
#initial_query_op(session, options = {}) private
#send_initial_query(server, session, context, options = {}) ⇒ Operation::Result private

Sends command that obtains information about the database.

`::Mongo::Cursor::NonTailable` - Included

#cursor_type	These views are always non-tailable.
#timeout_mode	These views apply timeouts to each iteration of a cursor, as opposed to the entire lifetime of the cursor.

`::Mongo::CursorHost` - Included

#validate_timeout_mode!

Ensure the timeout mode is appropriate for other options that have been given.

`::Mongo::Retryable` - Included

#read_worker	Returns the read worker for handling retryable reads.
#select_server	This is a separate method to make it possible for the test suite to assert that server selection is performed during retry attempts.
#write_worker	Returns the write worker for handling retryable writes.
#deprioritize_server?	Whether the failed server should be deprioritized during server selection for a retry attempt.

Constructor Details

.new(database, options = {}) ⇒ `View`

Create the new database view.

Examples:

Create the new database view.

Database::View.new(database)

Parameters:

database (Database) —

The database.
options (Hash) (defaults to: {}) —

The options to configure the view with.

Options Hash (options):

:timeout_mode (:cursor_lifetime | :iteration) —

How to interpret :timeout_ms (whether it applies to the lifetime of the cursor, or per iteration).
:timeout_ms (Integer) —

The operation timeout in milliseconds. Must be a non-negative integer. An explicit value of 0 means infinite. The default value is unset which means the value is inherited from the database or the client.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/database/view.rb', line 145


def initialize(database, options = {})
  @database = database
  @operation_timeout_ms = options.delete(:timeout_ms)

  validate_timeout_mode!(options)

  @batch_size =  nil
  @limit = nil
  @collection = @database[Database::COMMAND]
end

Instance Attribute Details

#batch_size ⇒ `Integer` (readonly)

Returns:

(Integer) —

batch_size The size of the batch of results when sending the listCollections command.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/database/view.rb', line 40


attr_reader :batch_size

#collection ⇒ Collection (readonly)

Returns:

(Collection) —

collection The command collection.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/database/view.rb', line 46


attr_reader :collection

#database (readonly)

This method is for internal use only.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/database/view.rb', line 157


attr_reader :database

#limit ⇒ `Integer` (readonly)

Returns:

(Integer) —

limit The limit when sending a command.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/database/view.rb', line 43


attr_reader :limit

#operation_timeout_ms ⇒ `Integer` | `nil` | `The` timeout_ms `value` `that` `was` `passed` `as` `an` `option` `to` `the` `view`. (readonly)

This method is for internal use only.

Returns:

(Integer | nil | The timeout_ms value that was passed as an option to the view.) —

Integer | nil | The timeout_ms value that was passed as an option to the view.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/database/view.rb', line 163


attr_reader :operation_timeout_ms

Instance Method Details

#aggregate(pipeline, options = {}) ⇒ Collection::View::Aggregation

This method is for internal use only.

Execute an aggregation on the database view.

Examples:

Aggregate documents.

view.aggregate([
  { "$listLocalSessions" => {} }
])

Parameters:

pipeline (Array<Hash>) —

The aggregation pipeline.
options (Hash) (defaults to: {}) —

The aggregation options.

Returns:

(Collection::View::Aggregation) —

The aggregation object.

Since:

2.10.0

[ GitHub ]

# File 'lib/mongo/database/view.rb', line 179


def aggregate(pipeline, options = {})
  Collection::View::Aggregation.new(self, pipeline, options)
end

#collection_names(options = {}) ⇒ `Array`<`String`>

Note:

The set of returned collection names depends on the version of MongoDB server that fulfills the request.

Get all the names of the non-system collections in the database.

See https://mongodb.com/docs/manual/reference/command/listCollections/
for more information and usage.

Parameters:

options (Hash) (defaults to: {}) —

::Mongo::Options for the listCollections command.

Options Hash (options):

:batch_size (Integer) —

The batch size for results returned from the listCollections command.
:filter (Hash) —

A filter on the collections returned.
:authorized_collections (true, false) —

A flag, when set to true, that allows a user without the required privilege to run the command when access control is enforced.
:comment (Object) —

A user-provided comment to attach to this command.
:timeout_ms (Integer) —

The operation timeout in milliseconds. Must be a non-negative integer. An explicit value of 0 means infinite. The default value is unset which means the value is inherited from the database or the client.
:session (Session) —

The session to use.

Returns:

(Array<String>) —

The names of all non-system collections.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/database/view.rb', line 77


def collection_names(options = {})
  @batch_size = options[:batch_size]
  session = client.get_session(options)
  context = Operation::Context.new(
    client: client,
    session: session,
    operation_timeouts: operation_timeouts(options)
  )

  cursor = read_with_retry_cursor(session, ServerSelector.primary, self, context: context) do |server|
    send_initial_query(server, session, context, options.merge(name_only: true))
  end

  cursor.map { |info| info['name'] }
        .reject { |name| name.start_with?('system.') || name.include?('$') }
end

#collections_info(session, server_selector, options = {}, &block) (private)

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/database/view.rb', line 206


def collections_info(session, server_selector, options = {}, &block)
  description = nil
  context = Operation::Context.new(
    client: client,
    session: session,
    operation_timeouts: operation_timeouts(options)
  )
  op = initial_query_op(session, options)
  tracer.trace_operation(op, context, op_name: 'listCollections') do
    cursor = read_with_retry_cursor(session, server_selector, self, context: context) do |server|
      # TODO take description from the connection used to send the query
      # once https://jira.mongodb.org/browse/RUBY-1601 is fixed.
      description = server.description
      send_initial_query(server, session, context, options)
    end

    # Filter out the system collections
    cursor.reject do |doc|
      doc['name'].start_with?('system.') || doc['name'].include?('$')
    end
  end
end

#collections_info_spec(session, options = {}) (private)

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/database/view.rb', line 229


def collections_info_spec(session, options = {})
  { selector: {
      listCollections: 1,
      cursor: batch_size ? { batchSize: batch_size } : {} },
    db_name: @database.name,
    session: session
  }.tap do |spec|
    spec[:selector][:nameOnly] = true if options[:name_only]
    spec[:selector][:filter] = options[:filter] if options[:filter]
    spec[:selector][:authorizedCollections] = true if options[:authorized_collections]
    spec[:comment] = options[:comment] if options[:comment]
  end
end

#initial_query_op(session, options = {}) (private)

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/database/view.rb', line 243


def initial_query_op(session, options = {})
  Operation::CollectionsInfo.new(collections_info_spec(session, options))
end

#list_collections(options = {}) ⇒ `Array`<`Hash`>

Note:

The set of collections returned, and the schema of the information hash per collection, depends on the MongoDB server version that fulfills the request.

Get info on all the collections in the database.

Examples:

Get info on each collection.

database.list_collections

Parameters:

options (Hash) (defaults to: {})

Options Hash (options):

:filter (Hash) —

A filter on the collections returned.
:name_only (true, false) —

Indicates whether command should return just collection/view names and type or return both the name and other information
:authorized_collections (true, false) —

A flag, when set to true and used with nameOnly: true, that allows a user without the required privilege to run the command when access control is enforced

See mongodb.com/docs/manual/reference/command/listCollections/ for more information and usage.
:session (Session) —

The session to use.
:deserialize_as_bson (Boolean) —

Whether to deserialize this message using BSON types instead of native Ruby types wherever possible.

Returns:

(Array<Hash>) —

Info for each collection in the database.

Since:

2.0.5

[ GitHub ]

# File 'lib/mongo/database/view.rb', line 123


def list_collections(options = {})
  session = client.get_session(options)
  collections_info(session, ServerSelector.primary, options)
end

#operation_timeouts(opts = {}) ⇒ `Hash`

This method is for internal use only.

Returns:

(Hash) —

timeout_ms value set on the operation level (if any).

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/database/view.rb', line 194


def operation_timeouts(opts = {})
  {}.tap do |result|
    if opts[:timeout_ms] || operation_timeout_ms
      result[:operation_timeout_ms] = opts.delete(:timeout_ms) || operation_timeout_ms
    else
      result[:inherited_timeout_ms] = database.timeout_ms
    end
  end
end

#send_initial_query(server, session, context, options = {}) ⇒ Operation::Result (private)

Sends command that obtains information about the database.

This command returns a cursor, so there could be additional commands, therefore this method is called send initial command.

Parameters:

server (Server) —

::Mongo::Server to send the query to.
session (Session) —

::Mongo::Session that should be used to send the query.
options (Hash) (defaults to: {})

Options Hash (options):

:filter (Hash | nil) —

A query expression to filter the list of collections.
:name_only (true | false | nil) —

A flag to indicate whether the command should return just the collection/view names and type or return both the name and other information.
:authorized_collections (true | false | nil) —

A flag, when set to true and used with name_only: true, that allows a user without the required privilege (i.e. listCollections action on the database) to run the command when access control is enforced.
:comment (Object | nil) —

A user-provided comment to attach to this command.
:deserialize_as_bson (true | false | nil) —

Whether the query results should be deserialized to BSON types, or to Ruby types (where possible).

Returns:

(Operation::Result) —

Result of the query.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/database/view.rb', line 272


def send_initial_query(server, session, context, options = {})
  opts = options.dup
  execution_opts = {}
  if opts.key?(:deserialize_as_bson)
    execution_opts[:deserialize_as_bson] = opts.delete(:deserialize_as_bson)
  end
  if server.load_balancer?
    connection = server.pool.check_out(context: context)
    initial_query_op(session, opts).execute_with_connection(
      connection,
      context: context,
      options: execution_opts
    )
  else
    initial_query_op(session, opts).execute(
      server,
      context: context,
      options: execution_opts
    )
  end
end

#timeout_ms ⇒ `Integer` | `nil`

The timeout_ms value to use for this operation; either specified as an option to the view, or inherited from the database.

Returns:

(Integer | nil) —

the timeout_ms for this operation

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/database/view.rb', line 187


def timeout_ms
  operation_timeout_ms || database.timeout_ms
end

Class: Mongo::Database::View

Overview

Class Method Summary

Instance Attribute Summary

::Mongo::CursorHost - Included

Instance Method Summary

::Mongo::Cursor::NonTailable - Included

::Mongo::CursorHost - Included

::Mongo::Retryable - Included

Constructor Details

.new(database, options = {}) ⇒ View

Instance Attribute Details

#batch_size ⇒ Integer (readonly)

#collection ⇒ Collection (readonly)

#database (readonly)

#limit ⇒ Integer (readonly)

#operation_timeout_ms ⇒ Integer | nil | The timeout_ms value that was passed as an option to the view. (readonly)

Instance Method Details

#aggregate(pipeline, options = {}) ⇒ Collection::View::Aggregation

#collection_names(options = {}) ⇒ Array<String>

#collections_info(session, server_selector, options = {}, &block) (private)

#collections_info_spec(session, options = {}) (private)

#initial_query_op(session, options = {}) (private)

#list_collections(options = {}) ⇒ Array<Hash>

#operation_timeouts(opts = {}) ⇒ Hash

#send_initial_query(server, session, context, options = {}) ⇒ Operation::Result (private)

#timeout_ms ⇒ Integer | nil

`::Mongo::CursorHost` - Included

`::Mongo::Cursor::NonTailable` - Included

`::Mongo::CursorHost` - Included

`::Mongo::Retryable` - Included

.new(database, options = {}) ⇒ `View`

#batch_size ⇒ `Integer` (readonly)

#limit ⇒ `Integer` (readonly)

#operation_timeout_ms ⇒ `Integer` | `nil` | `The` timeout_ms `value` `that` `was` `passed` `as` `an` `option` `to` `the` `view`. (readonly)

#collection_names(options = {}) ⇒ `Array`<`String`>

#list_collections(options = {}) ⇒ `Array`<`Hash`>

#operation_timeouts(opts = {}) ⇒ `Hash`

#timeout_ms ⇒ `Integer` | `nil`