milvus-logo
LFAI
フロントページへ
  • ユーザーガイド

データベースの管理

従来のデータベースエンジンと同様に、Milvusでもデータベースを作成し、特定のユーザに管理権限を割り当てることができます。その場合、そのユーザはデータベース内のコレクションを管理する権利を持ちます。Milvusクラスタは最大64個のデータベースをサポートします。

このページのコードスニペットはPyMilvus ORMモジュールを使用してMilvusとやりとりします。新しいMilvusClient SDKを使用したコードスニペットは近日公開予定です。

データベースの作成

Milvusサーバに接続するにはconnect()を使用し、新しいデータベースを作成するにはcreate_database()を使用します：

MilvusClientを使用してMilvusサーバに接続し、createDatabase()を使用して新しいデータベースを作成します：

MilvusClientを使用してMilvusサーバーに接続し、createDatabase()で新しいデータベースを作成する：

Python Java Node.js
from pymilvus import connections, db

conn = connections.connect(host="127.0.0.1", port=19530)

database = db.create_database("my_database")

import io.milvus.client.MilvusServiceClient;
import io.milvus.param.ConnectParam;
import io.milvus.param.collection.CreateDatabaseParam;

// 1. Connect to Milvus server
ConnectParam connectParam = ConnectParam.newBuilder()
    .withUri(CLUSTER_ENDPOINT)
    .withToken(TOKEN)
    .build();

MilvusServiceClient client = new MilvusServiceClient(connectParam);

// 3. Create a new database
CreateDatabaseParam createDatabaseParam = CreateDatabaseParam.newBuilder()
    .withDatabaseName("")
    .build();

R<RpcStatus> response = client.createDatabase(createDatabaseParam);

const address = "http://localhost:19530";

// 1. Set up a Milvus Client
client = new MilvusClient({ address });

// 3. Create a database
res = await client.createDatabase({
    db_name: "my_database",
});

console.log(res);

// {
//   error_code: 'Success',
//   reason: '',
//   code: 0,
//   retriable: false,
//   detail: ''
// }

上記のコード・スニペットでは、デフォルト・データベースに接続し、my_database という名前の新しいデータベースを作成しています。

データベースの使用

Milvusクラスタには'default'という名前のデフォルトデータベースが同梱されています。特に指定がない限り、コレクションはデフォルトデータベースに作成されます。

デフォルトのデータベースを変更するには、以下のようにします：

Python Java Node.js
db.using_database("my_database")

// No equivalent method is available.

// 4. Activate another database
res = await client.useDatabase({
    db_name: "my_database",
});

console.log(res);

また、Milvusクラスタへの接続時に使用するデータベースは以下のように設定することができます：

Python Java Node.js
conn = connections.connect(
    host="127.0.0.1",
    port="19530",
    db_name="my_database"
)

ConnectParam connectParam = ConnectParam.newBuilder()
    .withDatabaseName("my_database")
    .withUri(CLUSTER_ENDPOINT)
    .withToken(TOKEN)
    .build();

MilvusServiceClient client = new MilvusServiceClient(connectParam);

const address = "http://localhost:19530";
const db_name = "my_database";

// 1. Set up a Milvus Client
client = new MilvusClient({ address, db_name });

データベースの一覧表示

Milvusクラスタに存在するすべてのデータベースを検索するには、list_database()メソッドを使用します：

Milvusクラスタに存在するすべてのデータベースを検索するには、listDatabases()メソッドを使用します：

Milvusクラスタ内のすべての既存データベースを検索するには、listDatabases()メソッドを使用します：

Python Java Node.js
db.list_database()

# Output
['default', 'my_database']

import io.milvus.grpc.ListDatabasesResponse;
import io.milvus.param.R;

// 2. List all databases
R<ListDatabasesResponse> listDatabasesResponse = client.listDatabases();
System.out.println(listDatabasesResponse.getData());

// status {
// }
// db_names: "default"
// db_names: "my_database"
// created_timestamp: 1716794498117757990
// created_timestamp: 1716797196479639477

res = await client.listDatabases();

console.log(res.db_names);

// [ 'default', 'my_database' ]

データベースの削除

データベースを削除するには、まずすべてのコレクションを削除する必要があります。そうしないと、削除に失敗します。

データベースを削除するにはdrop_database()メソッドを使用します：

データベースを削除するには、dropDatabase()メソッドを使用します：

データベースを削除するには、dropDatabase()メソッドを使用します：

Python Java Node.js
db.drop_database("my_database")

db.list_database()

# Output
['default']

import io.milvus.param.collection.DropDatabaseParam;

DropDatabaseParam dropDatabaseParam = DropDatabaseParam.newBuilder()
    .withDatabaseName("my_database")
    .build();

response = client.dropDatabase(dropDatabaseParam);

res = await client.dropDatabase({
    db_name: "my_database",
});

データベースで RBAC を使用する

