DescribeDatabaseAsync()
Describes a database.
public async Task<DescribeDatabaseResp> DescribeDatabaseAsync(DescribeDatabaseReq request, CancellationToken cancellationToken = default)
Request Syntax
var request = new DescribeDatabaseReq
{
DatabaseName = "book_db"
};
DescribeDatabaseResp response = await client.DescribeDatabaseAsync(request);
REQUEST PARAMETERS:
DatabaseName(string) -The name of the database to describe.
RETURN TYPE:
Task
RETURNS:
A DescribeDatabaseResp object that contains the database details.
DescribeDatabaseResp
DatabaseName // -> string
DbId // -> long
CreatedTimestamp // -> ulong
Properties // -> IReadOnlyDictionary<string, string>
PARAMETERS:
DatabaseName (string) -
The name of the database.
DbId (long) -
The ID of the database.
CreatedTimestamp (ulong) -
The timestamp at which the database was created.
Properties (IReadOnlyDictionary
) - The properties of the database, keyed by property name.
EXCEPTIONS:
-
Thrown when the RPC fails or the server returns an error. Inspect the exception message for details.
Example
using Milvus.Client.V2;
using Milvus.Client.V2.Requests.Database;
using Milvus.Client.V2.Responses.Database;
using Milvus.Client.V2.Types;
using var client = new MilvusClientV2(new ConnectConfig
{
Uri = "localhost:19530",
Username = "root",
Password = "Milvus"
});
await client.ConnectAsync();
DescribeDatabaseResp response = await client.DescribeDatabaseAsync(new DescribeDatabaseReq
{
DatabaseName = "book_db"
});