一括書き込み操作

サンプル データ

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

挿入操作

挿入操作を実行するには、InsertOne のインスタンスを作成し、挿入するドキュメントを指定します。次のキーワード引数を InsertOne コンストラクターに渡します。

• namespace:ドキュメントを挿入する名前空間空間。この引数は、単一のコレクションに対して 一括操作 を実行する場合は任意です。

• document: 挿入するドキュメント。

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

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

カスタムクラスのインスタンスをコンストラクターに渡すことで、InsertOne のインスタンスを作成することもできます。これにより、型チェックツールを使用している場合、追加の型の安全性が確保されます。渡すインスタンスは、TypedDictクラスから継承する必要があります。

次の例では、型の安全性を高めるためにカスタムクラスを使用して InsertOneインスタンスを構築します。

class Restaurant (TypedDict):
    name: str
    cuisine: str
    borough: str
    restaurant_id: str
operation = pymongo.InsertOne(Restaurant(
    name="Mongo's Deli", cuisine="Sandwiches", borough="Manhattan", restaurant_id="1234"))

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

アップデート操作

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

• namespace: 更新を実行する名前空間空間。この引数は、単一のコレクションに対して 一括操作 を実行する場合は任意です。

• filter:コレクション内のドキュメントをマッチングするために使用される基準を指定するクエリフィルター。

• update: 実行する更新。更新操作の詳細については、 MongoDB Serverマニュアルの「 フィールド更新演算子 」ガイドを参照してください。

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

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

operation = UpdateOne(
    namespace="sample_restaurants.restaurants",
    filter={ "name": "Mongo's Deli" },
    update={ "$set": { "cuisine": "Sandwiches and Salads" }}
)

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

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

operation = UpdateMany(
    namespace="sample_restaurants.restaurants",
    filter={ "name": "Mongo's Deli" },
    update={ "$set": { "cuisine": "Sandwiches and Salads" }}
)

置換操作

置換操作、指定されたドキュメントのすべてのフィールドと値が削除され、新しいフィールドと値に置き換えられます。置換操作を実行するには、ReplaceOne のインスタンスを作成し、次の引数を渡します。

• namespace: 置換操作を実行する名前空間空間。この引数は、単一のコレクションに対して 一括操作 を実行する場合は任意です。

• filter: 置き換えるドキュメントを一致させるために使用される条件を指定するクエリフィルター。

• replacement: 一致するドキュメントに保存する新しいフィールドと値を含むドキュメント。

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

operation = ReplaceOne(
    namespace="sample_restaurants.restaurants",
    filter={ "restaurant_id": "1234" },
    replacement={
        "name": "Mongo's Pizza",
        "cuisine": "Pizza",
        "borough": "Brooklyn",
        "restaurant_id": "5678"
    }
)

カスタムクラスのインスタンスをコンストラクターに渡すことで、ReplaceOne のインスタンスを作成することもできます。これにより、型チェックツールを使用している場合、追加の型の安全性が確保されます。渡すインスタンスは、TypedDictクラスから継承する必要があります。

次の例では、型の安全性を高めるためにカスタムクラスを使用して ReplaceOneインスタンスを構築します。

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

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

削除操作

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

• namespace:ドキュメントを削除する名前空間空間。この引数は、単一のコレクションに対して 一括操作 を実行する場合は任意です。

• filter: 削除するドキュメントをマッチングするために使用される基準を指定するクエリフィルター。

DeleteOne はクエリフィルターに一致する最初のドキュメントのみを削除します。

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

operation = DeleteOne(
    namespace="sample_restaurants.restaurants",
    filter={ "restaurant_id": "5678" }
)

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

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

operation = DeleteMany(
    namespace="sample_restaurants.restaurants",
    filter={ "name": "Mongo's Deli" }
)

コレクション一括書込みの例

次の例では、Collectionインスタンスで bulk_write() メソッドを使用して、restaurantsコレクションに対して複数の書込み操作を実行します。

