Clase: Mongo::Database::CursorCommandView Privado

Hereda:

Objeto

• Objeto
• Mongo::Base de datos::CursorCommandView

Definido en:

lib/mongo/base de datos/cursor_command_view.rb

Overview

Esta clase forma parte de una API privada. Evita usar esta clase si es posible, ya que puede ser eliminada o modificada en el futuro.

La vista mínima que necesita un cursor cuando se compila a partir de una respuesta de comando arbitraria en lugar de una query de colección.

Contiene las opciones específicas de getMore (batchSize, maxTimeMS, comment) y el tipo de cursor y la moda de tiempo de espera, y da respuesta a los pocos métodos que el cursor lee desde su vista.

Desde:

• 2.0.0

Resumen de atributos de la instancia

• #database ⇒ Mongo::Database Solo lectura privado

  La base de datos en la que se ejecutó el comando.

• #options ⇒ Hash Solo lectura privado

  Las opciones de vista.

Resumen del método de instancia

• #batch_size ⇒ Integer | nil privado

  El batchSize enviado en los comandos getMore.

• #cliente ⇒ Mongo::Client privado

  El cliente.

• #colección ⇒ Mongo::Collection privado

  Una colección de marcadores de posición utilizada únicamente para que el cursor pueda llegar al cliente y a la base de datos.

• #cursor_type ⇒ Symbol | nil privado

  El tipo de cursor.

• #initialize(database, options = {}) ⇒ CursorCommandView constructor privado

  Una nueva instancia de CursorCommandView.

• #limit ⇒ Object privado

  Los cursores no admiten un límite cuando se compilan a partir de una respuesta de comando.

• #max_time_ms_for_get_more ⇒ Entero | nil privado

  El maxTimeMS enviado en los comandos getMore.

• #operation_timeouts(opciones = {}) ⇒ Hash privado

  Valores de tiempo de espera para el contexto de la operación.

• #timeout_mode ⇒ Symbol | nil privado

  El moda de tiempo de espera.

Detalles del Constructor

#initialize(database, options = {}) ⇒ CursorCommandView

Este método es parte de una API privada. Se debe evitar el uso de este método si es posible, ya que podría eliminarse o modificarse en el futuro.

Devuelve una nueva instancia de CursorCommandView.

Parámetros:

• database (Mongo::Database) —

  La base de datos en la que se ejecutó el comando.

• opciones (encriptada) (por defecto: {}) —

  Las opciones getMore y timeout.

Opciones Hash (options):

• :batch_size (Integer) —

  El batchSize para getMores.

• max_time_ms (Integer) —

  El maxTimeMS para getMores.

• :comment (objeto) —

  El comentario para getMores.

• tipo_de_cursor (Símbolo) —

  :tailable o :tailable_await.

• :timeout_mode (Símbolo) —

  :cursor_lifetime o :iteration.

Desde:

• 2.0.0

# Archivo 'lib/mongo/base de datos/cursor_command_view.rb', línea 36

def inicializar(database, opciones = {})
  @database = database
  @options = opciones
end

Detalles de atributo de instancias

#database ⇒ Mongo::Database (readonly)

Este método es parte de una API privada. Se debe evitar el uso de este método si es posible, ya que podría eliminarse o modificarse en el futuro.

Devuelve La base de datos en la que se ejecutó el comando.

Devuelve:

• (Mongo::Database) —

  La base de datos en la que se ejecutó el comando.

Desde:

• 2.0.0

# Archivo 'lib/mongo/base de datos/cursor_command_view.rb', línea 42

def database
  @database
end

#opciones ⇒ Hash (solo lectura)

Este método es parte de una API privada. Se debe evitar el uso de este método si es posible, ya que podría eliminarse o modificarse en el futuro.

Devuelve las opciones de vista. Utilizado por el cursor para leer el comentario getMore.

Devuelve:

• (encriptada) —

  Las opciones de vista. Utilizado por el cursor para leer el comentario getMore.

Desde:

• 2.0.0

# Archivo 'lib/mongo/base de datos/cursor_command_view.rb', línea 46

def opciones
  @options
