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

describe_alias()

この操作は、エイリアスの詳細を表示します。

Notes

このメソッドは、専用の serving クラスターとオンデマンドコンピュートに適用されます。

  • serving クラスター内のコレクションの場合は、クラスターエンドポイントを使用して MilvusClient を作成してください。

    • Free & Serverless

      https://{cluster-id}.serverless.{region}.vectordb.zillizcloud.com

    • Dedicated

      https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530

  • オンデマンドコンピュート内のコレクションの場合は、プロジェクトエンドポイントを使用して MilvusClient を作成してください。

    https://{project-id}.{region}.api.zillizcloud.com

リクエスト構文​

python
describe_alias(
    alias: str,
    timeout: Optional[float] = None
) -> dict

パラメータ:

  • alias (str) -

    [REQUIRED]

    コレクションのエイリアス。

    この操作の前に、エイリアスが存在することを確認してください。存在しない場合は、例外が発生します。

  • timeout (float | None)

    この操作のタイムアウト時間です。

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

戻り値の型:

Dict

戻り値:

エイリアスの詳細を含む辞書です。

python
{
    alias: 'string',
    collection_name: 'string',
    db_name: 'default'
}

パラメータ:

  • alias (str) -

    指定されたエイリアス。

  • collection_name (str) -

    バインドされているコレクションの名前。

  • db_name (str) -

    バインドされているコレクションが属するデータベース。

例外:

  • MilvusException

    この例外は、この操作中に何らかのエラーが発生した場合に発生します。特に、alias を存在しないエイリアスに設定した場合に発生します。

  • BaseException

    この例外は、この操作が失敗した場合に発生します。

例​

python
from pymilvus import MilvusClient

# 1. Create a milvus client
client = MilvusClient(
    uri="https://inxx-xxxxxxxxxxxx.api.gcp-us-west1.zillizcloud.com:19530",
    token="user:password"
)

# 2. Create a collection
client.create_collection(collection_name="test_collection", dimension=5)

# 3. Create an alias for the collection
client.create_alias(collection_name="test_collection", alias="test")

# 4. Describe the alias
client.describe_alias(alias="test")

# {
#     'alias': 'test', 
#     'collection_name': 'test_collection', 
#     'db_name': 'default'
# }
Ctrl I