ドキュメントの置換

サンプル データ

このガイドの例では、Atlasサンプルデータセット の sample_restaurantsデータベースの restaurantsコレクションを使用します。Rubyアプリケーションからこのコレクションにアクセスするには、Atlas クラスターに接続する Mongo::Clientオブジェクトを作成し、次の値を database 変数と collection 変数に割り当てます。

database = client.use('sample_restaurants')
collection = database[:restaurants]

MongoDB Atlasクラスターを無料で作成して、サンプルデータセットをロードする方法については、MongoDBを使い始めるガイドを参照してください。

必要なパラメーター

次のパラメータをreplace_oneメソッドに渡す必要があります。

• クエリフィルター : 更新するドキュメントを指定します。クエリフィルターの詳細については、クエリの指定ガイドを参照してください。

• 置換ドキュメント: 既存のフィールドと値を置き換えるフィールドと値を指定します。

置き換えの例

次の例では、 replace_one メソッドを使用して、nameフィールドの値が "Primola Restaurant" であるドキュメントのフィールドと値を置き換えます。

filter = { name: 'Primola Restaurant' }
new_document = { name: 'Frutti Di Mare', cuisine: 'Seafood', borough: 'Queens' }
result = collection.replace_one(filter, new_document)
puts "Replaced #{result.modified_count} document(s)"

Replaced 1 document(s)

置換操作をカスタマイズする

置換操作を構成するオプションを設定するには、Hashオブジェクトをreplace_one メソッドのパラメーターとして渡します。オプションを指定しない場合、ドライバーはデフォルト設定で置換操作を実行します。

次の表では、置換操作を構成するために使用できるオプションについて説明します。

次のコードは、前の例と同じ置換操作を実行しますが、upsert オプションを true に設定します。これは、クエリフィルターが既存のドキュメントと一致しない場合、置換ドキュメントで指定されたフィールドと値を含む新しいドキュメントを挿入するようにドライバーに指示します。

options = { upsert: true }
result = collection.replace_one(filter, new_document, options)
puts "Replaced #{result.upserted_count} document(s)"

Replaced 1 document(s)

戻り値

replace_one メソッドは Mongo::Operation::Update::Resultオブジェクトを返します。Resultインスタンスからの情報にアクセスするには、次のメソッドを使用できます。

API ドキュメント

このガイドで説明したメソッドや型の詳細については、次の API ドキュメントを参照してください。

• replace_one

• Mongo::Operation::Update::Result