selectGrant()

This operation selects the privileges granted to the specified role on the specified object.

await milvusClient.selectGrant(data)

Request Syntax

await milvusClient.selectGrant({
    roleName: string,
    object: string,
    objectName: string,
    db_name?: string,
    timeout?: number
})

PARAMETERS:

• roleName (string) -

  [REQUIRED]

  The name of the role.

• object (string) -

  The type of the object on which the privilege is granted. Possible values include Global, Collection, and User.

• objectName (string) -

  The name of the object to which the role is granted the specified privilege.

• db_name (string) -

  An optional database name.

• timeout (number) -

  An optional duration of time in milliseconds to allow for the RPC.

RETURNS:

Promise

This method returns a promise that resolves to a SelectGrantResponse object.

{
    entities: GrantEntity[],
    status: ResStatus
}

PARAMETERS:

• entities (GrantEntity[]) -

  A list of grant entities describing the privileges granted to the role.

• ResStatus

  A ResStatus object.

  • code (number) -

    A code that indicates the operation result. It remains 0 if this operation succeeds.

  • error_code (string | number) -

    An error code that indicates an occurred error. It remains Success if this operation succeeds.

  • reason (string) -

    The reason that indicates the reason for the reported error. It remains an empty string if this operation succeeds.

Example

import { MilvusClient } from '@zilliz/milvus2-sdk-node';

const milvusClient = new MilvusClient({
    address: 'localhost:19530',
    token: 'root:Milvus',
});

const res = await milvusClient.selectGrant({
    roleName: 'my_role',
    object: 'Collection',
    objectName: 'my_collection',
});