コレクションの変更

コレクションの名前を変更したり、設定を変更したりできます。このページでは、コレクションを変更する方法について説明します。

コレクションの名前を変更する

コレクションの名前は、以下のように変更できます。

Python

python

from pymilvus import MilvusClient

client = MilvusClient(
    uri="YOUR_CLUSTER_ENDPOINT",
    token="YOUR_CLUSTER_TOKEN"
)

client.rename_collection(
    old_name="my_collection",
    new_name="my_new_collection"
)

Java

java

import io.milvus.v2.service.collection.request.RenameCollectionReq;
import io.milvus.v2.client.ConnectConfig;
import io.milvus.v2.client.MilvusClientV2;

String CLUSTER_ENDPOINT = "YOUR_CLUSTER_ENDPOINT";
String TOKEN = "YOUR_CLUSTER_TOKEN";

// 1. Connect to Milvus server
ConnectConfig connectConfig = ConnectConfig.builder()
    .uri(CLUSTER_ENDPOINT)
    .token(TOKEN)
    .build();
    
MilvusClientV2 client = new MilvusClientV2(connectConfig);

RenameCollectionReq renameCollectionReq = RenameCollectionReq.builder()
        .collectionName("my_collection")
        .newCollectionName("my_new_collection")
        .build();

client.renameCollection(renameCollectionReq);

Go

go

import (
    "context"
    "fmt"

    "github.com/milvus-io/milvus/client/v3/common"
    "github.com/milvus-io/milvus/client/v3/milvusclient"
)

ctx, cancel := context.WithCancel(context.Background())
defer cancel()

milvusAddr := "YOUR_CLUSTER_ENDPOINT"
token := "YOUR_CLUSTER_TOKEN"

client, err := milvusclient.New(ctx, &milvusclient.ClientConfig{
    Address: milvusAddr,
    APIKey:  token,
})
if err != nil {
    fmt.Println(err.Error())
    // handle error
}
defer client.Close(ctx)

err = client.RenameCollection(ctx, milvusclient.NewRenameCollectionOption("my_collection", "my_new_collection"))
if err != nil {
    fmt.Println(err.Error())
    // handle error
}

Rust

rust

client.rename_collection(
    RenameCollectionRequest::builder()
        .collection_name("my_collection")
        .new_collection_name("my_new_collection")
        .build()?,
)
.await?;

C++

c++

#include <iostream>
#include "milvus/MilvusClientV2.h"

auto client = milvus::MilvusClientV2::Create();

milvus::ConnectParam connect_param{"YOUR_CLUSTER_ENDPOINT", "YOUR_CLUSTER_TOKEN"};
auto status = client->Connect(connect_param);
if (!status.IsOk()) {
    std::cout << status.Message() << std::endl;
}

status = client->RenameCollection(milvus::RenameCollectionRequest()
                                    .WithCollectionName("my_collection")
                                    .WithNewCollectionName("my_new_collection"));
if (!status.IsOk()) {
    std::cout << status.Message() << std::endl;
}

NodeJS

javascript

import { MilvusClient, DataType } from "@zilliz/milvus2-sdk-node";

const address = "YOUR_CLUSTER_ENDPOINT";
const token = "YOUR_CLUSTER_TOKEN";
const client = new MilvusClient({address, token});

const res = await client.renameCollection({
    collection_name: "my_collection",
    new_collection_name: "my_new_collection"
});

cURL

bash

export CLUSTER_ENDPOINT="YOUR_CLUSTER_ENDPOINT"
export TOKEN="YOUR_CLUSTER_TOKEN"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/rename" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
--header "Request-Timeout: 10" \
-d '{
    "collectionName": "my_collection",
    "newCollectionName": "my_new_collection"
}'

コレクションプロパティを設定する

コレクションの作成後、コレクションレベルのプロパティを変更できます。

サポートされているプロパティ

