跳到主要内容

使用 BulkWriter

如果您的数据格式不满足准备导入数据中列出的各项要求，您可以使用 PyMivus 和 Milvus Java SDK 自带的 BulkWriter 对您的数据进行转换。

概述​

BulkWriter 用于将原始数据转换成可以批量导入到目标 Collection 的格式，并在 Zilliz Cloud 控制台、Milvus SDK 的 BulkInsert 接口，以及 RESTful API 的 Import 接口中使用。目前，有如下两种 BulkWriter。

  • LocalBulkWriter 读取指定数据集并将其转换为适用的格式。

  • RemoteBulkWriter 完成 LocalBulkWriter 的所有工作，并将转换后的文件上传到指定的远程对象存储桶中。

使用步骤​

安装 PyMilvus​

在终端中运行如下命令，安装 PyMilvus 或将其升级到最新版本。

python3 -m pip install --upgrade pymilvus

创建 Collection Schema​

确定需要导入数据的目标 Collection 的 Schema。在此步骤中，您需要确定哪些字段需要被包含在 Schema 中。

下述代码创建了一个包含四个字段的 Schema。它们分别是 id、vector、scalar_1 和 scalar_2。第一个字段为主键，第二个字段为用于存储 768 维向量数据的向量字段。其它两个字段为标量字段。

另外，Schema 中还关闭了 AutoID 并开启了动态字段支持。

from pymilvus import MilvusClient, DataType

# You need to work out a collection schema out of your dataset.
schema = MilvusClient.create_schema(
    auto_id=False,
    enable_dynamic_field=True
)

schema.add_field(field_name="id", datatype=DataType.INT64, is_primary=True)
schema.add_field(field_name="vector", datatype=DataType.FLOAT_VECTOR, dim=768)
schema.add_field(field_name="scalar_1", datatype=DataType.VARCHAR, max_length=512)
schema.add_field(field_name="scalar_2", datatype=DataType.INT64)

schema.verify()

创建 BulkWriter​

PyMilvus 中有两种 BulkWriter。在本小节中，我们将了解如何创建这两种 BulkWriter。

  • LocalBulkWriter

    LocalBulkWriter 将原始数据按行添加到缓存中，然后将缓存中的数据存入一个指定格式的本地文件中。

    from pymilvus.bulk_writer import LocalBulkWriter, BulkFileType
    # 如果您的集群和 Milvus 2.4.2 及之后版本兼容
    # 需使用 `from pymilvus import LocalBulkWriter, BulkFileType` 

    writer = LocalBulkWriter(
        schema=schema,
        local_path='.',
        segment_size=512 * 1024 * 1024, # default value
        file_type=BulkFileType.NPY
    )

    在创建 LocalBulkWriter 时，您应该：

    • 在 schema 参数中引用之前创建好的 CollectionSchema 对象。

    • 在 local_path 中指定本地输出路径。

    • 在 file_type 中指定输出文件格式。

    • 如果原始数据中包含大量的数据记录，可以考虑设置 segment_size 来调整原始数据分段大小。

    关于参数设置，可以参考 SDK Reference 中关于 LocalBulkWriter 的介绍。

    📘说明

    使用 LocalBulkWriter 生成的 JSON 文件可以直接在 Zilliz Cloud 控制台上导入。

    如需导入其它格式的文件，需要先将它们上传到和集群同云的对象存储桶中。

  • RemoteBulkWriter

    和 LocalBulkWriter 不同的是，RemoteBulkWriter 将缓存中的数据写入一个远程对象存储桶中。因此，您需要先设置好用于连接该存储桶的 ConnectParam 对象，并在创建 RemoteBulkWriter 时引用该 ConnectParam 对象。

    from pymilvus import RemoteBulkWriter, BulkFileType
    # 如果您的集群和 Milvus 2.4.2 及之后版本兼容
    # 需使用 `from pymilvus import LocalBulkWriter, BulkFileType` 

    # 三方服务常量
    YOUR_ACCESS_KEY = "YOUR_ACCESS_KEY"
    YOUR_SECRET_KEY = "YOUR_SECRET_KEY"
    YOUR_BUCKET_NAME = "YOUR_BUCKET_NAME"

    # 远程存储桶连接参数
    conn = RemoteBulkWriter.S3ConnectParam(
        endpoint="oss-cn-hangzhou.aliyuncs.com", 
        # 腾讯云请使用 "cos.ap-beijing-1.myqcloud.com"
        access_key=ACCESS_KEY,
        secret_key=SECRET_KEY,
        bucket_name=BUCKET_NAME,
        secure=True
    )

    在连接参数准备就绪后，就可以在 RemoteBulkWriter 中引用了。

    from pymilvus import BulkFileType

    writer = RemoteBulkWriter(
        schema=schema,
        remote_path="/",
        connect_param=conn,
        file_type=BulkFileType.NPY
    )

除了 connect_param 参数外，RemoteBulkWriter 的参数与 LocalBulkWriter 基本相同。更多关于参数设置的信息，可以参考 SDK Reference 中关于 RemoteBulkWriter 的介绍。

开始转换​

BulkWriter 对象提供两个方法：append_row() 将原始数据按行添加到缓存中，commit() 将缓存中的数据写入一个本地文件或远程对象存储桶中。

为了方便演示，下述代码向缓存中添加随机生成的数据。

import random
import string

def generate_random_str(length=5):
    letters = string.ascii_uppercase
    digits = string.digits
    
    return ''.join(random.choices(letters + digits, k=length))

for i in range(10000):
    writer.append_row({
        "id": i, 
        "vector":[random.uniform(-1, 1) for _ in range(768)]
        "scalar_1": generate_random_str(random.randint(1, 20)),
        "scalar_2": random.randint(0, 100),
    })
    
writer.commit()

动态字段支持​

在上一节中，我们创建 BulkWriter 时引用了一个启用了动态字段的 Schema。因此，我们可以在使用 BulkWriter 向缓存中添加数据时携带 Schema 中未定义的字段。

为了方便演示，下述代码向缓存中添加随机生成的数据。

import random
import string

def generate_random_string(length=5):
    letters = string.ascii_uppercase
    digits = string.digits
    
    return ''.join(random.choices(letters + digits, k=length))

for i in range(10000):
    writer.append_row({
        "id": i, 
        "vector":[random.uniform(-1, 1) for _ in range(768)],
        "scalar_1": generate_random_string(),
        "scalar_2": random.randint(0, 100),
        "dynamic_field_1": random.choice([True, False]),
        "dynamic_field_2": random.randint(0, 100)
    })
    
writer.commit()

验证结果​

您可以通过打印 BulkWriter 的 data_path 属性来获取实际输出路径。

print(writer.data_path)

# LocalBulkWriter
# 'folder/45ae1139-1d87-4aff-85f5-0039111f9e6b'

# RemoteBulkWriter
# '/folder/5868ba87-743e-4d9e-8fa6-e07b39229425'

BulkWriter 生成一个 UUID，并使用该 UUID 在指定的输入路径下创建一个子路径，然后将生成的文件放在创建的子路径下。您也可以单击此处下载根据上述部署生成的示例数据文件。

生成的数据目录结构如下所示：