ListRLSPrincipals()

Lists principals that have stored row-level-security tags in a collection.

Status ListRLSPrincipals(const ListRLSPrincipalsRequest& request, ListRLSPrincipalsResponse& response)

Request Syntax

auto request = milvus::ListRLSPrincipalsRequest()
    .WithDatabaseName("default")
    .WithCollectionName("messages");

REQUEST METHODS:

  • WithDatabaseName(const std::string& db_name)

    Sets the database name. Use the default database when it is empty.

  • SetDatabaseName(const std::string& db_name)

    Sets the database name. Use the default database when it is empty.

  • WithCollectionName(const std::string& collection_name)

    Sets the collection whose principals are listed.

  • SetCollectionName(const std::string& collection_name)

    Sets the collection whose principals are listed.

RETURNS:

Status

Returns a Status indicating whether the operation succeeded.

  • response (ListRLSPrincipalsResponse) -

    • PrincipalNames (const std::vector&) -

      Returns the principal names.

ERROR HANDLING:

  • Status

    Failures are reported through the returned Status. The SDK converts internal exceptions into a non-OK Status; public API calls do not throw. Inspect status.IsOk() and status.Message() for failure details. See Status.

Example

#include "milvus/MilvusClientV2.h"
#include <iostream>

auto client = milvus::MilvusClientV2::Create();
milvus::ConnectParam connect_param{"http://localhost:19530", "root:Milvus"};
auto status = client->Connect(connect_param);
if (!status.IsOk()) {
    std::cout << status.Message() << std::endl;
}
milvus::ListRLSPrincipalsRequest request;
request.WithCollectionName("messages");
milvus::ListRLSPrincipalsResponse response;
status = client->ListRLSPrincipals(request, response);
if (!status.IsOk()) {
    std::cout << status.Message() << std::endl;
}
for (const auto& principal : response.PrincipalNames()) {
    std::cout << principal << '\n';
}

Try Managed Milvus for Free

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

Get Started
Feedback

Was this page helpful?