RBACはデータベース操作もカバーし、前方互換性を保証する。Permission API (Grant / Revoke / List Grant)におけるdatabaseという単語は以下の意味を持ちます：

  • Milvus接続もPermission API呼び出しもdb_name を指定しない場合、databaseはデフォルトのデータベースを指す。
  • Milvus接続でdb_name が指定されたが、その後のPermission API呼び出しで指定されなかった場合、databaseはMilvus接続で指定された名前のデータベースを参照する。
  • Milvus接続時にPermission API呼び出しが行われた場合、db_name の指定の有無にかかわらず、databaseはPermission API呼び出しで指定された名前のデータベースを参照する。

以下のコードスニペットは、以下のブロック間で共有されている。

Python Java Node.js
from pymilvus import connections, Role

_URI = "http://localhost:19530"
_TOKEN = "root:Milvus"
_DB_NAME = "default"


def connect_to_milvus(db_name="default"):
    print(f"connect to milvus\n")
    connections.connect(
        uri=_URI,
        token=_TOKEN,
        db_name=db_name
    )

String URI = "http://localhost:19530";
String TOKEN = "root:Milvus";

public class ConnectToMilvus {
    private String _dbName = "default";

    public newBuilder() {}

    public MilvusServiceClient build() {
        ConnectParam connectParam = ConnectParam.newBuilder()
            .withUri(URI)
            .withToken(TOKEN)
            .withDatabaseName(_dbNAME)
            .build();

        return new MilvusServiceClient(connectParam);
    }

    public newBuilder withDbName(String dbName) {
        this._dbName = dbName;
        return this;
    }
}

const address = "http://localhost:19530";
const token = "root:Milvus";

function connectToMilvus(dbName = "default") {
    const client = new MilvusClient({
        address,
        token,
        dbName,
    });

    return client;
}

  • Milvus接続もPermission API呼び出しもdb_name を指定しない場合、databaseはデフォルトのデータベースを参照する。

    Python JavaNode.js

    _ROLE_NAME = "test_role"
_PRIVILEGE_INSERT = "Insert"

connect_to_milvus()
role = Role(_ROLE_NAME)
role.create()

connect_to_milvus()
role.grant("Collection", "*", _PRIVILEGE_INSERT)
print(role.list_grants())
print(role.list_grant("Collection", "*"))
role.revoke("Global", "*", _PRIVILEGE_INSERT)

    String ROLE_NAME = "test_role";
String PRIVILEGE_INSERT = "Insert";

MilvusServiceClient client = new ConnectToMilvus().build();
R<RpcStatus> response = client.createRole(CreateRoleParam.newBuilder()
    .withRoleName(ROLE_NAME)
    .build());

if (response.getStatus() != R.Status.Success.getCode()) {
    throw new RuntimeException(response.getMessage());
}

response = client.grantRolePrivilege(GrantRolePriviledgeParam.newBuilder()
    .withRoleName(ROLE_NAME)
    .withObject("Collection")
    .withObjectName("*")
    .withPrivilege(PRIVILEGE_INSERT)
    .build());

if (response.getStatus() != R.Status.Success.getCode()) {
    throw new RuntimeException(response.getMessage());
}

R<SelectGrantResponse> grants = client.selectGrantForRole(SelectGrantForRoleParam.newBuilder()
    .withRoleName(ROLE_NAME)
    .build());

if (grants.getStatus() != R.Status.Success.getCode()) {
    throw new RuntimeException(grants.getMessage());
}

System.out.println(grants.getData());

grants = client.selectGrantForRoleAndObject(SelectGrantForRoleAndObjectParam.newBuilder()
    .withRoleName(ROLE_NAME)
    .withObject("Collection")
    .withObjectName("*")
    .build());

if (grants.getStatus() != R.Status.Success.getCode()) {
    throw new RuntimeException(grants.getMessage());
}

System.out.println(grants.getData());

response = client.revokeRolePrivilege(RevokeRolePrivilegeParam.newBuilder()
    .withRoleName(ROLE_NAME)
    .withObject("Global")
    .withObjectName("*")
    .withPrivilege(PRIVILEGE_INSERT)
    .build());

if (response.getStatus() != R.Status.Success.getCode()) {
    throw new RuntimeException(response.getMessage());
}

response = client.revokeRolePrivilege(RevokeRolePrivilegeParam.newBuilder()
    .withRoleName(ROLE_NAME)
    .withObject("Global")
    .withObjectName("*")
    .withPrivilege(PRIVILEGE_INSERT)
    .build());

if (response.getStatus() != R.Status.Success.getCode()) {
    throw new RuntimeException(response.getMessage());
}

    const ROLE_NAME = "test_role";
const PRIVILEGE_INSERT = "Insert";

const client = connectToMilvus();

async function demo() {}
await client.createRole({
  roleName: ROLE_NAME,
});

const grants = await client.listGrants({
  roleName: ROLE_NAME,
});

console.log(grants.grants);

await client.revokePrivilege({
  roleName: ROLE_NAME,
  object: "Global",
  objectName: "*",
  privilege: PRIVILEGE_INSERT,
});

  • Milvus 接続でdb_name が指定されたが、その後の Permission API 呼び出しで指定されなかった場合、databaseは Milvus 接続で指定された名前のデータベースを参照する。

    Python JavaNode.js

    # NOTE: please make sure the 'foo' db has been created
