Classe: Mongo::BulkWrite::Result

Herda:
Objeto
  • Objeto
mostrar tudo
Definido em:
build/ruby-driver-v2.19/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'.congelar
INSERTED_COUNT =

Constante para o número inserido.

Desde:

  • 2.1.0

'n_inserted'.congelar
INSERTED_IDS =

Constante para IDs inseridos.

Desde:

  • 2.1.0

'inserted_ids'.congelar
MATCHED_COUNT =

Constante para o número correspondido.

Desde:

  • 2.1.0

'n_matched'.congelar
ModIFIED_COUNT =

Constante para o número modificado.

Desde:

  • 2.1.0

'n_modified'.congelar
UPSERTED =

Constante para upserted.

Desde:

  • 2.1.0

'upserted'.congelar
upserted_count =

Constante para o número atualizado.

Desde:

  • 2.1.0

'n_upserted'.congelar
upserted_ids =

Constante para IDs atualizados.

Desde:

  • 2.1.0

'upserted_ids'.congelar
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



107
108
109
110
# File 'build/ruby-driver-v2.19/lib/mongo/bulk_write/result.rb', linha 107

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



27
28
29
# File 'build/ruby-driver-v2.19/lib/mongo/bulk_write/result.rb', linha 27

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



92
93
94
# File 'build/ruby-driver-v2.19/lib/mongo/bulk_write/result.rb', linha 92

def delete_count
  @results[REMOVED_COUNT]
end

#inserted_countInteger

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



120
121
122
# File 'build/ruby-driver-v2.19/lib/mongo/bulk_write/result.rb', linha 120

def insert_count
  @results[INSERTED_COUNT]
end

#inserted_idsArray<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



132
133
134
# File 'build/ruby-driver-v2.19/lib/mongo/bulk_write/result.rb', linha 132

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



144
145
146
# File 'build/ruby-driver-v2.19/lib/mongo/bulk_write/result.rb', linha 144

def matched_count
  @results[MATCHED_COUNT]
end

#modified_countInteiro

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



156
157
158
# File 'build/ruby-driver-v2.19/lib/mongo/bulk_write/result.rb', linha 156

def modified_count
  @results[ModIFIED_COUNT]
end

#upserted_countInteger

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



168
169
170
# File 'build/ruby-driver-v2.19/lib/mongo/bulk_write/result.rb', linha 168

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



180
181
182
# File 'build/ruby-driver-v2.19/lib/mongo/bulk_write/result.rb', linha 180

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



194
195
196
197
198
199
200
# File 'build/ruby-driver-v2.19/lib/mongo/bulk_write/result.rb', linha 194

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