クイック スタート: Python 用 Azure Cosmos DB for Apache Gremlin クライアント ライブラリ

Python 用 Azure Cosmos DB for Apache Gremlin クライアント ライブラリを使用して、非構造化データの格納、管理、クエリを実行します。 このガイドの手順に従って、新しいアカウントの作成、Python クライアント ライブラリのインストール、アカウントへの接続、一般的な操作の実行、最終的なサンプル データのクエリを実行します。

ライブラリのソース コード | パッケージ (PyPi)

前提条件

• Azure サブスクリプション

  • Azure サブスクリプションをお持ちでない場合は、開始する前に 無料アカウント を作成してください。

• Azure Cloud Shell の Azure CLI の最新バージョン。

  • CLI 参照コマンドをローカルで実行する場合は、 az login コマンドを使用して Azure CLI にサインインします。

• Python 3.12 以降

設定

まず、このガイドのアカウントと開発環境を設定します。 このセクションでは、アカウントの作成、資格情報の取得、開発環境の準備のプロセスについて説明します。

アカウントを作成する

まず、Apache Gremlin アカウント用の API を作成します。 アカウントが作成されたら、データベースとグラフ リソースを作成します。

資格情報の取得

ここで、最近作成したアカウントへの接続を作成するために使用するクライアント ライブラリのパスワードを取得します。

開発環境の準備

次に、新しいプロジェクトとクライアント ライブラリを使用して開発環境を構成します。 この手順は、このガイドの残りの部分に進む前に必要な最後の前提条件です。

1. 空のフォルダーから開始します。

2. Python パッケージ インデックス (PyPI) から gremlinpython パッケージをインポートします。

   pip install gremlinpython
   

3. app.py ファイルを作成します。

オブジェクト モデル

コード例

• クライアントの認証
• データの挿入
• データの読み取り
• データのクエリ

クライアントの認証

まず、このガイドで前に収集した資格情報を使用してクライアントを認証します。

1. 統合開発環境 (IDE) で app.py ファイルを開きます。

2. gremlin_python.driver ライブラリから次の型をインポートします。

   • gremlin_python.driver.client
   • gremlin_python.driver.serializer

   from gremlin_python.driver import client, serializer
   

3. このガイドで前に収集した資格情報の文字列変数を作成します。 変数に hostname と primary_keyという名前を付けます。

   hostname = "<host>"
   primary_key = "<key>"
   

4. 前の手順で作成した資格情報と構成変数を使用して、 Client オブジェクトを作成します。 変数に client という名前を付けます。

   client = client.Client(
       url=f"wss://{hostname}.gremlin.cosmos.azure.com:443/",
       traversal_source="g",
       username="/dbs/cosmicworks/colls/products",
       password=f"{primary_key}",
       message_serializer=serializer.GraphSONSerializersV2d0()
   )
   

データの挿入

次に、新しい頂点とエッジ データをグラフに挿入します。 新しいデータを作成する前に、既存のデータのグラフをクリアします。

1. g.V().drop() クエリを実行して、グラフからすべての頂点とエッジをクリアします。

   client.submit("g.V().drop()").all().result()
   

2. 頂点を追加する Gremlin クエリを作成します。

   insert_vertex_query = (
       "g.addV('product')"
       ".property('id', prop_id)"
       ".property('name', prop_name)"
       ".property('category', prop_category)"
       ".property('quantity', prop_quantity)"
       ".property('price', prop_price)"
       ".property('clearance', prop_clearance)"
   )
   

3. 1 つの製品に頂点を追加します。

   client.submit(
       message=insert_vertex_query,
       bindings={
           "prop_id": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
           "prop_name": "Yamba Surfboard",
           "prop_category": "gear-surf-surfboards",
           "prop_quantity": 12,
           "prop_price": 850.00,
           "prop_clearance": False,
       },
   ).all().result()
   

4. 2つの追加製品に対応する2つの頂点を追加します。

   client.submit(
       message=insert_vertex_query,
       bindings={
           "prop_id": "bbbbbbbb-1111-2222-3333-cccccccccccc",
           "prop_name": "Montau Turtle Surfboard",
           "prop_category": "gear-surf-surfboards",
           "prop_quantity": 5,
           "prop_price": 600.00,
           "prop_clearance": True,
       },
   ).all().result()
   
   client.submit(
       message=insert_vertex_query,
       bindings={
           "prop_id": "cccccccc-2222-3333-4444-dddddddddddd",
           "prop_name": "Noosa Surfboard",
           "prop_category": "gear-surf-surfboards",
           "prop_quantity": 31,
           "prop_price": 1100.00,
           "prop_clearance": False,
       },
   ).all().result()
   

5. エッジを追加する別の Gremlin クエリを作成します。

   insert_edge_query = (
       "g.V([prop_partition_key, prop_source_id])"
       ".addE('replaces')"
       ".to(g.V([prop_partition_key, prop_target_id]))"
   )
   

6. 2 つのエッジを追加します。

   client.submit(
       message=insert_edge_query,
       bindings={
           "prop_partition_key": "gear-surf-surfboards",
           "prop_source_id": "bbbbbbbb-1111-2222-3333-cccccccccccc",
           "prop_target_id": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
       },
   ).all().result()
   
   client.submit(
       message=insert_edge_query,
       bindings={
           "prop_partition_key": "gear-surf-surfboards",
           "prop_source_id": "bbbbbbbb-1111-2222-3333-cccccccccccc",
           "prop_target_id": "cccccccc-2222-3333-4444-dddddddddddd",
       },
   ).all().result()
   

データの読み取り

次に、以前にグラフに挿入されたデータを読み取る。

1. 一意識別子とパーティション キーの値を使用して、頂点を読み取るクエリを作成します。

   read_vertex_query = "g.V([prop_partition_key, prop_id])"
   

2. 次に、必要なパラメーターを指定して頂点を読み取ります。

   matched_item = client.submit(
       message=read_vertex_query,
       bindings={
           "prop_partition_key": "gear-surf-surfboards",
           "prop_id": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"
       }
   ).one()
   

データのクエリを実行する

最後に、クエリを使用して、グラフ内の特定のトラバーサルまたはフィルターに一致するすべてのデータを検索します。

1. 特定の頂点から走査するすべての頂点を検索するクエリを作成します。

   find_vertices_query = (
       "g.V().hasLabel('product')"
       ".has('category', prop_partition_key)"
       ".has('name', prop_name)"
       ".outE('replaces').inV()"
   )
   

2. Montau Turtle Surfboard製品を指定してクエリを実行します。

   find_results = client.submit(
       message=find_vertices_query,
       bindings={
           "prop_partition_key": "gear-surf-surfboards",
           "prop_name": "Montau Turtle Surfboard",
       },
   ).all().result()
   

3. クエリ結果を反復処理します。

   for result in find_results:
       # Do something here with each result
   

コードの実行

アプリケーション ディレクトリのターミナルを使用して、新しく作成したアプリケーションを実行します。

python app.py

リソースをクリーンアップする

アカウントが不要になったら、リソースを削除して Azure サブスクリプションからアカウント を削除 します。

az cosmosdb delete \
    --resource-group "<resource-group-name>" \
    --name "<account-name>"

次のステップ