全部产品
开放搜索

文档操作

更新时间:2017-06-07 13:26:11   分享:   

构造函数

请求参数

参数名称 类型 描述
indexName string 指定操作的应用名称。
client CloudsearchClient cloudsearch客户端
opts array 可选参数

函数定义

function __construct($indexName, $client, $opts = array())

使用示例

$app_name = "你的应用名称";
$doc_obj = new CloudsearchDoc($app_name, $client);

查看文档

根据文档id获取doc的详细信息。

请求参数

参数名称 类型 描述
docId string 指定的文档id。

返回结果

类型 描述
string 该docId对应的doc详细信息

函数定义

function detail($docId)

使用示例

$result = $doc_obj->detail($docId);

更新文档

向指定的表中更新doc。

请求参数

参数名称 类型 描述
docs array 指定要更新的doc。
tableName string 指定向哪个表中更新doc。

返回结果

类型 描述
string 返回API返回的结果。

函数定义

function update($docs, $tableName)

使用示例

$doc_obj->update($docs,$table_name);

添加文档

向指定的表中增加doc。

请求参数

参数名称 类型 描述
docs array 指定要添加的doc。
tableName string 指定向哪个表中增加doc。

返回结果

类型 描述
string 返回API返回的结果。

函数定义

function add($docs, $tableName)

使用示例

$doc_obj->add($docs,$table_name);

删除文档

删除指定表中的doc。

请求参数

参数名称 类型 描述
docs array 指定要删除的doc列表,必须含有主键。
tableName string 指定要从哪个表删除记录。

返回结果

类型 描述
string 返回API返回的结果。

函数定义

function remove($docs, $tableName)

使用示例

$doc_obj->remove($docs,$table_name);

通过csv格式文件上传文档数据

NOTE: 此文件必需为csv格式的文件(“,”分割);且第一行为数据结构字段名称,例如: id, title, name, date,1, "我的测试数据\"1\"测试1", test_name1, "2013-09-21 00:12:22"

...

请求参数

参数名称 类型 描述
fileName string 本地文件。
primaryKey string 指定此表的主键。
tableName string 指定表名。
multiValue array 指定此表中的多值的字段。默认值为空
offset int 指定从第offset条记录开始导入。默认值为1
maxSize number 指定每次push数据的最大值,单位为MB。默认值为4
frequence int 指定上传数据的频率,默认值为4,单位为次/秒

返回结果

类型 描述
string 返回如果成功上传或上传失败的状态。

函数定义

function pushCSVFile($fileName, $primaryKey, $tableName,$multiValue = array(), $offset = 1, $maxSize = self::PUSH_MAX_SIZE,$frequence = self::PUSH_FREQUENCE)

使用示例

//其他字段使用默认值
$result = $doc_obj->pushCSVFile($fileName,$primaryKey,$tableName);

推送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=xxxxxxxxx^

multivalue_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);
本文导读目录
本文导读目录
以上内容是否对您有帮助?