[説明] このページは機械翻訳された日本語版です。内容に誤りがございましたら、報告していただけると助かります。

データベース

Zilliz Cloud では、クラスターとコレクションの間に データベース（データベース）レイヤーを導入しており、データの管理と整理をより効率的に行えるとともに、マルチテナントをサポートしています。

What is a database

Zilliz Cloud におけるデータベースは、データを整理・管理するための論理的な単位です。データのセキュリティを強化し、マルチテナントを実現するために、異なるアプリケーションやテナントごとに複数のデータベースを作成して、論理的にデータを分離できます。たとえば、ユーザー A のデータを格納するデータベースと、ユーザー B のデータを格納する別のデータベースを作成できます。

Zilliz Cloud では、リソースは以下のような階層構造になっています。

なお、データベースという概念は Dedicated クラスターでのみ利用可能です。Serverless クラスターや Free クラスターにはデータベースが存在しません。

Prerequisites

データベースを管理するには、組織オーナー または プロジェクト管理者 のアクセス権が必要です。

Create database

データベースは Dedicated クラスターでのみ作成できます。クラスター作成時に、デフォルトのデータベースが自動的に作成されます。

Dedicated クラスター内では、最大 1,024 個のデータベースをコンソール上で手動で、またはプログラムによって作成できます。

Create a database on the console

次の図のように、コンソール上でデータベースを作成できます。

また、既存のコレクションをあるデータベースから別のデータベースへ移動することも可能です。詳細については、Manage Collections (Console) を参照してください。

Create a database programmatically

Milvus RESTful API や SDK を使用して、プログラムでデータベースを作成できます。

Python

from pymilvus import MilvusClient

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

client.create_database(
    db_name="my_database_1"
)

Java

import io.milvus.v2.client.MilvusClientV2;
import io.milvus.v2.client.ConnectConfig;
import io.milvus.v2.service.database.request.*;

ConnectConfig config = ConnectConfig.builder()
        .uri("YOUR_CLUSTER_ENDPOINT")
        .token("YOUR_CLUSTER_TOKEN")
        .build();
MilvusClientV2 client = new MilvusClientV2(config);

CreateDatabaseReq createDatabaseReq = CreateDatabaseReq.builder()
        .databaseName("my_database_1")
        .build();
client.createDatabase(createDatabaseReq);

NodeJS

import {MilvusClient} from '@zilliz/milvus2-sdk-node';
const client = new MilvusClient({ 
    address: "YOUR_CLUSTER_ENDPOINT",
    token: 'YOUR_CLUSTER_TOKEN' 
});

await client.createDatabase({
    db_name: "my_database_1"
 });

Go

cli, err := milvusclient.New(ctx, &milvusclient.ClientConfig{
    Address: "YOUR_CLUSTER_ENDPOINT",
    APIKey: "YOUR_CLUSTER_TOKEN"
})
if err != nil {
    // handle err
}

err = cli.CreateDatabase(ctx, milvusclient.NewCreateDatabaseOption("my_database_1"))
if err != nil {
    // handle err
}

cURL

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

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/databases/create" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "dbName": "my_database_1"
}'

データベース作成時に、そのプロパティを設定することもできます。以下の例では、データベースのレプリカ数を設定しています。

Python

client.create_database(
    db_name="my_database_2",
    properties={
        "database.replica.number": 3
    }
)

Java

Map<String, String> properties = new HashMap<>();
properties.put("database.replica.number", "3");
CreateDatabaseReq createDatabaseReq = CreateDatabaseReq.builder()
        .databaseName("my_database_2")
        .properties(properties)
        .build();
client.createDatabase(createDatabaseReq);

NodeJS

await client.createDatabase({
    db_name: "my_database_2",
    properties: {
        "database.replica.number": 3
    }
});

Go

err := cli.CreateDatabase(ctx, milvusclient.NewCreateDatabaseOption("my_database_2").WithProperty("database.replica.number", 3))
if err != nil {
    // handle err
}

cURL

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

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/databases/create" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "dbName": "my_database_2",
    "properties": {
        "database.replica.number": 3
    }
}'

データベースの表示

Milvus RESTful API または SDK を使用して、既存のすべてのデータベースを一覧表示し、その詳細を確認できます。

Python

# List all existing databases
client.list_databases()

# Output
# ['default', 'my_database_1', 'my_database_2']

# Check database details
client.describe_database(
    db_name="default"
)

# Output
# {"name": "default"}

Java

import io.milvus.v2.service.database.response.*;

ListDatabasesResp listDatabasesResp = client.listDatabases();

DescribeDatabaseResp descDBResp = client.describeDatabase(DescribeDatabaseReq.builder()
        .databaseName("default")
        .build());

NodeJS

