CreateRowPolicyAsync()
Creates a row policy on a collection. A row policy filters the rows visible to a principal (UsingExpr) and validates the rows written by a principal (CheckExpr).
public async Task CreateRowPolicyAsync(CreateRowPolicyReq request, CancellationToken cancellationToken = default)
Request Syntax
var request = new CreateRowPolicyReq
{
CollectionName = "my_collection",
PolicyName = "policy_1",
PolicyType = RowPolicyType.Permissive,
Actions = [RowPolicyAction.Query, RowPolicyAction.Insert],
UsingExpr = "age > 18",
CheckExpr = "age > 18",
Description = "Allows rows where age > 18"
};
await client.CreateRowPolicyAsync(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 create the row policy for.
PolicyName(string) -The name of the row policy to create.
PolicyType(RowPolicyType) -The type of the row policy: permissive or restrictive. See RowPolicyType. Defaults to
RowPolicyType.Permissive, matching the server’s default for an omitted value.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.
RETURN TYPE:
Task
RETURNS:
This method does not return a value.
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.Rls;
using Milvus.Client.V2.Types;
using var client = new MilvusClientV2(new ConnectConfig
{
Uri = "localhost:19530",
Username = "root",
Password = "Milvus"
});
await client.ConnectAsync();
await client.CreateRowPolicyAsync(new CreateRowPolicyReq
{
CollectionName = "my_collection",
PolicyName = "policy_1",
PolicyType = RowPolicyType.Permissive,
Actions = [RowPolicyAction.Query, RowPolicyAction.Insert],
UsingExpr = "age > 18",
CheckExpr = "age > 18",
Description = "Allows rows where age > 18"
});