Serving 集群中的 Database

Zilliz Cloud 在集群和 Collection 之间引入了一层 Database，可帮助您更高效地组织和管理数据，同时满足您的多租需求。

什么是 Database

在 Zilliz Cloud 中，Database 是用于组织和管理数据的逻辑单元。为了增强数据安全并实现多租，您可以创建多个 Database，从逻辑上将不同应用和不同租户的数据隔离开来。例如，您可以针对两名不同用户的数据创建不同的 Database。

下图展示了 Zilliz Cloud 资源层级的架构。

通过上图可以看到，仅 Dedicated 集群下有 Database 层。 Serverless 和 Free 集群下无 Database 层。

前提条件

您需要具备组织管理员或项目管理员权限。

创建 Database

仅 Dedicated 集群支持创建 Database。在您创建 Dedicated 集群的同时，Zilliz Cloud 会为您在集群下自动创建一个 Default Database。

每个 Dedicated 集群中最多可创建 1024 个 Database。您可以选择通过控制台或编程的方式创建 Database。

在控制台中创建 Database

您可以按照如下图所示的方式创建 Database。

您也可以将创建好的 Collection 从一个 Database 移动到另一个 Database 中。更多详情，请参考管理 Collection (控制台)。

使用 SDK 创建 Database

您可以使用 RESTful API 或 SDK 创建 Database。

Python

python

from pymilvus import MilvusClient

client = MilvusClient(
    uri="https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530",
    token="YOUR_CLUSTER_TOKEN"
)

client.create_database(
    db_name="my_database_1"
)

Java

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("https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530")
        .token("YOUR_CLUSTER_TOKEN")
        .build();
MilvusClientV2 client = new MilvusClientV2(config);

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

NodeJS

javascript

import {MilvusClient} from '@zilliz/milvus2-sdk-node';
const client = new MilvusClient({ 
    address: "https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530",
    token: 'YOUR_CLUSTER_TOKEN' 
});

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

Go

go

cli, err := milvusclient.New(ctx, &milvusclient.ClientConfig{
    Address: "https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530",
    APIKey: "YOUR_CLUSTER_TOKEN"
})
if err != nil {
    // handle err
}

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

cURL

bash

export CLUSTER_ENDPOINT="https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530"
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"
}'

您还可以在创建 Database 时为其指定相应属性。如下示例中演示了如何在创建 Database 时设置副本数量。

Python

python

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

Java

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

javascript

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

Go

go

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

cURL

bash

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
    }
}'

查看 Database

您可以使用 RESTful API 或 SDK 查看所有已创建的 Database 及其详情。

Python

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

java

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

ListDatabasesResp listDatabasesResp = client.listDatabases();

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

NodeJS

javascript

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

Go

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

bash

export CLUSTER_ENDPOINT="https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530"
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 属性

每个 Database 都有若干属性供您设置。您可以选择在创建 Database 时设置这些属性或者修改已创建的 Database 的属性。

下表展示了当前支持设置的 Database 属性。

属性名称	值类型	属性描述
database.replica.number	integer	指定 Database 的副本数量。
database.max.collections	integer	指定 Database 中可以创建的 Collection 的最大数量。
database.force.deny.writing	boolean	当前 Database 是否强制不可写。
database.force.deny.reading	boolean	当前 Database 是否强制不可读。
	string

修改 Database 属性

您可以参考如下示例修改指定 Database 的上述属性。如下示例演示了如何限制指定 Database 中可以创建的 Collection 数量。

Python

python

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

Java

java

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

NodeJS

javascript

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

Go

go

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

cURL

bash

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
    }
}'

重置 Database 属性

您还可以参考如下示例重置 Database 某个属性的设置。如下示例演示了如何移除指定 Database 中可创建的 Collection 数量限制。

Python

python

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

Java

java

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

NodeJS

javascript

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

Go

go

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

cURL

bash

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"
    ]
}'

使用 Database

您可以使用该操作在不断开连接的情况下切换当前使用的 Database。

Notes

RESTful API 不支持该操作。

Python

python

client.use_database(
    db_name="my_database_2"
)

Java

java

client.useDatabase("my_database_2");

NodeJS

javascript

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

Go

go

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

cURL

bash

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

删除 Database

当某个 Database 不再需要时，您可以选择删除该 Database。需要注意的是：

• 默认的 Database 无法删除。

• 在删除 Database 前，请删除 Database 中的所有 Collection。

在控制台中删除 Database

您可以参考下图中的步骤通过控制台删除 Database。

使用 SDK 删除 Database

您也可以使用 RESTful API 或 SDK 来删除 Database。

Python

python

client.drop_database(
    db_name="my_database_2"
)

Java

java

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

NodeJS

javascript

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

Go

go

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

cURL

bash

export CLUSTER_ENDPOINT="https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530"
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"
}'