createDatabase()
This operation creates a database.
createDatabase(data): Promise<ResStatus>
This method applies only to dedicated clusters.
Request Syntax​
milvusClient.createDatabase({
db_name: string,
properties?: Object
timeout?: number
})
PARAMETERS:
-
db_name (string) -
The name of the database to create.
There should be no database that has the specified name. Otherwise, exceptions will occur.
-
properties (Object) -
Properties to set along with database creation. Possible database properties are as follows:
-
database.replica.number (int) -
Number of replicas for the database.
-
database.resource_groups ([]str) -
Resource groups dedicated to the database.
-
database.diskQuota.mb (int) -
Disk quota allocated to the database in megabytes (MB).
-
database.max.collections (int) -
Maximum number of collections allowed in the database.
-
database.force.deny.writing (bool) -
Whether to deny all write operations in the database.
-
database.force.deny.reading (bool) -
Whether to deny all read operations in the database.
-
-
timeout (number) -
The timeout duration for this operation.
Setting this to None indicates that this operation timeouts when any response arrives or any error occurs.
RETURNS Promise |<ResStatus>
This method returns a promise that resolves to a ResStatus object.
{
code: number,
error_code: string | number,
reason: string
}
PARAMETERS:
-
code (number) -
A code that indicates the operation result. It remains 0 if this operation succeeds.
-
error_code (string | number) -
An error code that indicates an occurred error. It remains Success if this operation succeeds.
-
reason (string) -
The reason that indicates the reason for the reported error. It remains an empty string if this operation succeeds.
Example​
const milvusClient = new milvusClient(MILUVS_ADDRESS);
const resStatus = await milvusClient.createDatabase({ db_name: 'new_db' });