renameCollection()

この操作は既存のコレクションの名前を変更します。

javascript
await milvusClient.renameCollection(data)

リクエスト構文

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

パラメーター:

db_name (string) -

対象のコレクションを保持するデータベースの名前です。
collection_name (string) -

[REQUIRED]

既存のコレクションの名前です。
new_collection_name (string) -

[REQUIRED]

この操作後の対象コレクションの名前です。
timeout (number) -

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

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

戻り値 Promise<ResStatus>

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

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

パラメーター:

code (number) -

操作結果を示すコードです。この操作が成功した場合は 0 のままです。
error_code (string | number) -

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

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

例

java
const milvusClient = new MilvusClient({
    address: 'YOUR_CLUSTER_ENDPOINT',
    token: 'YOUR_CLUSTER_TOKEN',
});
 const resStatus = await milvusClient.renameCollection({
   collection_name: 'my_collection',
   new_collection_name: 'my_new_collection'
 });

リクエスト構文​

例​

リクエスト構文

例