跳到主要内容

add_connection()

Near Deprecation

此操作可批量为多个 Zilliz Cloud 集群添加用于不同目的的连接。

请求语法​

python
add_connection(
default: dict,
# add other connections
# your_conn_name: dict
)

参数:

  • kwargs -

    传递关键字参数时,每个参数的名称都会在 connect() 方法中用作连接别名。

    参数值应为一个字典,其中包含以下一个或多个字段:

    • address (string) -

      要连接的实际地址。示例地址:YOUR_CLUSTER_ENDPOINT。

    • uri (string) -

      Zilliz Cloud 集群的 URI。例如:https://in01-*****************.aws-us-west-2.vectordb-uat3.zillizcloud.com:19540.

    • host (string) -

      Zilliz Cloud 集群的主机。该值默认为 localhost;如果仅提供 port,PyMilvus 将填充默认主机。

    • port (string | int) -

      Zilliz Cloud 集群监听的端口。该值默认为 19530;如果仅提供 host,PyMilvus 将填充默认端口。

    • user (string) -

      用于连接指定 Zilliz Cloud 集群的有效用户名。

      应与 password 一起使用。

    • password (string) -

      用于连接指定 Zilliz Cloud 集群的有效密码。

      应与 user 一起使用。

    • token (string) -

      用于访问指定 Zilliz Cloud 集群的有效访问令牌。此字段可作为分别设置 user 和 password 的替代方式。

      设置此字段时,请注意:

      有效的令牌应为以下任一项

      • 具有足够权限的 API key,或

      • 用于访问目标集群的一组用户名和密码,并以冒号(:)连接。例如,您可以将其设置为 username:p@ssw0rd。

Note

如何获取集群 Endpoint 和令牌?

  • 集群 Endpoint

    您可以登录 Zilliz Cloud 控制台,然后在左侧导航栏中单击 Clusters。在集群列表中,单击目标集群名称,复制 Connect 区域中的 Endpoint,并将其用作上述 URI。

  • 访问令牌

    要连接到 Zilliz Cloud 集群,您可以使用以下任一方式

    • API key

      您可以登录 Zilliz Cloud 控制台,然后在左侧导航栏中单击 API Keys。

    • 一组用于访问集群的用户名和密码,并以冒号(:)连接。

      您可以使用在 Zilliz Cloud 控制台创建集群时指定的集群凭据,或任何现有集群用户的凭据。

返回类型:

None

返回值:

None

异常:

  • ConnectionConfigException

    当连接配置无效时,将引发此异常。

示例​

python
from pymilvus import connections

SERVERLESS_ENDPOINT = "https://in03-************.api.gcp-us-west1.zillizcloud.com"
SERVERLESS_TOKEN = "db_admin:************"
DEDICATED_ENDPOINT = "https://in03-************.api.gcp-us-west1.zillizcloud.com:19541"
DEDICATED_USER = "db_admin"
DEDICATED_PASS = "*****************"

connections.add_connection(
serverless={"uri": SERVERLESS_ENDPOINT, "token": SERVERLESS_TOKEN},
dedicated={"uri": DEDICATED_ENDPOINT, "user": DEDICATED_USER, "password": DEDICATED_PASS}
)

以下操作与 add_connection() 相关:

最低 SDK 版本Inherit