モジュール: Mongo::Collection::View::Writable

次のドキュメントに含まれます。
Mongo::Collection::View
定義:
build/ruby-Driver-v 2.19 /lib/mongo/collection/view/writetable.rb

Overview

コレクション ビューの書込み関連の動作を定義します。

以来

  • 2.0.0

定数の概要の削減

Array_Filters =

配列フィルター フィールド定数。

以来

  • 2.5.0

' array_filters '.freeze

インスタンス メソッドの概要を折りたたむ

インスタンス メソッドの詳細

delete_many (opts = {}) = 結果 =結果

コレクションからドキュメントを削除します。

例:

コレクションから複数のドキュメントを削除します。

collection_view.delete_many

パラメーター:

  • ops （ハッシュ） （デフォルトは{}です） —

    オプション。

  • options （ハッシュ） —

    カスタマイズ可能なオプションのセット

オプション ハッシュ（ opts ）:

  • :collation （ハッシュ） —

    使用する照合。

  • :session （セッション） —

    使用するセッション。

  • :hint （ハッシュ | string ） —

    この操作に使用するインデックス。 ハッシュ（例: { _id : 1 } またはstring （例: ID ）。

  • :write_concern （ハッシュ） —

    書込み保証（write concern） オプション。 :w => 整数、 :fsync => ブール値、 :j => ブール値 になります。

次の値を返します。

  • （結果） —

    データベースからの応答。

以来

  • 2.0.0



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/writetable.rb', 行231

デフォルト delete_many(ops = {})
  with_session(ops) 行う |セッション|
    write_concern = 場合 ops[:write_concern]
      WriteConcern.得る(ops[:write_concern])
    else
      write_concern_with_session(セッション)
    end

    クエリ キャッシュ.clear_namespace(コレクション.namespace)

    delete_doc = {
      操作::q => フィルター,
      操作::LIMIT => 0,
      hint: ops[:hint],
      collation: ops[:collation] || ops[「照合」] || collation,
    }.compact

    context = 操作::Context.新着情報(クライアント: クライアント, セッション: セッション)
    nro_write_with_retry(write_concern, context: context) 行う |接続, txn_num, context|
      gte_4_4 = 接続.サーバー.説明.server_version_gte?('4.4')
      場合 !gte_4_4 & & ops[:hint] & & write_concern & & !write_concern.確認済み?
        発生 エラー::UnsupportedOption.hint_error(unacknowledged_write: true)
      end

      操作::削除.新着情報(
        次の値を削除します。 [ delete_doc ],
        db_name: コレクション.database.name,
        coll_name: コレクション.name,
        write_concern: write_concern,
        bypass_document_validation: !!ops[:bypass_document_validation],
        セッション: セッション,
        let: ops[:let],
        comment: ops[:comment],
      ).execution_with_ connection(接続, context: context)
    end
  end
end

# delete_one (ops = {}) =結果

コレクションからドキュメントを削除します。

例:

コレクションから単一のドキュメントを削除します。

collection_view.delete_one

パラメーター:

  • ops （ハッシュ） （デフォルトは{}です） —

    オプション。

  • options （ハッシュ） —

    カスタマイズ可能なオプションのセット

オプション ハッシュ（ opts ）:

  • :collation （ハッシュ） —

    使用する照合。

  • :session （セッション） —

    使用するセッション。

  • :hint （ハッシュ | string ） —

    この操作に使用するインデックス。 ハッシュ（例: { _id : 1 } またはstring （例: ID ）。

  • :write_concern （ハッシュ） —

    書込み保証（write concern） オプション。 :w => 整数、 :fsync => ブール値、 :j => ブール値 になります。

次の値を返します。

  • （結果） —

    データベースからの応答。

以来

  • 2.0.0



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/writetable.rb', 行290

