跳到主要内容

list_bulk_insert_tasks()

Near Deprecation

此操作列出所有批量插入任务。

请求语法​

python
list_bulk_insert_tasks(
limit: int = 0,
collection_name: list[str] | None,
timeout: float | None,
using: str = "default",
)

参数:

  • limit (int) -

    要返回的任务数量。

    该值默认为 0,表示不设限制。

  • collection_name (list[str]) -

    Collection 名称列表。

    该值默认为 None,表示包含所有 Collection。

  • using (str) -

    所使用连接的别名。

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

  • timeout (float | None)

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

返回类型:

list

返回: 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
  • 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)

    当前批量插入任务中已插入的 Entity 数量。

  • progress (int)

    当前批量插入任务的进度。

  • infos (dict)

    包含当前批量插入任务信息的字典。可能的键如下:

    • files (str)

      以逗号分隔的字符串形式表示当前批量插入任务涉及的文件名。

    • collection (str)

      目标 Collection 的名称。

    • partition (str)

      目标 Partition 的名称。

    • failed_reason (str)

      批量插入失败的原因。如果任务成功,则该值为空字符串。

    • progress_percent (str)

      当前批量插入任务的百分比进度。

    • persist_cost (str)

      当前批量插入任务的持久化耗时。

  • ids (list)

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

  • id_ranges (google._upb._message.RepeatedScalarContainer)

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

  • files (str)

    以逗号分隔的字符串形式表示当前批量插入任务涉及的文件名。

  • create_timestamp (int)

    当前批量插入任务创建时的时间戳。

  • create_time_str (str)

    当前批量插入任务创建时的时间戳,以人类可读的字符串形式表示。

  • collection_name (str)

    目标 Collection 的名称。

异常:

  • MilvusException

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

示例​

python
from pymilvus import connections, utility

# Connect to YOUR_CLUSTER_ENDPOINT
connections.connect()

# List all bulk-insert tasks
res = utility.list_bulk_insert_tasks()

以下操作与 list_bulk_insert_state() 相关:

最低 SDK 版本Inherit