一括書き込み操作

項目一覧

Overview

サンプルデータ
書込み (write) 操作を定義する
挿入操作
アップデート操作
置換操作
削除操作
bulk_write()メソッドを呼び出す
一括書き込み操作をカスタマイズ
戻り値
詳細情報
API ドキュメント

Overview

コレクションにドキュメントを挿入し、複数の他のドキュメントを更新してから、ドキュメントを削除するシナリオを考えてみましょう。個々のメソッドを使用する場合、各操作には独自のデータベース呼び出しが必要です。このガイドでは、一括書き込み操作を使用して、1 回のデータベース呼び出しで複数の書き込み操作を実行する方法を説明します。

サンプルデータ

このガイドの例では、 Atlas サンプルデータセットの sample_restaurants.restaurantsコレクションを使用します。 MongoDB Atlas クラスターを無料で作成し、サンプルデータセットをロードする方法については、「PyMongo を使い始める」チュートリアルを参照してください。

書込み (write) 操作を定義する

実行する書込み操作ごとに、次のいずれかの操作クラスのインスタンスを作成します。

InsertOne
UpdateOne
UpdateMany
ReplaceOne
DeleteOne
DeleteMany

次に、これらのインスタンスのリストをbulk_write()メソッドに渡します。

次のセクションでは、前述のクラスのインスタンスを作成して使用する方法を示します。

挿入操作

挿入操作を実行するには、 InsertOneのインスタンスを作成し、挿入するドキュメントを指定します。

次の例では、 InsertOneのインスタンスを作成しています。

operation = pymongo.InsertOne(
    {
        "name": "Mongo's Deli",
        "cuisine": "Sandwiches",
        "borough": "Manhattan",
        "restaurant_id": "1234"
    }
)

複数のドキュメントを挿入するには、ドキュメントごとにInsertOneのインスタンスを作成します。

注意

重複した _id 値はユニークインデックス制約に違反するため、ドライバーは DuplicateKeyError を返します。このエラーを回避するには、挿入する各ドキュメントに一意の _id 値があることを確認します。

アップデート操作

ドキュメントを更新するには、 UpdateOneのインスタンスを作成し、次の引数を渡します。

コレクション内のドキュメントを照合するために使用される基準を指定するクエリフィルター
実行する更新操作。更新操作の詳細については、MongoDB Server マニュアルの「フィールド更新演算子」ガイドを参照してください。

UpdateOne はクエリフィルターに一致する最初のドキュメントを更新します。

次の例では、 UpdateOneのインスタンスを作成しています。

operation = pymongo.UpdateOne(
    { "name": "Mongo's Deli" },
    { "$set": { "cuisine": "Sandwiches and Salads" }},
)

複数のドキュメントを更新するには、 UpdateManyのインスタンスを作成し、同じ引数で渡します。 UpdateManyは、クエリフィルターに一致するすべてのドキュメントを更新します。

次の例では、 UpdateManyのインスタンスを作成しています。

operation = pymongo.UpdateMany(
    { "name": "Mongo's Deli" },
    { "$set": { "cuisine": "Sandwiches and Salads" }},
)

置換操作

置換操作により、指定されたドキュメントのすべてのフィールドと値が削除され、新しいフィールドと値に置き換えられます。置換操作を実行するには、 ReplaceOneのインスタンスを作成し、そのインスタンスにクエリフィルターと、一致するドキュメントに保存するフィールドと値を渡します。

次の例では、 ReplaceOneのインスタンスを作成しています。

operation = pymongo.ReplaceOne(
    { "restaurant_id": "1234" },
    {
        "name": "Mongo's Pizza",
        "cuisine": "Pizza",
        "borough": "Brooklyn",
        "restaurant_id": "5678"
    }
)

複数のドキュメントを置き換えるには、ドキュメントごとにReplaceOneのインスタンスを作成する必要があります。

削除操作

ドキュメントを削除するには、 DeleteOneのインスタンスを作成し、削除するドキュメントを指定するクエリフィルターを渡します。 DeleteOneは、クエリフィルターに一致する最初のドキュメントのみを削除します。

次の例では、 DeleteOneのインスタンスを作成しています。

operation = pymongo.DeleteOne({ "restaurant_id": "5678" })

複数のドキュメントを削除するには、 DeleteManyのインスタンスを作成し、削除するドキュメントを指定するクエリフィルターを渡します。 DeleteManyは、クエリフィルターに一致するすべてのドキュメントを削除します。

次の例では、 DeleteManyのインスタンスを作成しています。

operation = pymongo.DeleteMany({ "name": "Mongo's Deli" })

`bulk_write()`メソッドを呼び出す

実行する操作ごとにクラスインスタンスを定義したら、これらのインスタンスのリストをbulk_write()メソッドに渡します。デフォルトでは、メソッドはリストで定義された順序で操作を実行します。

次の例では、 bulk_write()メソッドを使用して複数の書込み操作を実行します。

operations = [
    pymongo.InsertOne(
        {
            "name": "Mongo's Deli",
            "cuisine": "Sandwiches",
            "borough": "Manhattan",
            "restaurant_id": "1234"
        }
    ),
    pymongo.InsertOne(
        {
            "name": "Mongo's Deli",
            "cuisine": "Sandwiches",
            "borough": "Brooklyn",
            "restaurant_id": "5678"
        }
    ),
    pymongo.UpdateMany(
        { "name": "Mongo's Deli" },
        { "$set": { "cuisine": "Sandwiches and Salads" }},
    ),
    pymongo.DeleteOne(
        { "restaurant_id": "1234" }
    )
]
results = restaurants.bulk_write(operations)
print(results)

BulkWriteResult({'writeErrors': [], 'writeConcernErrors': [], 'nInserted': 2, 'nUpserted': 0, 'nMatched': 2, 'nModified': 2, 'nRemoved': 1, 'upserted': []}, acknowledged=True)

書き込み操作のいずれかが失敗した場合、PyMongo はBulkWriteErrorを発生させ、それ以上の操作を実行しません。 BulkWriteErrorは、失敗した操作を含むdetails属性と例外に関する詳細を提供します。

注意

PyMongo が一括操作を実行する場合、操作が実行されているコレクションのwrite_concernが使用されます。ドライバーは、実行順序に関係なく、すべての操作を試行した後にすべての書込み保証 (write concern) エラーを報告します。