デフォルト delete_one(ops = {})
  with_session(ops) 行う |セッション|
    write_concern = 場合 ops[:write_concern]
      WriteConcern.得る(ops[:write_concern])
    else
      write_concern_with_session(セッション)
    end

    クエリ キャッシュ.clear_namespace(コレクション.namespace)

    delete_doc = {
      操作::q => フィルター,
      操作::LIMIT => 1,
      hint: ops[:hint],
      collation: ops[:collation] || ops[「照合」] || collation,
    }.compact

    context = 操作::Context.新着情報(クライアント: クライアント, セッション: セッション)
    write_with_retry(write_concern, context: context) 行う |接続, txn_num, context|
      gte_4_4 = 接続.サーバー.説明.server_version_gte?('4.4')
      場合 !gte_4_4 & & ops[:hint] & & write_concern & & !write_concern.確認済み?
        発生 エラー::UnsupportedOption.hint_error(unacknowledged_write: true)
      end

      操作::削除.新着情報(
        次の値を削除します。 [ delete_doc ],
        db_name: コレクション.database.name,
        coll_name: コレクション.name,
        write_concern: write_concern,
        bypass_document_validation: !!ops[:bypass_document_validation],
        セッション: セッション,
        txn_num: txn_num,
        let: ops[:let],
        comment: ops[:comment],
      ).execution_with_ connection(接続, context: context)
    end
  end
end

#find_one_and_delete(opts = {}) ⇒ BSON::Document?

findAndModify 経由でデータベース内の単一のドキュメントを検索し、削除し、元のドキュメントを返します。

例:

1 つのドキュメントを検索して削除します。

view.find_one_and_delete

パラメーター:

  • ops （ハッシュ） （デフォルトは{}です） —

    オプション。

  • options （ハッシュ） —

    カスタマイズ可能なオプションのセット

オプション ハッシュ（ opts ）:

  • :max_time_ms （整数） —

    コマンドの実行を許可する最大時間（ミリ秒単位）。

  • :プロジェクション （ハッシュ） —

    返されるドキュメントに含める、または除外するフィールド。

  • :sort （ハッシュ） —

    結果セットがソートされるキーと方向のペア。

  • :collation （ハッシュ） —

    使用する照合。

  • :session （セッション） —

    使用するセッション。

  • :hint （ハッシュ | string ） —

    この操作に使用するインデックス。 ハッシュ（例: { _id : 1 } またはstring （例: ID ）。

  • :write_concern （ハッシュ） —

    書込み保証（write concern） オプション。 :w => 整数、 :fsync => ブール値、 :j => ブール値 になります。

次の値を返します。

  • (BSON::Document, nil) —

    ドキュメント（見つかった場合）。

以来

  • 2.0.0



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/writetable.rb', 行59

デフォルト find_one_and_delete(ops = {})
  with_session(ops) 行う |セッション|
    write_concern = 場合 ops[:write_concern]
      WriteConcern.得る(ops[:write_concern])
    else
      write_concern_with_session(セッション)
    end

    クエリ キャッシュ.clear_namespace(コレクション.namespace)

    cmd = {
      findAndModify: コレクション.name,
      query: フィルター,
      以下を削除します。 true,
      フィールド: プロジェクション,
      sort: sort,
      maxTimeMS: max_time_ms,
      bypassDocumentValidation: ops[:bypass_document_validation],
      hint: ops[:hint],
      collation: ops[:collation] || ops[「照合」] || collation,
      let: ops[:let],
      comment: ops[:comment],
    }.compact

    context = 操作::Context.新着情報(クライアント: クライアント, セッション: セッション)
    write_with_retry(write_concern, context: context) 行う |接続, txn_num, context|
      gte_4_4 = 接続.サーバー.説明.server_version_gte?('4.4')
      場合 !gte_4_4 & & ops[:hint] & & write_concern & & !write_concern.確認済み?
        発生 エラー::UnsupportedOption.hint_error(unacknowledged_write: true)
      end

      操作::WriteCommand.新着情報(
        セレクター: cmd,
        db_name: database.name,
        write_concern: write_concern,
        セッション: セッション,
        txn_num: txn_num,
      ).execution_with_ connection(接続, context: context)
    end
  end.最初に&.fetch('value', nil)
end

# find_one_and_replace （置換、opts = {{}） = BSON::Document

1 つのドキュメントを検索して置き換えます。

例:

ドキュメントを検索して置き換え、元のドキュメントを返します。

view.find_one_and_replace({ name: 'test' }, :return_document => :before)

ドキュメントを検索して置き換え、新しいドキュメントを返します。

view.find_one_and_replace({ name: 'test' }, :return_document => :after)

パラメーター:

  • replacement （ BSON::Document ） —

    置換。

  • ops （ハッシュ） （デフォルトは{}です） —

    オプション。

  • options （ハッシュ） —

    カスタマイズ可能なオプションのセット