プロパティ	説明
collection.ttl.seconds	コレクションのデータを特定の期間後に削除する必要がある場合は、Time-To-Live（TTL）を秒単位で設定することを検討してください。TTL がタイムアウトすると、Zilliz Cloud はコレクションからすべてのエンティティを削除します。 削除は非同期で実行されるため、削除が完了するまでは検索やクエリを実行できます。 詳細については、コレクションレベルの TTL を設定する を参照してください。
ttl_field	各エンティティの絶対有効期限タイムスタンプ（エンティティレベルの TTL）を格納する TIMESTAMPTZ フィールドの名前です。各エンティティは、実時間がこのフィールドに格納された値に達した時点で正確に有効期限切れになります。フィールドの値が NULL の場合は、そのエンティティは期限切れになりません。collection.ttl.seconds とは同時に使用できません。 詳細については、エンティティレベルの TTL を設定する を参照してください。
mmap.enabled	メモリマッピング（Mmap）を使用すると、ディスク上の大容量ファイルにメモリで直接アクセスできるようになり、Zilliz Cloud はインデックスとデータをメモリとハードディスクの両方に格納できます。このアプローチは、アクセス頻度に基づいてデータ配置ポリシーを最適化するのに役立ち、検索パフォーマンスに影響を与えずにコレクションのストレージ容量を拡張します。 Zilliz Cloud はクラスターに対してグローバル mmap 設定を実装しています。特定のフィールドまたはそのインデックスで設定を変更できます。 詳細については、mmap の使用を参照してください。
partitionkey.isolation	Partition Key Isolation が有効な場合、Zilliz Cloud はパーティションキーの値に基づいてエンティティをグループ化し、各グループに個別のインデックスを作成します。検索リクエストを受信すると、Zilliz Cloud はフィルタリング条件で指定されたパーティションキーの値に基づいてインデックスを特定し、検索範囲をそのインデックスに含まれるエンティティ内に制限します。これにより、検索中に無関係なエンティティをスキャンすることを回避し、検索パフォーマンスを大幅に向上させます。 詳細については、Partition Key Isolation の使用を参照してください。
dynamicfield.enabled	ダイナミックフィールドを有効にせずに作成されたコレクションに対して、ダイナミックフィールドを有効にします。有効にすると、元のスキーマで定義されていないフィールドを持つエンティティを挿入できます。詳細については、ダイナミックフィールドを参照してください。
allow_insert_auto_id	コレクションで AutoID が有効になっている場合に、コレクションがユーザー提供の主キー値を受け入れるかどうかを指定します。 "true" に設定した場合: 挿入、upsert、および一括インポートでは、ユーザー提供の主キーがある場合はそれを使用し、ない場合は主キー値が自動生成されます。 "false" に設定した場合: ユーザー提供の主キー値は拒否または無視され、主キー値は常に自動生成されます。デフォルトは "false" です。
timezone	時間に依存する操作、特に TIMESTAMPTZ フィールドを処理する際の、このコレクションのデフォルトのタイムゾーンを指定します。タイムスタンプは内部的に UTC で格納され、Milvus はこの設定に従って表示と比較のために値を変換します。設定した場合、コレクションのタイムゾーンはデータベースのデフォルトのタイムゾーンを上書きします。クエリのタイムゾーンパラメーターは、両方を一時的に上書きできます。値は、IANA タイムゾーン識別子（たとえば、Asia/Shanghai、America/Chicago、または UTC）である必要があります。TIMESTAMPTZ フィールドの使用方法については、TIMESTAMPTZ フィールドを参照してください。

例 1: コレクションレベルの TTL を設定する

以下のコードスニペットは、コレクションの TTL を設定する方法を示しています。

Python

python

from pymilvus import MilvusClient

client.alter_collection_properties(
    collection_name="my_collection",
    properties={"collection.ttl.seconds": 60}
)

Java

java

import io.milvus.param.Constant;
import io.milvus.v2.service.collection.request.AlterCollectionPropertiesReq;

AlterCollectionPropertiesReq alterCollectionReq = AlterCollectionPropertiesReq.builder()
        .collectionName("my_collection")
        .property(Constant.TTL_SECONDS, "60")
        .build();

client.alterCollectionProperties(alterCollectionReq);

Go

go

err = client.AlterCollectionProperties(ctx, milvusclient.NewAlterCollectionPropertiesOption("my_collection").WithProperty(common.CollectionTTLConfigKey, 60))
if err != nil {
    fmt.Println(err.Error())
    // handle error
}

Rust

rust

client.alter_collection_properties(
    AlterCollectionPropertiesRequest::builder()
        .collection_name("my_collection")
        .property("collection.ttl.seconds", "60")
        .build()?,
)
.await?;

C++

c++

auto status = client->AlterCollectionProperties(milvus::AlterCollectionPropertiesRequest()
                                                   .WithCollectionName("my_collection")
                                                   .AddProperty(milvus::COLLECTION_TTL_SECONDS, "60"));