operations = [
    InsertOne(
        document={
            "name": "Mongo's Deli",
            "cuisine": "Sandwiches",
            "borough": "Manhattan",
            "restaurant_id": "1234"
        }
    ),
    InsertOne(
        document={
            "name": "Mongo's Deli",
            "cuisine": "Sandwiches",
            "borough": "Brooklyn",
            "restaurant_id": "5678"
        }
    ),
    UpdateMany(
        filter={ "name": "Mongo's Deli" },
        update={ "$set": { "cuisine": "Sandwiches and Salads" }}
    ),
    DeleteOne(
        filter={ "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)

クライアント一括書込みの例

次の例では、MongoClientインスタンスで bulk_write() メソッドを使用して、sample_restaurants.restaurants と sample_mflix.movies の名前空間に対して複数の書込み操作を実行します。

operations = [
    InsertOne(
        namespace="sample_mflix.movies",
        document={
            "title": "Minari",
            "runtime": 217,
            "genres": ["Drama", "Comedy"]
        }
    ),
    UpdateOne(
        namespace="sample_mflix.movies",
        filter={ "title": "Minari" },
        update={ "$set": { "runtime": 117 }}
    ),
    DeleteMany(
        namespace="sample_restaurants.restaurants",
        filter={ "cuisine": "French" }
    )
]
results = client.bulk_write(operations)
print(results)

ClientBulkWriteResult({'anySuccessful': True, 'error': None, 'writeErrors': [],
'writeConcernErrors': [], 'nInserted': 1, 'nUpserted': 0, 'nMatched': 1,
'nModified': 1, 'nDeleted': 344, 'insertResults': {}, 'updateResults': {},
'deleteResults': {}}, acknowledged=True, verbose=False)

コレクション一括書込みオプション

次の表では、Collection.bulk_write() メソッドに渡すことができるオプションについて説明しています。

次の例では、前述のコレクション一括書き込みの例から bulk_write() メソッドを呼び出しますが、ordered オプションを False に設定します。

results = restaurants.bulk_write(operations, ordered=False)

順序なし一括書き込み 内のいずれかの書き込み操作が失敗した場合、PyMongo はすべての操作を試行した後にのみエラーを報告します。

クライアント一括書込みオプション

次の表では、MongoClient.bulk_write() メソッドに渡すことができるオプションについて説明しています。

次の例では、前述のクライアント一括書き込みの例から bulk_write() メソッドを呼び出しますが、verbose_results オプションを True に設定します。

results = client.bulk_write(operations, verbose_results=True)

ClientBulkWriteResult({'anySuccessful': True, 'error': None, 'writeErrors': [],
'writeConcernErrors': [], 'nInserted': 1, 'nUpserted': 0, 'nMatched': 1, 'nModified': 1,
'nDeleted': 344, 'insertResults': {0: InsertOneResult(ObjectId('...'),
acknowledged=True)}, 'updateResults': {1: UpdateResult({'ok': 1.0, 'idx': 1, 'n': 1,
'nModified': 1}, acknowledged=True)}, 'deleteResults': {2: DeleteResult({'ok': 1.0,
'idx': 2, 'n': 344}, acknowledged=True)}}, acknowledged=True, verbose=True)

コレクション一括書き込みの戻り値

Collection.bulk_write()メソッドはBulkWriteResultオブジェクトを返します。 BulkWriteResultオブジェクトには次のプロパティが含まれています。

クライアント一括書き込みの戻り値

MongoClient.bulk_write()メソッドはClientBulkWriteResultオブジェクトを返します。 ClientBulkWriteResultオブジェクトには次のプロパティが含まれています。

クライアント タイプの注釈

MongoClientオブジェクトに型注釈を追加しない場合、型チェッカーに次のようなエラーが表示される場合があります。

from pymongo import MongoClient
client = MongoClient()  # error: Need type annotation for "client"

解決策としては、MongoClientオブジェクトを client: MongoClient または client: MongoClient[Dict[str, Any]] として注釈を付けることです。

互換性のないタイプ

型のヒントとして MongoClient を指定しているが、ドキュメント、キー、値のデータ型を含めない場合、型チェッカーに次のようなエラーが表示される場合があります。

error: Dict entry 0 has incompatible type "str": "int";
expected "Mapping[str, Any]": "int"

解決策としては、次のタイプのヒントを MongoClientオブジェクトに追加することです。

``client: MongoClient[Dict[str, Any]]``

API ドキュメント

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

• Collection.bulkWrite()

• MongoClient.bulk_write()

• InsertOne

• UpdateOne

• UpdateMany

• replaceOne

• DeleteOne

• deleteMany

• BulkWriteResult

• ClientBulkWriteResult

• BulkWriteError

• ClientBulkWriteException