Python 用 SDK を使用してコレクションにパーティションを作成する - DashVector

このトピックでは、Python 用 SDK を使用してコレクションにパーティションを作成する方法について説明します。

前提条件

クラスターが作成されていること。詳細については、「クラスターの作成」をご参照ください。
API キーを取得していること。詳細については、「API キーの管理」をご参照ください。
最新バージョンの SDK がインストールされていること。詳細については、「DashVector SDK のインストール」をご参照ください。

API 定義

Python

Collection.create_partition(name: str) -> DashVectorResponse

例

説明

コードを正しく実行するには、サンプルコード内の YOUR_API_KEY を実際の API キーに、YOUR_CLUSTER_ENDPOINT をクラスターのエンドポイントに置き換える必要があります。
quickstart という名前のコレクションを事前に作成しておく必要があります。詳細については、「コレクションの作成」トピックの「例」セクションをご参照ください。

Python

import dashvector

client = dashvector.Client(
    api_key='YOUR_API_KEY',
    endpoint='YOUR_CLUSTER_ENDPOINT'
)
collection = client.get(name='quickstart')

# shoes という名前のパーティションを作成します。
ret = collection.create_partition('shoes')

# create_partition メソッドが正常に呼び出されたかどうかを確認します。
if ret:
    print('create_partition success')

リクエストパラメーター

パラメーター	タイプ	デフォルト値	説明
name	str	-	作成するパーティションの名前。
timeout	Optional[int]	None	タイムアウト期間。 timeout を None に設定すると、メソッドは同期モードで動作し、パーティションが正常に作成されたときにレスポンスを返します。 timeout を -1 に設定すると、メソッドは非同期モードで動作します。 timeout を 0 以上の値に設定すると、メソッドは同期モードで動作し、指定された時間内に操作結果を待ちます。指定されたタイムアウト期間内にパーティションが作成されなかった場合、メソッドはタイムアウトエラーを返します。

レスポンスパラメーター

説明

DashVectorResponse オブジェクトが返されます。これには、次の表に示すように、操作結果が含まれています。

パラメーター	タイプ	説明	例
code	int	返されたステータスコード。詳細については、「ステータスコード」をご参照ください。	0
message	str	返されたメッセージ。	success
request_id	str	リクエストの一意の ID。	19215409-ea66-4db9-8764-26ce2eb5bb99