オプション ハッシュ（ opts ）:

  • :return_document （記号） —

    : 前 または : 後 。

  • :upsert （ true 、 false ） —

    ドキュメントが存在しない場合にアップサートを実行するかどうか。

  • :bypass_document_validation （ true 、 false ） —

    ドキュメント レベルの検証をスキップするかどうか。

  • :collation （ハッシュ） —

    使用する照合。

  • :hint （ハッシュ | string ） —

    この操作に使用するインデックス。 ハッシュ（例: { _id : 1 } またはstring （例: ID ）。

  • :write_concern （ハッシュ） —

    書込み保証（write concern） オプション。 :w => 整数、 :fsync => ブール値、 :j => ブール値 になります。

次の値を返します。

  • （ BSON::Document ） —

    ドキュメント。

以来

  • 2.0.0



127
128
129
 
ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/writetable.rb', 行127

デフォルト find_one_and_replace(replacement, ops = {})
  find_one_and_update(replacement, ops)
end

#find_one_and_update(document, opts = {}) ⇒ BSON::Document | nil

1 つのドキュメントを検索してアップデートします。

更新を適用する必要があります。

例:

ドキュメントを検索して更新し、元のドキュメントを返します。

view.find_one_and_update({ "$set" => { name: 'test' }}, :return_document => :before)

パラメーター:

  • ドキュメント （ BSON::Document ） —

    の更新。

  • ops （ハッシュ） （デフォルトは{}です） —

    オプション。

  • options （ハッシュ） —

    カスタマイズ可能なオプションのセット

オプション ハッシュ（ opts ）:

  • :プロジェクション （ハッシュ） —

    返されるドキュメントに含める、または除外するフィールド。

  • :sort （ハッシュ） —

    結果セットがソートされるキーと方向のペア。

  • :return_document （記号） —

    : 前 または : 後 。

  • :upsert （ true 、 false ） —

    ドキュメントが存在しない場合にアップサートを実行するかどうか。

  • :bypass_document_validation （ true 、 false ） —

    ドキュメント レベルの検証をスキップするかどうか。

  • :collation （ハッシュ） —

    使用する照合。

  • :array_filters （配列） —

    どの配列要素を指定するフィルターのセット

  • :session （セッション） —

    使用するセッション。

  • :hint （ハッシュ | string ） —

    この操作に使用するインデックス。 ハッシュ（例: { _id : 1 } またはstring （例: ID ）。

  • :write_concern （ハッシュ） —

    書込み保証（write concern） オプション。 :w => 整数、 :fsync => ブール値、 :j => ブール値 になります。

次の値を返します。

  • (BSON::Document | nil) —

    ドキュメントが見つからない場合は nil です。

以来

  • 2.0.0



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/writetable.rb', 行164

デフォルト find_one_and_update(ドキュメント, ops = {})
  価値 = with_session(ops) 行う |セッション|
    write_concern = 場合 ops[:write_concern]
      WriteConcern.得る(ops[:write_concern])
    else
      write_concern_with_session(セッション)
    end

    クエリ キャッシュ.clear_namespace(コレクション.namespace)

    cmd = {
      findAndModify: コレクション.name,
      query: フィルター,
      arrayFilters: ops[:array_filters] || ops[' array_filters '],
      update: ドキュメント,
      フィールド: プロジェクション,
      sort: sort,
      new: !!(ops[:return_document] & & ops[:return_document] == : after),
      アップサート: ops[:upsert],
      maxTimeMS: max_time_ms,
      bypassDocumentValidation: ops[:bypass_document_validation],
      hint: ops[:hint],
      collation: ops[:collation] || ops[「照合」] || collation,
      let: ops[:let],
      comment: ops[:comment]
    }.compact

    context = 操作::Context.新着情報(クライアント: クライアント, セッション: セッション)
    write_with_retry(write_concern, context: context) 行う |接続, txn_num, context|
      gte_4_4 = 接続.サーバー.説明.server_version_gte?('4.4')
      場合 !gte_4_4 & & ops[:hint] & & write_concern & & !write_concern.確認済み?
        発生 エラー::UnsupportedOption.hint_error(unacknowledged_write: true)
      end

      操作::WriteCommand.新着情報(
        セレクター: cmd,
        db_name: database.name,
        write_concern: write_concern,
        セッション: セッション,
        txn_num: txn_num,
      ).execution_with_ connection(接続, context: context)
    end
  end.最初に&.fetch('value', nil)
  価値 ただし、 価値.nil? || 価値.空の場合
end

# replace_one (置換, opts = {}) =結果

