ListRowPoliciesAsync()

Lists the row policies of a collection.

public async Task<ListRowPoliciesResp> ListRowPoliciesAsync(ListRowPoliciesReq request, CancellationToken cancellationToken = default)

Request Syntax

var request = new ListRowPoliciesReq
{
    CollectionName = "my_collection"
};

ListRowPoliciesResp result = await client.ListRowPoliciesAsync(request);

REQUEST PARAMETERS:

  • DatabaseName (string?) -

    An optional database name to operate on. When empty, the client’s currently selected database is used, matching the Java/C++ SDKs’ request-level database override.

  • CollectionName (string) -

    The name of the collection to list the row policies of.

RETURN TYPE:

Task

RETURNS:

A ListRowPoliciesResp object.

  • DbName (string) -

    The database the collection belongs to.

  • CollectionName (string) -

    The name of the collection the row policies belong to.

  • Policies (IReadOnlyList) -

    The row policies of the collection. Each RowPolicyInfo exposes:

    • PolicyName (string) -

      The name of the row policy.

    • PolicyType (RowPolicyType) -

      The type of the row policy. See RowPolicyType.

    • Actions (IReadOnlyList) -

      The actions governed by the policy. See RowPolicyAction.

    • UsingExpr (string) -

      The expression used to filter rows visible to a principal.

    • CheckExpr (string) -

      The expression used to validate rows written by a principal.

    • Description (string) -

      The policy description.

EXCEPTIONS:

  • MilvusException

    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.Rls;
using Milvus.Client.V2.Responses.Rls;
using Milvus.Client.V2.Types;

using var client = new MilvusClientV2(new ConnectConfig
{
    Uri = "localhost:19530",
    Username = "root",
    Password = "Milvus"
});
await client.ConnectAsync();

ListRowPoliciesResp result = await client.ListRowPoliciesAsync(new ListRowPoliciesReq
{
    CollectionName = "my_collection"
});

Try Managed Milvus for Free

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

Get Started
Feedback

Was this page helpful?