alterCollectionProperties()

This operation modifies the properties of a specified コレクション.

javascript
await milvusClient.alterCollectionProperties(data)

Request Syntax

javascript
await milvusClient.alterCollectionProperties({
   db_name?: string
   collection_name: string,
   delete_keys?: string[],
   properties: Properties,
   timeout?: number
 })

PARAMETERS:

db_name (string) -

The name of the データベース that holds the target コレクション.
collection_name (string) -

[REQUIRED]

The name of the target コレクション to reassign an alias to.
delete_keys (string[]) -

削除するプロパティ。
properties (Properties) -

[REQUIRED]

変更するプロパティとその期待値を、TypeScript の Record で指定します。指定可能な値は以下のとおりです。
- コレクション.ttl.seconds (number) -
  
  The time-to-live (TTL) of a コレクション in seconds.
- mmap.enabled (bool) -
  
  Whether to enable mmap for the raw data and インデックス of all fields in the コレクション.
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.alterCollection({
    collection_name: 'my-collection',
    properties: {"collection.ttl.seconds": 18000}
});

Request Syntax​

Example​

Request Syntax

Example