更新时间:2017-06-07 13:26
管理应用的基本信息,包括 创建应用(save)、修改应用(updateById)、删除应用(removeById)、获取应用的基本详情(getById)、获取应用列表(listAll)、给应用导入全量数据(reindexById)等方法。
void OpenSearch\Client\AppClient::__construct( $openSearchClient)
参数名称 | 类型 | 描述 |
---|---|---|
$openSearchClient | \OpenSearch\Client\OpenSearchClient | 基础类,负责计算签名,和服务端进行交互和返回结果。 |
创建一个新的应用或者创建一个新的版本,如果在$app中指定了name,则会创建一个新版本,否则会创建一个新应用。
创建版本的个数依赖服务端的限制。
\OpenSearch\Generated\Common\OpenSearchResult OpenSearch\Client\AppClient::save( $app)
参数名称 | 类型 | 描述 |
---|---|---|
$app | string | 要创建的应用主体JSON,包含name、type、schema、quota、first_ranks、second_ranks、summary、data_sources、suggest、fetch_fields、query_processors等信息。 |
通过应用名称或者应用ID获取一个应用的详情信息。
\OpenSearch\Generated\Common\OpenSearchResult OpenSearch\Client\AppClient::getById( $identity)
参数名称 | 类型 | 描述 |
---|---|---|
$identity | string | 要查询的应用名称或者应用ID,如果应用有多个版本,则指定应用名称为当前应用的在线版本。 |
获取当前账号下的应用列表。
\OpenSearch\Generated\Common\OpenSearchResult OpenSearch\Client\AppClient::listAll( $pageable)
参数名称 | 类型 | 描述 |
---|---|---|
$pageable | \OpenSearch\Generated\Common\Pageable | 分页信息,包含页码和每页展示条数。 |
\OpenSearch\Generated\Common\OpenSearchResult OpenSearch\Client\AppClient::removeById( $identity)
参数名称 | 类型 | 描述 |
---|---|---|
$identity | string | 指定的应用ID或者应用名称。 |
通过调用该函数,并指定需更新应用名称或者应用ID更新应用信息。
\OpenSearch\Generated\Common\OpenSearchResult OpenSearch\Client\AppClient::updateById( $identity, $app)
参数名称 | 类型 | 描述 |
---|---|---|
$identity | string | 指定的应用ID或者应用名称;当指定的为应用名称,则表示指定的为当前应用分组中的在线的应用。 |
$app | string | 修改一个应用的应用结构json,包含name、type、schema、quota、first_ranks、second_ranks、summary、data_sources、suggest、fetch_fields、query_processors等信息。 |
触发指定应用索引重建,配有数据源,会做带全量数据导入的索引重建。
\OpenSearch\Generated\Common\OpenSearchResult OpenSearch\Client\AppClient::reindexById( $identity)
参数名称 | 类型 | 描述 |
---|---|---|
$identity | string | 指定的应用ID或者应用名称;当指定的为应用名称,则表示指定的为当前应用分组中的在线的应用。 |
在文档使用中是否遇到以下问题
更多建议
匿名提交