Role

A Role instance represents a role with specific privileges to access your Milvus instanceZilliz Cloud clusters.

class pymilvus.Role

Constructor

Constructs a role by name and other parameters.

Role(
    name: str,
    using: str
)

notes

Calling the constructor alone does not create the role. You have to explicitly call the create() method of the role object to create the role.

PARAMETERS:

name (string) -

[REQUIRED]

The name of the role to create.
using (string) -

The alias of the employed connection.

The default value is default, indicating that this operation employs the default connection.

RETURN TYPE:

Role

RETURNS:

A role object.

EXCEPTIONS:

MilvusException

This exception will be raised when any error occurs during this operation.

from pymilvus import Role

# Create a role
role = Role(
    name="admin",
)

The following are the methods of the Role class:

Was this page helpful?