connect_to_milvus(db_name="foo")

# This role will have the insert permission of all collections under foo db,
# excluding the insert permissions of collections under other dbs
role.grant("Collection", "*", _PRIVILEGE_INSERT)
print(role.list_grants())
print(role.list_grant("Collection", "*"))
role.revoke("Global", "*", _PRIVILEGE_INSERT)

    // NOTE: please make sure the 'foo' db has been created
MilvusServiceClient client = new ConnectToMilvus().withDbName("foo").build();

// This role will have the insert permission of all collections under foo db,
// excluding the insert permissions of collections under other dbs
R<RpcStatus> response = client.grantRolePrivilege(GrantRolePriviledgeParam.newBuilder()
    .withRoleName(ROLE_NAME)
    .withObject("Collection")
    .withObjectName("*")
    .withPrivilege(PRIVILEGE_INSERT)
    .build());

if (response.getStatus() != R.Status.Success.getCode()) {
    throw new RuntimeException(response.getMessage());
}

R<SelectGrantResponse> grants = client.selectGrantForRole(SelectGrantForRoleParam.newBuilder()
    .withRoleName(ROLE_NAME)
    .build());

if (grants.getStatus() != R.Status.Success.getCode()) {
    throw new RuntimeException(grants.getMessage());
}

System.out.println(grants.getData());

grants = client.selectGrantForRoleAndObject(SelectGrantForRoleAndObjectParam.newBuilder()
    .withRoleName(ROLE_NAME)
    .withObject("Collection")
    .withObjectName("*")
    .build());

if (grants.getStatus() != R.Status.Success.getCode()) {
    throw new RuntimeException(grants.getMessage());
}

System.out.println(grants.getData());

response = client.revokeRolePrivilege(RevokeRolePrivilegeParam.newBuilder()
    .withRoleName(ROLE_NAME)
    .withObject("Global")
    .withObjectName("*")
    .withPrivilege(PRIVILEGE_INSERT)
    .build());

if (response.getStatus() != R.Status.Success.getCode()) {
    throw new RuntimeException(response.getMessage());
}

    const client = connectToMilvus("foo");

async function demo() {}
await client.createRole({
  roleName: ROLE_NAME,
});

const grants = await client.listGrants({
  roleName: ROLE_NAME,
});

console.log(grants.grants);

await client.revokePrivilege({
  roleName: ROLE_NAME,
  object: "Global",
  objectName: "*",
  privilege: PRIVILEGE_INSERT,
});

  • Milvus接続時にPermission API呼び出しが行われた場合、db_name の指定の有無にかかわらず、databaseはPermission API呼び出しで指定された名前のデータベースを参照する。

    Python JavaNode.js

    # NOTE: please make sure the 'foo' db has been created

db_name = "foo"
connect_to_milvus()
role.grant("Collection", "*", _PRIVILEGE_INSERT, db_name=db_name)
print(role.list_grants(db_name=db_name))
print(role.list_grant("Collection", "*", db_name=db_name))
role.revoke("Global", "*", _PRIVILEGE_INSERT, db_name=db_name)

    // NOTE: please make sure the 'foo' db has been created

String dbName = "foo";
MilvusServiceClient client = new ConnectToMilvus().build();

R<RpcStatus> response = client.grantRolePrivilege(GrantRolePriviledgeParam.newBuilder()
    .withRoleName(ROLE_NAME)
    .withObject("Collection")
    .withObjectName("*")
    .withPrivilege(PRIVILEGE_INSERT)
    .withDatabaseName(dbName)
    .build());

if (response.getStatus() != R.Status.Success.getCode()) {
    throw new RuntimeException(response.getMessage());
}

R<SelectGrantResponse> grants = client.selectGrantForRole(SelectGrantForRoleParam.newBuilder()
    .withRoleName(ROLE_NAME)
    .withDatabaseName(dbName)
    .build());

if (grants.getStatus() != R.Status.Success.getCode()) {
    throw new RuntimeException(grants.getMessage());
}

System.out.println(grants.getData());

grants = client.selectGrantForRoleAndObject(SelectGrantForRoleAndObjectParam.newBuilder()
    .withRoleName(ROLE_NAME)
    .withObject("Collection")
    .withObjectName("*")
    .withDatabaseName(dbName)
    .build());

if (grants.getStatus() != R.Status.Success.getCode()) {
    throw new RuntimeException(grants.getMessage());
}

System.out.println(grants.getData());

response = client.revokeRolePrivilege(RevokeRolePrivilegeParam.newBuilder()
    .withRoleName(ROLE_NAME)
    .withObject("Global")
    .withObjectName("*")
    .withPrivilege(PRIVILEGE_INSERT)
    .withDatabaseName(dbName)
    .build());

if (response.getStatus() != R.Status.Success.getCode()) {
    throw new RuntimeException(response.getMessage());
}

    // The Node.js SDK currently cannot support this case.

次のステップ

翻訳DeepL

目次

Try Managed Milvus for Free

Zilliz Cloud is hassle-free, powered by Milvus and 10x faster.

Get Started
フィードバック

このページは役に立ちましたか ？