跳到主要内容

create_resource_group()

Near Deprecation

此操作将创建一个新的资源组。

📘Note

什么是资源组?

资源组可以容纳 Zilliz Cloud 集群中的部分或全部查询节点。当您通过调用 load() 加载一个 Collection 时,Zilliz Cloud 会将该 Collection 的数据加载到某些查询节点中。

每个 Zilliz Cloud 集群中都有一个名为 __default_resource_group 的默认资源组,它包含该集群的所有查询节点。

使用 describe_resource_group() 检查实际数量。如果有多个可用的查询节点,请考虑创建资源组并在它们之间分配查询节点。

请求语法

python
create_resource_group(
name: str,
using: str,
timeout: float | None,
**kwargs
)

参数:

  • name (str) -

    【必填】

    要创建的资源组名称。

    如果将其设置为现有资源组的名称,则会导致 MilvusException

  • using (str) -

    所使用连接的别名。

    默认值为 default,表示此操作使用默认连接。

  • timeout (float | None)

    此操作的超时时长。将其设置为 None 表示当收到任意响应或发生任意错误时,此操作即超时。

  • kwargs

    可选参数。当前,您可以设置 config 来指定资源组的配置。

    • config (ResourceGroupConfig) -

      表示资源组配置的 ResourceGroupConfig 对象。

      python
      ├── ResourceGroupConfig
      │ ├── requests
      │ │ └── node_num
      │ └── limits
      │ └── node_num
      • requests (dict) -

        用于指定资源组应持有的查询节点数量的字典。此键应包含:

        • node_num (int) - 资源组请求的查询节点数量。
      • limits (dict) -

        用于指定资源组可持有的最大查询节点数量的字典。此键应包含:

        • node_num (int) - 资源组允许持有的最大查询节点数量。

返回类型:

NoneType

返回:

None

异常:

  • MilvusException

    当此操作期间发生任何错误时,将引发此异常。

示例

python
from pymilvus import connections, utility

# Connect to YOUR_CLUSTER_ENDPOINT
connections.connect()

# Create a resource group

name = "rg" # A resource group name should be a string of 1 to 255 characters, starting with a letter or an underscore (_) and containing only numbers, letters, and underscores (_).
node_num = 1

config = utility.ResourceGroupConfig(
requests={'node_num': node_num}, # The number of query nodes that the resource group should hold.
limits={'node_num': node_num} # The maximum number of query nodes that the resource group can hold.
)

try:
utility.create_resource_group(
name, # The name of the resource group to be created.
using='default', # The database to use.
config=config, # The configuration of the resource group.
)
print(f'Succeeded in creating resource group {name}.')
except Exception:
print(f'Failed to create resource group {name}.')

以下操作与 create_resource_group() 相关:

最低 SDK 版本Inherit
Ctrl I