メインコンテンツまでスキップ

get_compaction_state()

この操作は compaction ジョブの現在の状態を返します。compact() を呼び出した後に、compaction が完了したことを確認するために使用します。

📘注意

このメソッドは以前は get_compact_state() という名前でした。動作は同じです。

📘注意

これは managed collection にのみ適用されます。

リクエスト構文​

python
client.get_compaction_state(
    job_id: int,
    timeout: float = None
) -> str

パラメータ:

  • job_id (int) -

    [必須]

    compact() によって返される compaction ジョブの ID。

  • timeout (float | None) -

    この操作のタイムアウト時間です。これを None に設定すると、応答が到着した時点または何らかのエラーが発生した時点でこの操作はタイムアウトします。

戻り値の型:

str

戻り値:

compaction ジョブの状態名。指定可能な値は "UndefiedState"、"Executing"、"Completed" です。

例外:

  • MilvusException

    ジョブ ID が無効である場合、またはサーバーでエラーが発生した場合に、この例外が発生します。

例​

python
from pymilvus import MilvusClient

client = MilvusClient(uri="YOUR_CLUSTER_ENDPOINT")

# compaction を開始し、その状態を確認する
job_id = client.compact(collection_name="my_collection")
state = client.get_compaction_state(job_id=job_id)
print(state)  # "Executing" or "Completed"
Ctrl I