DescribeRole()

Describe an role.

Status DescribeRole(const DescribeRoleRequest& request, DescribeRoleResponse& response)

Request Syntax

auto request = DescribeRoleRequest()
    .WithRoleName(name)
    .WithDatabaseName(db_name);

REQUEST METHODS:

• WithRoleName(const std::string& name)

  Set name of the role.

• WithDatabaseName(const std::string& db_name)

  Set database name which the role is assigned.

RETURNS:

Status

Returns a status indicating whether the operation succeeded.

ERROR HANDLING:

• std::exception

  Thrown when request construction, transport, or response processing fails. Inspect the exception message or returned Status for failure details.

Example

Demonstrates DescribeRole() with the C++ SDK.

auto client = milvus::MilvusClientV2::Create();
milvus::ConnectParam connect_param{"http://localhost:19530", "root:Milvus"};
util::CheckStatus(client->Connect(connect_param));

auto request = milvus::DescribeRoleRequest();
milvus::DescribeRoleResponse response;
util::CheckStatus(client->DescribeRole(request, response));