Classe: Mongo::BulkWrite::Result

Herda:
Objeto
  • Objeto
mostrar tudo
Definido em:
lib/mongo/bulk_write/result.rb

Visão geral

Envolve uma série de operações de escrita em massa em um objeto de resultado.

Desde:

  • 2.0.6

Colapsode resumo constante

REMOVED_COUNT =

Constante para o número removido.

Desde:

  • 2.1.0

'n_removed'
INSERTED_COUNT =

Constante para o número inserido.

Desde:

  • 2.1.0

'n_inserted'
INSERTED_IDS =

Constante para IDs inseridos.

Desde:

  • 2.1.0

'insert_ids'
MATCHED_COUNT =

Constante para o número correspondido.

Desde:

  • 2.1.0

'n_matched'
ModIFIED_COUNT =

Constante para o número modificado.

Desde:

  • 2.1.0

'n_modified'
UPSERTED =

Constante para upserted.

Desde:

  • 2.1.0

'upserted'
upserted_count =

Constante para o número atualizado.

Desde:

  • 2.1.0

'n_upserted'
upserted_ids =

Constante para IDs atualizados.

Desde:

  • 2.1.0

'upserted_ids'
Campos =

Os campos contidos no documento de resultado retornaram da execução das operações.

Desde:

  • 2.1.0.

[
  INSERTED_COUNT,
  REMOVED_COUNT,
  ModIFIED_COUNT,
  upserted_count,
  MATCHED_COUNT,
  (operação)::Resultado::N
].congelar

Recolhimento do Resumo do método de instância

Detalhes do construtor

#inicializar(resultados, confirmados) ➤ Resultado

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Crie o novo objeto de resultado a partir do documento de resultados.

Exemplos:

Crie o novo resultado.

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

Parâmetros:

  • Resultados (BSON::Document, Hash) —

    O documento de resultados .

  • Reconhecido(a) (Booleano) —

    O resultado é reconhecido?

Desde:

  • 2.1.0



104
105
106
107
 
# File 'lib/mongo/bulk_write/result.rb', linha 104

def inicializar(Resultados, Reconhecido(a))
  @results = Resultados
  @knowledged = Reconhecido(a)
end

Detalhes do método de instância

#reconhecido? ➤ Booleano

Retorna O resultado é reconhecido?.

Retorna:

  • (Booleano) —

    O resultado é reconhecido?

Desde:

  • 2.0.6



24
25
26
 
# File 'lib/mongo/bulk_write/result.rb', linha 24

def reconhecido?
  @knowledged
end

#delete_count ➤ Inteiro

Retorna o número de documentos excluídos.

Exemplos:

Obtenha o número de documentos excluídos.

result.deleted_count

Retorna:

  • (Inteiro) —

    O número excluído.

Desde:

  • 2.1.0



89
90
91
 
# File 'lib/mongo/bulk_write/result.rb', linha 89

def delete_count
  @results[REMOVED_COUNT]
end

#inserted_count ⇒ Integer

Retorna o número de documentos inseridos.

Exemplos:

Obtenha o número de documentos inseridos.

result.inserted_count

Retorna:

  • (Inteiro) —

    O número inserido.

Desde:

  • 2.1.0



117
118
119
 
# File 'lib/mongo/bulk_write/result.rb', linha 117

def insert_count
  @results[INSERTED_COUNT]
end

#inserted_ids ⇒ Array<BSON::ObjectId>

Obtenha as IDs dos documentos inseridos, se a operação tiver inserções.

Exemplos:

Obtenha os IDs inseridos.

result.inserted_ids

Retorna:

  • (Array<BSON::ObjectId>) —

    Os IDs inseridos.

Desde:

  • 2.1.0



129
130
131
 
# File 'lib/mongo/bulk_write/result.rb', linha 129

def insert_ids
  @results[INSERTED_IDS]
end

#matched_count ➤ Inteiro

Retorna o número de documentos correspondentes.

Exemplos:

Obtenha o número de documentos correspondentes.

result.matched_count

Retorna:

  • (Inteiro) —

    O número corresponde.

Desde:

  • 2.1.0



141
142
143
 
# File 'lib/mongo/bulk_write/result.rb', linha 141

def matched_count
  @results[MATCHED_COUNT]
end

#modified_count ➤ Inteiro

Retorna o número de documentos modificados.

Exemplos:

Obtenha o número de documentos modificados.

result.modified_count

Retorna:

  • (Inteiro) —

    O número modificado.

Desde:

  • 2.1.0



153
154
155
 
# File 'lib/mongo/bulk_write/result.rb', linha 153

def modified_count
  @results[ModIFIED_COUNT]
end

#upserted_count ⇒ Integer

Retorna o número de documentos atualizados.

Exemplos:

Obtenha o número de documentos atualizados.

result.upserted_count

Retorna:

  • (Inteiro) —

    O número atualizado.

Desde:

  • 2.1.0



165
166
167
 
# File 'lib/mongo/bulk_write/result.rb', linha 165

def upserted_count
  @results[upserted_count]
end

#upserted_ids ➤ Array<BSON::ObjectId>

Obtenha as IDs de documento inseridos, se a operação tiver inserções.

Exemplos:

Obtenha os IDs atualizados.

result.upserted_ids

Retorna:

  • (Array<BSON::ObjectId>) —

    Os IDs atualizados.

Desde:

  • 2.1.0



177
178
179
 
# File 'lib/mongo/bulk_write/result.rb', linha 177

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

#validar! ➤ Resultado

Valida o resultado da gravação em massa.

Exemplos:

Valide o resultado.

result.validate!

Retorna:

Aumenta:

Desde:

  • 2.1.0



191
192
193
194
195
 
# File 'lib/mongo/bulk_write/result.rb', linha 191

def validar!
  aumentar Erro::BulkWriteError.Novo(@results) se @results['writeErrors'] || @results['writeConcernErrors']

  auto
end