if (!status.IsOk()) {
    std::cout << status.Message() << std::endl;
}

NodeJS

javascript

await client.alterCollectionProperties({
    collection_name: "my_collection",
    properties: {
        "collection.ttl.seconds": 60
    }
});

cURL

bash

export CLUSTER_ENDPOINT="YOUR_CLUSTER_ENDPOINT"
export TOKEN="YOUR_CLUSTER_TOKEN"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/alter_properties" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
--header "Request-Timeout: 10" \
-d '{
    "collectionName": "my_collection",
    "properties": {
        "collection.ttl.seconds": 60
    }
}'

例 3: mmap を有効にする

以下のコードスニペットは、mmap を有効にする方法を示しています。

Python

python

from pymilvus import MilvusClient

client.alter_collection_properties(
    collection_name="my_collection",
    properties={"mmap.enabled": True}
)

Java

java

import io.milvus.param.Constant;
import io.milvus.v2.service.collection.request.AlterCollectionPropertiesReq;

AlterCollectionPropertiesReq alterCollectionReq = AlterCollectionPropertiesReq.builder()
        .collectionName("my_collection")
        .property(Constant.MMAP_ENABLED, "True")
        .build();

client.alterCollectionProperties(alterCollectionReq);

Go

go

err = client.AlterCollectionProperties(ctx, milvusclient.NewAlterCollectionPropertiesOption("my_collection").WithProperty(common.MmapEnabledKey, true))
if err != nil {
    fmt.Println(err.Error())
    // handle error
}

Rust

rust

client.alter_collection_properties(
    AlterCollectionPropertiesRequest::builder()
        .collection_name("my_collection")
        .property("mmap.enabled", "true")
        .build()?,
)
.await?;

C++

c++

auto status = client->AlterCollectionProperties(milvus::AlterCollectionPropertiesRequest()
                                                   .WithCollectionName("my_collection")
                                                   .AddProperty(milvus::MMAP_ENABLED, "true"));
if (!status.IsOk()) {
    std::cout << status.Message() << std::endl;
}

NodeJS

javascript

await client.alterCollectionProperties({
    collection_name: "my_collection",
    properties: {
        "mmap.enabled": true
    }
});

cURL

bash

export CLUSTER_ENDPOINT="YOUR_CLUSTER_ENDPOINT"
export TOKEN="YOUR_CLUSTER_TOKEN"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/alter_properties" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
--header "Request-Timeout: 10" \
-d '{
    "collectionName": "my_collection",
    "properties": {
        "mmap.enabled": "true"
    }
}'

例 4: パーティションキーを有効にする

以下のコードスニペットは、パーティションキーを有効にする方法を示しています。

Python

python

from pymilvus import MilvusClient

client.alter_collection_properties(
    collection_name="my_collection",
    properties={"partitionkey.isolation": True}
)

Java

java

import io.milvus.v2.service.collection.request.AlterCollectionPropertiesReq;

AlterCollectionPropertiesReq alterCollectionReq = AlterCollectionPropertiesReq.builder()
        .collectionName("my_collection")
        .property("partitionkey.isolation", "True")
        .build();

client.alterCollectionProperties(alterCollectionReq);

Go

go

err = client.AlterCollectionProperties(ctx, milvusclient.NewAlterCollectionPropertiesOption("my_collection").WithProperty("partitionkey.isolation", true))
if err != nil {
    fmt.Println(err.Error())
    // handle error
}

Rust

rust

client.alter_collection_properties(
    AlterCollectionPropertiesRequest::builder()
        .collection_name("my_collection")
        .property("partitionkey.isolation", "true")
        .build()?,
)
.await?;

C++

c++

auto status = client->AlterCollectionProperties(milvus::AlterCollectionPropertiesRequest()
                                                   .WithCollectionName("my_collection")
                                                   .AddProperty("partitionkey.isolation", "true"));
if (!status.IsOk()) {
    std::cout << status.Message() << std::endl;
}

NodeJS

javascript

await client.alterCollectionProperties({
    collection_name: "my_collection",
    properties: {
        "partitionkey.isolation": true
    }
});

cURL

bash

export CLUSTER_ENDPOINT="YOUR_CLUSTER_ENDPOINT"
export TOKEN="YOUR_CLUSTER_TOKEN"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/alter_properties" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
--header "Request-Timeout: 10" \
-d '{
    "collectionName": "my_collection",
    "properties": {
        "partitionkey.isolation": "true"
    }
}'

