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

dropAlias()

この操作は、指定したコレクションエイリアスを削除します。

javascript
await milvusClient.dropAlias(data)

Request Syntax​

javascript
await milvusClient.dropAlias({
alias: string,
db_name: string,
collection_name: string,
timeout?: number
})

PARAMETERS:

  • alias (string) -

    [REQUIRED]

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

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

  • db_name (string) -

    指定したコレクションを保持するデータベースの名前です。

  • collection_name (string) -

    エイリアスがバインドされているコレクションの名前です。

  • timeout (number)

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

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

RETURNS Promise<ResStatus>

このメソッドは、ResStatus オブジェクトに解決される promise を返します。

javascript
{
code: number,
error_code: string | number,
reason: string
}

PARAMETERS:

  • code (number) -

    操作結果を示すコードです。この操作が成功した場合は 0 のままです。

  • error_code (string | number) -

    発生したエラーを示すエラーコードです。この操作が成功した場合は Success のままです。

  • reason (string) -

    報告されたエラーの理由を示します。この操作が成功した場合は空文字列のままです。

Example​

java
const milvusClient = new MilvusClient({
address: 'YOUR_CLUSTER_ENDPOINT',
token: 'YOUR_CLUSTER_TOKEN',
});
const resStatus = await milvusClient.dropAlias({
alias: 'my_collection_alias',
collection_name: 'my_collection',
});