MongoClient の作成

Overview

MongoDB 配置に接続するには、次の 2 つのものが必要です。

• 接続 URI （ 接続string とも呼ばれます）で、接続するPyMongo MongoDB配置を に指示します。

• MongoDB 配置への接続を作成し、それに対して操作を実行できるようにするMongoClientオブジェクト。

また、これらのコンポーネントのいずれかを使用して、MongoDB に接続中の PyMongo の動作をカスタマイズすることもできます。

このガイドでは、接続string を作成し、{0MongoClient オブジェクトを使用してMongoDB に接続する方法について説明します。

接続URI

標準の接続stringには次のコンポーネントが含まれます。

接続 の作成の詳細については、string MongoDB Serverドキュメントの「 接続 文字列 」を参照してください。

MongoClient

MongoDB への接続を作成するには、接続 URI を string としてMongoClientコンストラクターに渡します。 次の例では、ドライバーはサンプル接続 URI を使用して、 localhostのポート27017上の MongoDB インスタンスに接続します。

from pymongo import MongoClient
uri = "mongodb://localhost:27017/"
client = MongoClient(uri)

非同期アプリケーションを操作している場合は、 AsyncMongoClientクラスを使用します。次の例は、AsyncMongoClientオブジェクトを作成する方法を示しています。

from pymongo import AsyncMongoClient
uri = "mongodb://localhost:27017/"
client = AsyncMongoClient(uri)

次の表では、MongoClient() コンストラクターが受け入れる位置指定パラメーターを説明しています。すべてのパラメーターは任意です。

You can also pass keyword arguments to the MongoClient() constructor to specify optional parameters. For a complete list of keyword arguments, see the MongoClient class in the API documentation.

同時実行

次のセクションでは、PyMongo の同時実行メカニズムのサポートについて説明します。

# Each process creates its own instance of MongoClient.
def func():
    db = pymongo.MongoClient().mydb
    # Do something with db.
proc = multiprocessing.Process(target=func)
proc.start()

型ヒント

アプリケーションでPython3.5 以降を使用している場合は、 PHP で説明されているように、 型のヒント 484をコードに追加できます。型のヒントは、変数、パラメータ、関数の戻り値のデータ型とドキュメントの構造を示します。一部の IDE では、 型ヒント を使用してコードの型エラーをチェックし、コード完了のための適切なオプションを提案できます。

PyMongoアプリケーションで型のヒントを使用するには、次の例に示すように、MongoClientオブジェクトに型の注釈を追加する必要があります。対応するコードを表示するには、Synchronous タブまたは Asynchronousタブを選択します。

from pymongo import MongoClient
client: MongoClient = MongoClient()

from pymongo import AsyncMongoClient
client: AsyncMongoClient = AsyncMongoClient()

より正確な型情報については、型注釈にジェネリックドキュメント型 Dict[str, Any] を含めることができます。このデータ型は、 MongoDB内のすべてのドキュメントと一致します。次の例では、このデータ型を型注釈 に含める方法を示しています。対応するコードを表示するには、Synchronous タブまたは Asynchronousタブを選択します。

from pymongo import MongoClient
from typing import Any, Dict
client: MongoClient[Dict[str, Any]] = MongoClient()

from pymongo import AsyncMongoClient
from typing import Any, Dict
client: AsyncMongoClient[Dict[str, Any]] = AsyncMongoClient()

操作するすべてのドキュメントが単一のカスタムタイプに対応する場合は、MongoClientオブジェクトのタイプヒントとしてカスタムタイプを指定できます。これにより、汎用の Dict[str, Any] 型よりも正確な型情報が提供されます。

次の例は、MongoClientオブジェクトの型のヒントとして Movie 型を指定する方法を示しています。対応するコードを表示するには、Synchronous タブまたは Asynchronousタブを選択します。

from typing import TypedDict
class Movie(TypedDict):
    name: str
    year: int
client: MongoClient[Movie] = MongoClient()

from typing import TypedDict
class Movie(TypedDict):
    name: str
    year: int
client: AsyncMongoClient[Movie] = AsyncMongoClient()

Closing a MongoClient

During garbage collection, PyMongo automatically cleans up application-side resources used by a MongoClient instance. However, PyMongo does not guarantee the closure of server-side resources such as open cursors or sessions. You can ensure that PyMongo closes these resources by calling the close() method on your MongoClient instance when you are done using it, as shown in the following example:

client.close()

You can also instantiate the client in a with statement, as shown in the following example. The client automatically closes when the block terminates.

with MongoClient("mongodb://localhost:27017/") as client:
   db = client.get_database("mydatabase")
    # Perform further client operations here

トラブルシューティング

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

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

client: MongoClient[Dict[str, Any]]

API ドキュメント

PyMongo でMongoClientオブジェクトを作成する方法の詳細については、次の API ドキュメントを参照してください。

• MongoClient

• AsyncMongoClient