Clase: Mongo::BulkWrite::Result

Hereda:
Objeto
  • Objeto
Mostrar todo
Definido en:
lib/mongo/bulk_write/result.rb

Overview

Envuelve una serie de operaciones de escritura masiva en un objeto de resultado.

Desde:

  • 2.0.6

Resumen de constantes colapsar

REMOVED_COUNT =

Constante para número eliminado.

Desde:

  • 2.1.0

'n_removed'
INSERTED_COUNT =

Constante para número insertado.

Desde:

  • 2.1.0

'n_inserted'
INSERTED_IDS =

Constante para identificadores insertados.

Desde:

  • 2.1.0

'inserted_ids'
MATCHED_COUNT =

Constante para número correspondiente.

Desde:

  • 2.1.0

'n_matched'
MODIFIED_COUNT =

Constante para número modificado.

Desde:

  • 2.1.0

'n_modificado'
UPSERTADO =

Constante para la inserción o actualización.

Desde:

  • 2.1.0

'insertado o actualizado'
UPSERTED_COUNT =

Constante para el número actualizado.

Desde:

  • 2.1.0

'n_modificados'
UPSERTED_IDS =

Constante para los ID upserted.

Desde:

  • 2.1.0

'upserted_ids'
campo =

Los campos contenidos en el documento de resultados devuelto tras ejecutar las operaciones.

Desde:

  • 2.1.0.

[
  INSERTED_COUNT,
  REMOVED_COUNT,
  MODIFIED_COUNT (NÚMERO_MODIFICADO),
  UPSERTED_COUNT,
  MATCHED_COUNT,
  Operación::Resultado::N
].freeze

Resumen del método de instancia colapsar

Detalles del Constructor

#initialize(results, acknowledged) ⇒ Result

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.

Crea el nuevo objeto de resultados a partir del documento de resultados.

Ejemplos:

Crear el nuevo resultado.

Result.new({ 'n_inserted' => 10 })

Parámetros:

  • Resultados (BSON::documento, Hash) —

    El documento de resultados.

  • reconocido (booleano) —

    ¿Se reconoce el resultado?

Desde:

  • 2.1.0



104
105
106
107
 
# Archivo 'lib/mongo/bulk_write/result.rb', línea 104

def inicializar(Resultados, reconocido)
  @results = Resultados
  @aceptado = reconocido
end

Detalles del método de instancia

#¿acknowledged? ⇒ booleano

Devoluciones ¿Se reconoce el resultado?

Devuelve:

  • (booleano) —

    ¿Se reconoce el resultado?

Desde:

  • 2.0.6



24
25
26
 
# Archivo 'lib/mongo/bulk_write/result.rb', línea 24

def ¿entendido?
  @aceptado
end

#deleted_count ⇒ Integer

Devuelve el número de documentos eliminados.

Ejemplos:

Obtén el número de documentos borrados.

result.deleted_count

Devuelve:

  • (Número entero) —

    El número fue eliminado.

Desde:

  • 2.1.0



89
90
91
 
# Archivo 'lib/mongo/bulk_write/result.rb', línea 89

def deleted_count
  @results[REMOVED_COUNT]
end

#inserted_count ⇒ Integer

Devuelve el número de documentos insertados.

Ejemplos:

Obtener el número de documentos insertados.

result.inserted_count

Devuelve:

  • (Número entero) —

    El número insertado.

Desde:

  • 2.1.0



117
118
119
 
# Archivo 'lib/mongo/bulk_write/result.rb', línea 117

def inserted_count
  @results[INSERTED_COUNT]
end

#inserted_ids ⇒ Array<BSON::ObjectId>

Obtiene los ID de los documentos insertados, si la operación incluye inserciones.

Ejemplos:

Obtenga los IDs insertados.

result.inserted_ids

Devuelve:

  • (arreglo<BSON::ObjectId>) —

    Los ids insertados.

Desde:

  • 2.1.0



129
130
131
 
# Archivo 'lib/mongo/bulk_write/result.rb', línea 129

def inserted_ids
  @results[INSERTED_IDS]
end

#matched_count ⇒ Integer

Devuelve el número de documentos que coinciden.

Ejemplos:

Obtén el número de documentos coincidentes.

result.matched_count

Devuelve:

  • (Número entero) —

    El número coincidió.

Desde:

  • 2.1.0



141
142
143
 
# Archivo 'lib/mongo/bulk_write/result.rb', línea 141

def matched_count
  @results[MATCHED_COUNT]
end

#modified_count ⇒ Integer

Devuelve el número de documentos modificados.

Ejemplos:

Obtenga el número de documentos modificados.

result.modified_count

Devuelve:

  • (Número entero) —

    El número modificado.

Desde:

  • 2.1.0



153
154
155
 
# Archivo 'lib/mongo/bulk_write/result.rb', línea 153

def modified_count
  @results[MODIFIED_COUNT (NÚMERO_MODIFICADO)]
end

#upserted_count ⇒ Integer

Devuelve el número de documentos actualizados insertando (upserted).

Ejemplos:

Obtén el número de documentos actualizados o insertados.

result.upserted_count

Devuelve:

  • (Número entero) —

    El número actualizado.

Desde:

  • 2.1.0



165
166
167
 
# Archivo 'lib/mongo/bulk_write/result.rb', línea 165

def upserted_count
  @results[UPSERTED_COUNT]
end

#upserted_ids ⇒ Array<BSON::ObjectId>

Obtenga los ID de documentos insertados o actualizados, si la operación tiene inserciones.

Ejemplos:

Obtén los identificadores insertados/actualizados.

result.upserted_ids

Devuelve:

  • (arreglo<BSON::ObjectId>) —

    Los identificadores upsertados.

Desde:

  • 2.1.0



177
178
179
 
# Archivo 'lib/mongo/bulk_write/result.rb', línea 177

def upserted_ids
  @results[UPSERTED_IDS] || []
end

#validate! ⇒ Result

Valida el resultado de guardado masivo.

Ejemplos:

Valida el resultado.

result.validate!

Devuelve:

Aumenta:

Desde:

  • 2.1.0



191
192
193
194
195
 
# Archivo 'lib/mongo/bulk_write/result.rb', línea 191

def validate!
  propagar Error::BulkWriteError.Nuevo(@results) si @results['writeErrors'] || @results['writeConcernErrors']

  sí mismo
end