await client.describeDatabase({ 
    db_name: 'default'
});

Go

// List all existing databases
databases, err := cli.ListDatabase(ctx, milvusclient.NewListDatabaseOption())
if err != nil {
    // handle err
}
log.Println(databases)

db, err := cli.DescribeDatabase(ctx, milvusclient.NewDescribeDatabaseOption("default"))
if err != nil {
    // handle err
}
log.Println(db)

cURL

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

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/databases/describe" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "dbName": "default"
}'

データベースプロパティの管理

各データベースには独自のプロパティがあります。データベース作成時にプロパティを設定できます（詳細は プログラムによるデータベースの作成 を参照）し、既存のデータベースのプロパティを変更または削除することも可能です。

以下の表に、設定可能なデータベースプロパティを示します。

プロパティ名	型	プロパティの説明
database.replica.number	整数	指定されたデータベースのレプリカ数。
database.max.collections	整数	指定されたデータベースで許可されるコレクションの最大数。
database.force.deny.writing	boolean	指定されたデータベースに対して書き込み操作を強制的に拒否するかどうか。
database.force.deny.reading	boolean	指定されたデータベースに対して読み取り操作を強制的に拒否するかどうか。

データベースプロパティの変更

既存のデータベースのプロパティは次のように変更できます。以下の例では、データベース内で作成可能なコレクション数を制限しています。

Python

client.alter_database_properties(
    db_name="my_database_1",
    properties={
        "database.max.collections": 10
    }
)

Java

client.alterDatabaseProperties(AlterDatabasePropertiesReq.builder()
        .databaseName("my_database_1")
        .property("database.max.collections", "10")
        .build());

NodeJS

await milvusClient.alterDatabaseProperties({
  db_name: "my_database_1",
  properties: {"database.max.collections", "10" },
})

Go

err := cli.AlterDatabaseProperties(ctx, milvusclient.NewAlterDatabasePropertiesOption("my_database_1").
    WithProperty("database.max.collections", 1))
if err != nil {
    // handle err
}

cURL

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

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/databases/alter" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "dbName": "my_database",
    "properties": {
        "database.max.collections": 10
    }
}'

データベースプロパティの削除

以下のようにプロパティを削除することで、データベースのプロパティをリセットすることもできます。次の例では、データベース内で作成可能なコレクション数の制限を解除しています。

Python

client.drop_database_properties(
    db_name="my_database_1",
    property_keys=[
        "database.max.collections"
    ]
)

Java

client.dropDatabaseProperties(DropDatabasePropertiesReq.builder()
        .databaseName("my_database_1")
        .propertyKeys(Collections.singletonList("database.max.collections"))
        .build());

NodeJS

await milvusClient.dropDatabaseProperties({
  db_name: my_database_1,
  properties: ["database.max.collections"],
});

Go

err := cli.DropDatabaseProperties(ctx, milvusclient.NewDropDatabasePropertiesOption("my_database_1", "database.max.collections"))
if err != nil {
    // handle err
}

cURL

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

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/databases/alter" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "dbName": "my_database",
    "propertyKeys": [
        "database.max.collections"
    ]
}'

データベースの使用

Zilliz Cloud から切断することなく、あるデータベースから別のデータベースに切り替えることができます。

📘Notes

RESTful API はこの操作をサポートしていません。

Python

client.use_database(
    db_name="my_database_2"
)

Java

client.useDatabase("my_database_2");

NodeJS

await milvusClient.useDatabase({
  db_name: "my_database_2",
});

Go

err = cli.UseDatabase(ctx, milvusclient.NewUseDatabaseOption("my_database_2"))
if err != nil {
    // handle err
}

cURL

# This operation is unsupported because RESTful does not provide a persistent connection.
# As a workaround, initiate the required request again with the target database.

データベースの削除

データベースが不要になった場合は、そのデータベースを削除できます。ただし、以下の点に注意してください。

• デフォルトのデータベースは削除できません。

• データベースを削除する前に、そのデータベース内のすべてのコレクションを先に削除する必要があります。

コンソール上でデータベースを削除する

下図の手順に従って、コンソール上でデータベースを削除できます。

プログラムでデータベースを削除する

Milvus RESTful API または SDK を使用して、プログラムからデータベースを削除できます。

Python

client.drop_database(
    db_name="my_database_2"
)

Java

client.dropDatabase(DropDatabaseReq.builder()
        .databaseName("my_database_2")
        .build());

NodeJS

await milvusClient.dropDatabase({
  db_name: "my_database_2",
});

Go

err = cli.DropDatabase(ctx, milvusclient.NewDropDatabaseOption("my_database_2"))
if err != nil {
    // handle err
}

cURL

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

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/databases/drop" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "dbName": "my_database"
}'