例 5: ダイナミックフィールドを有効にする

以下のコードスニペットは、ダイナミックフィールドを有効にする方法を示しています。

Python

python

from pymilvus import MilvusClient

client.alter_collection_properties(
    collection_name="my_collection",
    properties={"dynamicfield.enabled": True}
)

Java

java

import io.milvus.v2.service.collection.request.AlterCollectionPropertiesReq;

AlterCollectionPropertiesReq alterCollectionReq = AlterCollectionPropertiesReq.builder()
        .collectionName("my_collection")
        .property("dynamicfield.enabled", "True")
        .build();

client.alterCollectionProperties(alterCollectionReq);

Go

go

err = client.AlterCollectionProperties(ctx, milvusclient.NewAlterCollectionPropertiesOption("my_collection").WithProperty("dynamicfield.enabled", true))
if err != nil {
    fmt.Println(err.Error())
    // handle error
}

Rust

rust

client.alter_collection_properties(
    AlterCollectionPropertiesRequest::builder()
        .collection_name("my_collection")
        .property("dynamicfield.enabled", "true")
        .build()?,
)
.await?;

C++

c++

auto status = client->AlterCollectionProperties(milvus::AlterCollectionPropertiesRequest()
                                                   .WithCollectionName("my_collection")
                                                   .AddProperty("dynamicfield.enabled", "true"));
if (!status.IsOk()) {
    std::cout << status.Message() << std::endl;
}

NodeJS

javascript

await client.alterCollectionProperties({
    collection_name: "my_collection",
    properties: {
        "dynamicfield.enabled": true
    }
});

cURL

bash

export CLUSTER_ENDPOINT="YOUR_CLUSTER_ENDPOINT"
export TOKEN="YOUR_CLUSTER_TOKEN"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/alter_properties" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
--header "Request-Timeout: 10" \
-d '{
    "collectionName": "my_collection",
    "properties": {
        "dynamicfield.enabled": "true"
    }
}'

例 6: allow_insert_auto_id を有効にする

allow_insert_auto_id プロパティを使用すると、AutoID が有効なコレクションが、挿入、upsert、一括インポートの際にユーザー提供の主キー値を受け入れられるようになります。"true" に設定した場合、Zilliz Cloud はユーザー提供の主キー値がある場合はそれを使用し、ない場合は自動生成します。デフォルトは "false" です。

以下の例は、allow_insert_auto_id を有効にする方法を示しています。

Python

python

from pymilvus import MilvusClient

client.alter_collection_properties(
    collection_name="my_collection",
    properties={"allow_insert_auto_id": "true"}
)
# After enabling, inserts with a PK column will use that PK; otherwise Zilliz Cloud auto-generates.

Java

java

import io.milvus.v2.service.collection.request.AlterCollectionPropertiesReq;

AlterCollectionPropertiesReq alterCollectionReq = AlterCollectionPropertiesReq.builder()
        .collectionName("my_collection")
        .property("allow_insert_auto_id", "True")
        .build();

client.alterCollectionProperties(alterCollectionReq);

Go

go

err = client.AlterCollectionProperties(ctx, milvusclient.NewAlterCollectionPropertiesOption("my_collection").WithProperty("allow_insert_auto_id", "true"))
if err != nil {
    fmt.Println(err.Error())
    // handle error
}

Rust

rust

client.alter_collection_properties(
    AlterCollectionPropertiesRequest::builder()
        .collection_name("my_collection")
        .property("allow_insert_auto_id", "true")
        .build()?,
)
.await?;

C++

c++

auto status = client->AlterCollectionProperties(milvus::AlterCollectionPropertiesRequest()
                                                   .WithCollectionName("my_collection")
                                                   .AddProperty("allow_insert_auto_id", "true"));
if (!status.IsOk()) {
    std::cout << status.Message() << std::endl;
}

NodeJS

javascript

await client.alterCollectionProperties({
    collection_name: "my_collection",
    properties: {
        "allow_insert_auto_id": true
    }
});

cURL

bash

export CLUSTER_ENDPOINT="YOUR_CLUSTER_ENDPOINT"
export TOKEN="YOUR_CLUSTER_TOKEN"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/alter_properties" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
--header "Request-Timeout: 10" \
-d '{
    "collectionName": "my_collection",
    "properties": {
        "allow_insert_auto_id": "true"
    }
}'

