milvus-logo
LFAI
< Docs
  • Python
    • MilvusClient

MilvusClient

A MilvusClient instance represents a Python client that connects to a specific Milvus instance.

pymilvus.MilvusClient

Constructor

Constructs a client for common use cases.

notes

This client serves as an easy-to-use alternative for the current set of APIs that handles Create, Read, Update, and Delete (CRUD) operations in Milvus.

MilvusClient(
    uri: str,
    user: str,
    password: str,
    db_name: str,
    token: str,
    timeout=None,
    **kwargs
)

PARAMETERS:

  • uri (string) -

    The URI of the Milvus instance. For example:

    http://localhost:19530
    
  • user (string) -

    A valid username used to connect to the specified Milvus instance.

    Use this if authentication has been enabled on the target Milvus instance. To enable authentication, refer to Authenticate User Access.

    This should be used along with password.

  • password (string) -

    A valid password used to connect to the specified Milvus instance.

    Use this if authentication has been enabled on the target Milvus instance. To enable authentication, refer to Authenticate User Access.

    This should be used along with user.

  • db_name (string) -

    The name of the database to which the target Milvus instance belongs.

  • token (string) -

    A valid access token to access the specified Milvus instance.

    This can be used as a recommended alternative to setting user and password separately.

    When setting this field, notice that:

    A valid token should be a pair of username and password used to access the target cluster, joined by a colon (:). For example, you can set this to root:Milvus, which is the default credential of the root user.

    Use this if authentication has been enabled on the target Milvus instance. To enable authentication, refer to Authenticate User Access.

  • timeout (float | None)

    The timeout duration for this operation.

    Setting this to None indicates that this operation timeouts when any response arrives or any error occurs.

Examples

from pymilvus import MilvusClient

# Authentication not enabled
client = MilvusClient("http://localhost:19530")

# Authentication enabled with the root user
client = MilvusClient(
    uri="http://localhost:19530",
    token="root:Milvus",
    db_name="default"
)

# Authentication enabled with a non-root user
client = MilvusClient(
    uri="http://localhost:19530",
    token="user:password", # replace this with your token
    db_name="default"
)