GrantPrivilege()

This method grants a privilege

func (c *Client) GrantPrivilege(ctx context.Context, option GrantPrivilegeOption, callOptions ...grpc.CallOption) error

Request Parameters

Parameter	Description	Type
ctx	Context for the current call to work.	context.Context
option	Optional parameters of the methods.	GrantPrivilegeOption
callOptions	Optional parameters for calling the methods.	grpc.CallOption

GrantPrivilegeOption

This is an interface type. The grantPrivilegeOption struct type implements this interface type.

You can use the NewGrantPrivilegeOption() function to get the concrete implementation.

NewGrantPrivilegeOption

The signature of the NewGrantPrivilegeOption() is as follows:

func NewGrantPrivilegeOption(roleName, objectType, privilegeName, objectName string) *grantPrivilegeOption

Parameter	Description	Type
roleName	Name of the target role of this operation.	string
objectType	Type of the object on which the specified role can perform operations. Possible values are as follows: Global System-wide objects, allowing the user to perform actions that affect all collections, users, or system-wide settings. When object_type is set to Global, set object_name to the wildcard (*), indicating all objects of the specified type. Collection Collection-specific objects, allowing the user to perform actions such as creating indexes, loading data, inserting or deleting data, and querying data within a specific collection. User Objects related to user management, allowing the user to manage credentials and roles for database users, such as updating user credentials or viewing user details.	string
privilegeName	Name of the privilege to assign. For details, refer to the Privilege name column in the table on page Users and Roles.	string
objectName	Name of the target object. For example, If the object type is Collection, the object name should be the name of an existing collection. If the object type is User, the object name should be a database user. If the object type is Global, set the object name to a wildcard (*), indicating all objects of the specified type.	string

grpc.CallOption

This interface provided by the gRPC Go library allows you to specify additional options or configurations when making requests. For possible implementations of this interface, refer to this file.

Return

Null

Example

ctx, cancel := context.WithCancel(context.Background())
defer cancel()

cli, err := milvusclient.New(ctx, &milvusclient.ClientConfig{
    Address: milvusAddr,
})
if err != nil {
    // handle error
}

defer cli.Close(ctx)

readOnlyPrivileges := []*entity.RoleGrants{
    {Object: "Global", ObjectName: "*", PrivilegeName: "DescribeCollection"},
    {Object: "Global", ObjectName: "*", PrivilegeName: "ShowCollections"},
    {Object: "Collection", ObjectName: "quick_setup", PrivilegeName: "Search"},
}

for _, grantItem := range readOnlyPrivileges {
    err := cli.GrantPrivilege(ctx, milvusclient.NewGrantPrivilegeOption("my_role", grantItem.Object, grantItem.PrivilegeName, grantItem.ObjectName))
    if err != nil {
        // handle error
    }
}