describe()

Near Deprecation

此操作描述当前 Collection。

请求语法

python

describe(timeout: float | None)

参数：

• timeout (float | None)

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

返回类型：

dict

返回值：

包含指定 Collection 详细信息的字典。

python

{
    'collection_name': 'test_01',
    'auto_id': False,
    'num_shards': 1,
    'description': '',
    'fields': [
          {
              'field_id': 100,
              'name': 'id',
              'description': '',
              'type': 5,
              'params': {},
              'element_type': 0,
              'is_primary': True
          },
          {
              'field_id': 101,
              'name': 'vector',
              'description': '',
              'type': 101,
              'params': {
                  'dim': 768
              },
              'element_type': 0
          }
     ],
     'aliases': [],
     'collection_id': 446738261026541332,
     'consistency_level': 2,
     'properties': {},
     'num_partitions': 1
}

参数：

• collection_name (str) -

  当前 Collection 的名称。

• auto_id (bool) -

  Zilliz Cloud 是否为该 Collection 自动生成主键。

• num_shards (int) -

  当前 Collection 拥有的分片数。

• description (str)

  当前 Collection 的描述。

• fields (list)

  当前 Collection 中的字段列表。

  • field_id (int)

    当前字段的 ID。

  • name (str)

    当前字段的名称。

  • description (str)

    当前字段的描述。

  • type (int)

    当前字段的类型。详情请参见 DataType。

  • params (dict)

    当前字段的附加属性。

    • 对于 VARCHAR 字段，max_length (int) 是一个可能的属性，用于确定当前字段值中的字符数。

    • 对于 FLOAT_VECTOR 字段，dim (int) 是一个可能的属性，用于确定当前字段值中的向量嵌入数量。

  • element_type (int)

  • is_primary (bool)

    当前字段是否作为该 Collection 的主键。

• aliases (list)

  Collection 别名列表。您可以使用列表中的任一别名来使用当前 Collection。

• collection_id (int)

  当前 Collection 的 ID。Zilliz Cloud 会在创建每个 Collection 时为其分配一个 ID。

• consistency_level (int)

  当前 Collection 的一致性级别。详情请参见 ConsistencyLevel。

• properties (dict)

• num_partitions (int)

  当前 Collection 中的 Partition 数量。

异常：

• DescribeCollectionException

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

示例

python

from pymilvus import Collection, CollectionSchema, FieldSchema, DataType

schema = CollectionSchema([
    FieldSchema("id", DataType.INT64, is_primary=True),
    FieldSchema("vector", DataType.FLOAT_VECTOR, dim=5)
])

# Create a collection
collection = Collection(
    name="test_collection",
    schema=schema
)

# Get detailed information about the collection
collection.describe()

# Output
# {
#     'collection_name': 'test_01',
#     'auto_id': False,
#     'num_shards': 1,
#     'description': '',
#     'fields': [
#           {
#               'field_id': 100,
#               'name': 'id',
#               'description': '',
#               'type': 5,
#               'params': {},
#               'element_type': 0,
#               'is_primary': True
#           },
#           {
#               'field_id': 101,
#               'name': 'vector',
#               'description': '',
#               'type': 101,
#               'params': {
#                   'dim': 768
#               },
#               'element_type': 0
#           }
#      ],
#      'aliases': [],
#      'collection_id': 446738261026541332,
#      'consistency_level': 2,
#      'properties': {},
#      'num_partitions': 1
# }

相关操作

• drop()

• flush()

• get_replicas()

• set_properties()