データベース内の単一のドキュメントを新しいドキュメントに置き換えます。

例:

単一のドキュメントを置き換えます。

collection_view.replace_one({ name: 'test' })

パラメーター:

  • replacement （ハッシュ） —

    置換ドキュメントです。

  • ops （ハッシュ） （デフォルトは{}です） —

    オプション。

  • options （ハッシュ） —

    カスタマイズ可能なオプションのセット

オプション ハッシュ（ opts ）:

  • :upsert （ true 、 false ） —

    ドキュメントが存在しない場合にアップサートを実行するかどうか。

  • :bypass_document_validation （ true 、 false ） —

    ドキュメント レベルの検証をスキップするかどうか。

  • :collation （ハッシュ） —

    使用する照合。

  • :session （セッション） —

    使用するセッション。

  • :hint （ハッシュ | string ） —

    この操作に使用するインデックス。 ハッシュ（例: { _id : 1 } またはstring （例: ID ）。

  • :write_concern （ハッシュ） —

    書込み保証（write concern） オプション。 :w => 整数、 :fsync => ブール値、 :j => ブール値 になります。

次の値を返します。

  • （結果） —

    データベースからの応答。

以来

  • 2.0.0



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/writetable.rb', 行355

デフォルト replace_one(replacement, ops = {})
  with_session(ops) 行う |セッション|
    write_concern = 場合 ops[:write_concern]
      WriteConcern.得る(ops[:write_concern])
    else
      write_concern_with_session(セッション)
    end
    validate_replacement_documents(replacement)

    クエリ キャッシュ.clear_namespace(コレクション.namespace)

    update_doc = {
      操作::q => フィルター,
      arrayFilters: ops[:array_filters] || ops[' array_filters '],
      操作::U => replacement,
      hint: ops[:hint],
      collation: ops[:collation] || ops[「照合」] || collation,
    }.compact
    場合 ops[:upsert]
      update_doc['upsert'] = true
    end

    context = 操作::Context.新着情報(クライアント: クライアント, セッション: セッション)
    write_with_retry(write_concern, context: context) 行う |接続, txn_num, context|
      gte_4_2 = 接続.サーバー.説明.server_version_gte?('4.2')
      場合 !gte_4_2 & & ops[:hint] & & write_concern & & !write_concern.確認済み?
        発生 エラー::UnsupportedOption.hint_error(unacknowledged_write: true)
      end

      操作::Update.新着情報(
        updates: [ update_doc ],
        db_name: コレクション.database.name,
        coll_name: コレクション.name,
        write_concern: write_concern,
        bypass_document_validation: !!ops[:bypass_document_validation],
        セッション: セッション,
        txn_num: txn_num,
        let: ops[:let],
        comment: ops[:comment],
      ).execution_with_ connection(接続, context: context)
    end
  end
end

# update_many (spec, opts = {}) =結果

コレクション内のドキュメントを更新します。

例:

コレクション内の複数のドキュメントを更新します。

collection_view.update_many('$set' => { name: 'test' })

パラメーター:

  • スペック （ハッシュ | 配列 <Hash> ） —

    更新ドキュメントまたはパイプライン。

  • ops （ハッシュ） （デフォルトは{}です） —

    オプション。

  • options （ハッシュ） —

    カスタマイズ可能なオプションのセット

オプション ハッシュ（ opts ）:

  • :upsert （ true 、 false ） —

    ドキュメントが存在しない場合にアップサートを実行するかどうか。

  • :bypass_document_validation （ true 、 false ） —

    ドキュメント レベルの検証をスキップするかどうか。

  • :collation （ハッシュ） —

    使用する照合。

  • :array_filters （配列） —

    アップデートを適用する配列要素を指定するフィルターのセット。

  • :session （セッション） —

    使用するセッション。

  • :hint （ハッシュ | string ） —

    この操作に使用するインデックス。 ハッシュ（例: { _id : 1 } またはstring （例: ID ）。

  • :write_concern （ハッシュ） —

    書込み保証（write concern） オプション。 :w => 整数、 :fsync => ブール値、 :j => ブール値 になります。

次の値を返します。

  • （結果） —

    データベースからの応答。

以来

  • 2.0.0



427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/writetable.rb', 行427

