get_bulk_insert_state()

Near Deprecation

此操作返回指定 bulk-insert 任务的状态。

请求语法

python

get_bulk_insert_state(
    task_id: int,
    timeout: float | None,
    using: str = "default",
    **kwargs,
)

python

from pymilvus import connections, utility
connections.connect()

task_id = utility.do_bulk_insert(
    collection_name="string",
    files=["string.npy", "string.npy"],
)

# Get bulk-insert task state
res = utility.get_bulk_insert_state(task_id=task_id)

参数：

• task_id (int) -
  [必填]

  由 do_bulk_insert() 函数返回的任务 ID。

• using (str) -

  所使用连接的别名。

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

• timeout (float | None)

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

返回类型：

BulkInsertState

返回： 包含指定 bulk-insert 任务状态信息的 BulkInsertState。

python

├── BulkInsertState
│   ├── task_id 
│   ├── state 
│   ├── state_name   
│   ├── row_count
│   ├── progress
│   └── infos
│       ├── files
│       ├── collection
│       ├── partition
│       ├── failed_reason
│       ├── progress_percent
│       └── persist_cost
│   ├── ids
│   ├── id_ranges
│   ├── files
│   ├── create_timestamp
│   ├── create_time_str
│   └── collection_name

BulkInsertState 对象包含以下字段

• task_id (int)

  由 do_bulk_insert() 函数返回的任务 ID。

• state (int)

  指定 bulk_insert 任务的整数状态。可能的值如下：

  • 0：表示任务处于待处理状态

  • 1：表示任务失败。

  • 2：表示任务已启动。

  • 5：表示数据已持久化。

  • 6：表示任务已完成。

  • 7：表示任务失败且数据已被清理。

  • 100：表示任务处于未知状态。

• state_name (str)

  指定 bulk_insert 任务的整数状态。可能的值为以下整数：

  • Pending：表示任务处于待处理状态

  • Failed：表示任务失败。

  • Started：表示任务已启动。

  • Persisted：表示数据已持久化。

  • Completed：表示任务已完成。

  • FailedAndCleaned：表示任务失败且数据已被清理。

  • Unknown：表示任务处于未知状态。

• row_count (int)

  当前 bulk-insert 任务中已插入的 Entity 数量。

• progress (int)

  当前 bulk-insert 任务的进度。

• infos (dict)

  包含当前 bulk-insert 任务信息的字典。可能的键如下：

  • files (str)

    当前 bulk-insert 任务中涉及的文件名称，以逗号分隔的字符串形式表示。

  • collection (str)

    目标 Collection 的名称。

  • partition (str)

    目标 Partition 的名称。

  • failed_reason (str)

    bulk-insert 失败的原因。如果任务成功，则此项为空字符串。

  • progress_percent (str)

    当前 bulk-insert 任务的百分比进度。

  • persist_cost (str)

    当前 bulk-insert 任务的持久化耗时。

• ids (list)

  以列表形式表示的已插入 Entity 的 ID。

• id_ranges (google._upb._message.RepeatedScalarContainer)

• 范围形式的已插入 Entity ID。

• files (str)

  当前 bulk-insert 任务中涉及的文件名称，以逗号分隔的字符串形式表示。

• create_timestamp (int)

  当前 bulk-insert 任务创建时的时间戳。

• create_time_str (str)

  当前 bulk-insert 任务创建时的时间戳，以人类可读的字符串形式表示。

• collection_name (str)

  目标 Collection 的名称。

异常：

• MilvusException

  如果此操作期间发生任何错误，将引发此异常。

示例

python

from pymilvus import connections, utility

# Connect to YOUR_CLUSTER_ENDPOINT
connections.connect()

# Bulk-insert data
task_id = utility.do_bulk_insert(
    collection_name="test_collection",
    files=["data/id.npy", "data/vector.npy"],
) # 446781855410077319

# Get bulk-insert task state
res = utility.get_bulk_insert_state(task_id=task_id)

# <Bulk insert state:
#     - taskID          : 446781855410077319,
#     - state           : Completed,
#     - row_count       : 10000,
#     - infos           : {'files': 'data/id.npy,data/vector.npy', 'collection': 'test_collection_2', 'partition': '_default', 'failed_reason': '', 'progress_percent': '100', 'persist_cost': '0.34'},
#     - id_ranges       : [],
#     - create_ts       : 2024-01-06 22:24:07
# >

相关操作

以下操作与get_bulk_insert_state()相关：

• BulkInsertState

• do_bulk_insert()

• list_bulk_insert_tasks()