end

Detalles del método de instancia

#batch_size ⇒ Integer | nil

Este método es parte de una API privada. Se debe evitar el uso de este método si es posible, ya que podría eliminarse o modificarse en el futuro.

Devuelve el batchSize enviado en los comandos getMore.

Devuelve:

• (Integer | nil) —

  El batchSize enviado en los comandos getMore.

Desde:

• 2.0.0

# Archivo 'lib/mongo/base de datos/cursor_command_view.rb', línea 63

def batch_size
  opciones[:batch_size]
end

#cliente ⇒ Mongo::Client

Este método es parte de una API privada. Se debe evitar el uso de este método si es posible, ya que podría eliminarse o modificarse en el futuro.

Devuelve El cliente.

Devuelve:

• (Mongo::cliente) —

  El cliente.

Desde:

• 2.0.0

# Archivo 'lib/mongo/base de datos/cursor_command_view.rb', línea 49

def Cliente
  database.Cliente
end

#colección ⇒ Mongo::Collection

Este método es parte de una API privada. Se debe evitar el uso de este método si es posible, ya que podría eliminarse o modificarse en el futuro.

Una colección de marcador de posición utilizada únicamente para que el cursor pueda llegar al cliente y a la base de datos. El namespace real para getMore y killCursors se toma de la respuesta del comando, no de esta colección.

Devuelve:

• (Mongo::Collection) —

  La colección pseudo $cmd.

Desde:

• 2.0.0

# Archivo 'lib/mongo/base de datos/cursor_command_view.rb', línea 58

def Colección
  @colección ||= Colección.Nuevo(database, '$cmd')
end

#cursor_type ⇒ Symbol | nil

Este método es parte de una API privada. Se debe evitar el uso de este método si es posible, ya que podría eliminarse o modificarse en el futuro.

Devuelve el tipo de cursor.

Devuelve:

• (Symbol | nil) —

  El tipo de cursor.

Desde:

• 2.0.0

# Archivo 'lib/mongo/base de datos/cursor_command_view.rb', línea 73

def cursor_type
  opciones[tipo_de_cursor]
end

#limit ⇒ Object

Este método es parte de una API privada. Se debe evitar el uso de este método si es posible, ya que podría eliminarse o modificarse en el futuro.

Los cursores no admiten un límite cuando se compilan a partir de una respuesta de comando.

Desde:

• 2.0.0

# Archivo 'lib/mongo/base de datos/cursor_command_view.rb', línea 90

def limit
  nulo
end

#max_time_ms_for_get_more ⇒ Integer | nil

Este método es parte de una API privada. Se debe evitar el uso de este método si es posible, ya que podría eliminarse o modificarse en el futuro.

Devuelve el maxTimeMS enviado en los comandos getMore.

Devuelve:

• (Integer | nil) —

  El maxTimeMS enviado en los comandos getMore.

Desde:

• 2.0.0

# Archivo 'lib/mongo/base de datos/cursor_command_view.rb', línea 68

def max_time_ms_for_get_more
  opciones[max_time_ms]
end

#operation_timeouts(opts = {}) ⇒ Hash

Este método es parte de una API privada. Se debe evitar el uso de este método si es posible, ya que podría eliminarse o modificarse en el futuro.

Devuelve los valores de tiempo de espera para el contexto de la operación.

Devuelve:

• (encriptada) —

  valores de tiempo de espera para el contexto de la operación.

Desde:

• 2.0.0

# Archivo 'lib/mongo/base de datos/cursor_command_view.rb', línea 83

def operation_timeouts(opciones = {})
  database.operation_timeouts(opciones)
end

#timeout_mode ⇒ Symbol | nil

Este método es parte de una API privada. Se debe evitar el uso de este método si es posible, ya que podría eliminarse o modificarse en el futuro.

Devuelve El modo de tiempo de espera.

Devuelve:

• (Symbol | nil) —

  El moda de tiempo de espera.

Desde:

• 2.0.0

# Archivo 'lib/mongo/base de datos/cursor_command_view.rb', línea 78

def timeout_mode
  opciones[:timeout_mode]
end