PhpSDK的文档如何操作？（4）
推送HA3格式文档
除了上面的方法还可以通过文件将文档导入到指定的表中 这里的文档需满足一定的格式，我们称之为HA3文档格式。HA3文件的要求如下：
文件编码：UTF-8
支持CMD: add, delete,update。
如果给出的字段不是全部，add会在未给出的字段加默认值，覆盖原值；update只会更新给出的字段，未给出的不变。
文件分隔符：
<pre>
编码-------描述--------------------显示形态
"\x1E\n" 每个doc的分隔符. ^^(接换行符)
"\x1F\n" 每个字段key和value分隔 ^_(接换行符)
"\x1D" 多值字段的分隔符 ^]
</pre>;
示例：
<pre>;
CMD=add^_
url=
http://www.opensearch.console.aliyun.com^_
title=开放搜索^_
body=xxxxx
xxxx^
multi
value_feild=123^]1234^]12345^
^^
CMD=update^_
...
</pre>
注意：文件结尾的分隔符也必需为"^^\n"，最后一个换行符不能省略。
请求参数
| 参数名称 | 类型 | 描述 |
| fileName | string | 指定HA3DOC所有在的路径。 |
| tableName | string | 指定要导入的表的名称。 |
| offset | int | 指定偏移行数，如果非0，则从当前行一下的数据开始导入。默认值为：1 |
| maxSize | number | 指定每次导入到api接口的数据量的大小，单位MB，默认值为：4 |
| frequence | int | 指定每秒钟导入的频率，单位次/秒，默认值为：4 |
返回结果
| 类型 | 描述 |
| string | 返回导入成功标志。 |
函数定义
function pushHADocFile($fileName, $tableName, $offset = 1,$maxSize = self::PUSH_MAX_SIZE, $frequence = self::PUSH_FREQUENCE)
使用示例
//其他参数使用默认值$doc_obj->pushHADocFile($fileName,$tableName);
版权声明：本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
在阿里云的OpenSearch服务中，如果您需要通过HA3文档格式批量导入数据到指定的索引表，可以参考以下步骤和说明来实现这一过程。
HA3文档格式要求
- 文件编码：必须为UTF-8。
- 命令类型：支持
add、delete、update三种操作命令，分别用于添加、删除、更新文档。 - 字段分隔符：
- 每个文档之间的分隔符为
\x1E\n（即^^\n）。 - 每个字段的键值对分隔符为
\x1F\n（即^_\n）。 - 多值字段内的元素分隔符为
\x1D（即^]）。
- 每个文档之间的分隔符为
-
示例文档结构：
CMD=add^_ url=http://www.opensearch.console.aliyun.com^_ title=开放搜索^_ body=xxxxx multi_value_field=123^]1234^]12345^ ^^ CMD=update^_ ...
导入函数使用方法
假设您已经有一个与阿里云OpenSearch服务交互的客户端对象$doc_obj，并且该对象包含一个方法pushHADocFile用于上传HA3格式的文档。以下是调用此方法的一个示例：
// 假设$fileName是HA3文档的路径，$tableName是要导入的表名
$fileName = "path_to_your_ha3_file.txt";
$tableName = "your_table_name";
// 使用默认参数进行导入
$response = $doc_obj->pushHADocFile($fileName, $tableName);
// 根据响应处理结果
if ($response === '成功标志') {
echo "文档导入成功！";
} else {
echo "文档导入失败，请检查文件或参数设置。";
}
请求参数说明
- fileName：字符串类型，指定存放HA3文档的路径。
- tableName：字符串类型，指定目标索引表的名称。
- offset：整型，默认值为1，表示从文件的第几行开始导入。如果设置为非零值，则跳过前面的行数。
- maxSize：数值型，默认值通常由具体实现定义，单位MB，控制每次导入API接口的数据量大小。
- frequence：整型，默认值也是由具体实现定义，单位次/秒，用来限制导入频率，避免对系统造成过大压力。
请根据实际需求调整这些参数，并确保您的HA3文档完全符合格式要求，以保证数据能够被正确导入至阿里云OpenSearch服务中。