デフォルト update_many(スペック, ops = {})
  with_session(ops) 行う |セッション|
    write_concern = 場合 ops[:write_concern]
      WriteConcern.得る(ops[:write_concern])
    else
      write_concern_with_session(セッション)
    end
    validate_update_documents!(スペック)

    クエリ キャッシュ.clear_namespace(コレクション.namespace)

    update_doc = {
      操作::q => フィルター,
      arrayFilters: ops[:array_filters] || ops[' array_filters '],
      操作::U => スペック,
      操作::multi => true,
      hint: ops[:hint],
      collation: ops[:collation] || ops[「照合」] || collation,
    }.compact
    場合 ops[:upsert]
      update_doc['upsert'] = true
    end

    context = 操作::Context.新着情報(クライアント: クライアント, セッション: セッション)
    nro_write_with_retry(write_concern, context: context) 行う |接続, txn_num, context|
      gte_4_2 = 接続.サーバー.説明.server_version_gte?('4.2')
      場合 !gte_4_2 & & ops[:hint] & & write_concern & & !write_concern.確認済み?
        発生 エラー::UnsupportedOption.hint_error(unacknowledged_write: true)
      end

      操作::Update.新着情報(
        updates: [ update_doc ],
        db_name: コレクション.database.name,
        coll_name: コレクション.name,
        write_concern: write_concern,
        bypass_document_validation: !!ops[:bypass_document_validation],
        セッション: セッション,
        let: ops[:let],
        comment: ops[:comment],
      ).execution_with_ connection(接続, context: context)
    end
  end
end

#update_one(spec, opts = {}) ⇒ Result

コレクション内の 1 つのドキュメントを更新します。

例:

コレクション内の 1 つのドキュメントを更新します。

collection_view.update_one('$set' => { name: 'test' })

パラメーター:

  • スペック （ハッシュ | 配列 <Hash> ） —

    更新ドキュメントまたはパイプライン。

  • ops （ハッシュ） （デフォルトは{}です） —

    オプション。

  • options （ハッシュ） —

    カスタマイズ可能なオプションのセット

オプション ハッシュ（ opts ）:

  • :upsert （ true 、 false ） —

    ドキュメントが存在しない場合にアップサートを実行するかどうか。

  • :bypass_document_validation （ true 、 false ） —

    ドキュメント レベルの検証をスキップするかどうか。

  • :collation （ハッシュ） —

    使用する照合。

  • :array_filters （配列） —

    アップデートを適用する配列要素を指定するフィルターのセット。

  • :session （セッション） —

    使用するセッション。

  • :hint （ハッシュ | string ） —

    この操作に使用するインデックス。 ハッシュ（例: { _id : 1 } またはstring （例: ID ）。

  • :write_concern （ハッシュ） —

    書込み保証（write concern） オプション。 :w => 整数、 :fsync => ブール値、 :j => ブール値 になります。

次の値を返します。

  • （結果） —

    データベースからの応答。

以来

  • 2.0.0



499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
 
ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/writetable.rb', 行499

デフォルト update_one(スペック, ops = {})
  with_session(ops) 行う |セッション|
    write_concern = 場合 ops[:write_concern]
      WriteConcern.得る(ops[:write_concern])
    else
      write_concern_with_session(セッション)
    end
    validate_update_documents!(スペック)

    クエリ キャッシュ.clear_namespace(コレクション.namespace)

    update_doc = {
      操作::q => フィルター,
      arrayFilters: ops[:array_filters] || ops[' array_filters '],
      操作::U => スペック,
      hint: ops[:hint],
      collation: ops[:collation] || ops[「照合」] || collation,
    }.compact
    場合 ops[:upsert]
      update_doc['upsert'] = true
    end

    context = 操作::Context.新着情報(クライアント: クライアント, セッション: セッション)
    write_with_retry(write_concern, context: context) 行う |接続, txn_num, context|
      gte_4_2 = 接続.サーバー.説明.server_version_gte?('4.2')
      場合 !gte_4_2 & & ops[:hint] & & write_concern & & !write_concern.確認済み?
        発生 エラー::UnsupportedOption.hint_error(unacknowledged_write: true)
      end

      操作::Update.新着情報(
        updates: [ update_doc ],
        db_name: コレクション.database.name,
        coll_name: コレクション.name,
        write_concern: write_concern,
        bypass_document_validation: !!ops[:bypass_document_validation],
        セッション: セッション,
        txn_num: txn_num,
        let: ops[:let],
        comment: ops[:comment],
      ).execution_with_ connection(接続, context: context)
    end
  end
end