例 7: コレクションのタイムゾーンを設定する

timezone プロパティを使用して、コレクションのデフォルトのタイムゾーンを設定できます。これは、データの挿入、クエリ、結果の表示など、コレクション内のすべての操作で時間関係のデータがどのように解釈され表示されるかを決定します。

timezone の値は、Asia/Shanghai、America/Chicago、UTC など、有効な IANA タイムゾーン識別子 である必要があります。無効または非標準の値を使用すると、コレクションプロパティの変更時にエラーが発生します。

以下の例では、コレクションのタイムゾーンを Asia/Shanghai: に設定する方法を示します。

Python

python

from pymilvus import MilvusClient

client.alter_collection_properties(
    collection_name="my_collection",
    properties={"timezone": "Asia/Shanghai"}
)

Java

java

import io.milvus.v2.service.collection.request.AlterCollectionPropertiesReq;

AlterCollectionPropertiesReq alterCollectionReq = AlterCollectionPropertiesReq.builder()
        .collectionName("my_collection")
        .property("timezone", "Asia/Shanghai")
        .build();

client.alterCollectionProperties(alterCollectionReq);

Go

go

err = client.AlterCollectionProperties(ctx, milvusclient.NewAlterCollectionPropertiesOption("my_collection").WithProperty("timezone", "Asia/Shanghai"))
if err != nil {
    fmt.Println(err.Error())
    // handle error
}

Rust

rust

client.alter_collection_properties(
    AlterCollectionPropertiesRequest::builder()
        .collection_name("my_collection")
        .property("timezone", "Asia/Shanghai")
        .build()?,
)
.await?;

C++

c++

auto status = client->AlterCollectionProperties(milvus::AlterCollectionPropertiesRequest()
                                                   .WithCollectionName("my_collection")
                                                   .AddProperty("timezone", "Asia/Shanghai"));
if (!status.IsOk()) {
    std::cout << status.Message() << std::endl;
}

NodeJS

javascript

await client.alterCollectionProperties({
    collection_name: "my_collection",
    properties: {
        "timezone": "Asia/Shanghai"
    }
});

cURL

bash

export CLUSTER_ENDPOINT="YOUR_CLUSTER_ENDPOINT"
export TOKEN="YOUR_CLUSTER_TOKEN"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/alter_properties" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
--header "Request-Timeout: 10" \
-d '{
    "collectionName": "my_collection",
    "properties": {
        "timezone": "Asia/Shanghai"
    }
}'

コレクションプロパティを削除する

以下のようにプロパティを削除することで、コレクションプロパティをリセットすることもできます。

Python

python

from pymilvus import MilvusClient

client.drop_collection_properties(
    collection_name="my_collection",
    property_keys=[
        "collection.ttl.seconds"
    ]
)

Java

java

import io.milvus.v2.service.collection.request.DropCollectionPropertiesReq;
import java.util.Collections;

client.dropCollectionProperties(DropCollectionPropertiesReq.builder()
        .collectionName("my_collection")
        .propertyKeys(Collections.singletonList("collection.ttl.seconds"))
        .build());

Go

go

err = client.DropCollectionProperties(ctx, milvusclient.NewDropCollectionPropertiesOption("my_collection", common.CollectionTTLConfigKey))
if err != nil {
    fmt.Println(err.Error())
    // handle error
}

Rust

rust

client.drop_collection_properties(
    DropCollectionPropertiesRequest::builder()
        .collection_name("my_collection")
        .property_keys(["collection.ttl.seconds"])
        .build()?,
)
.await?;

C++

c++

auto status = client->DropCollectionProperties(milvus::DropCollectionPropertiesRequest()
                                                  .WithCollectionName("my_collection")
                                                  .AddPropertyKey(milvus::COLLECTION_TTL_SECONDS));
if (!status.IsOk()) {
    std::cout << status.Message() << std::endl;
}

NodeJS

javascript

client.dropCollectionProperties({
    collection_name:"my_collection",
    properties: ['collection.ttl.seconds'],
});

cURL

bash

export CLUSTER_ENDPOINT="YOUR_CLUSTER_ENDPOINT"
export TOKEN="YOUR_CLUSTER_TOKEN"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/drop_properties" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
--header "Request-Timeout: 10" \
-d '{
    "collectionName": "my_collection",
    "propertyKeys": [
        "collection.ttl.seconds"
    ]
}'