功能
索引配置
简述菜单功能 对ES索引字段的定义,类似于关系型数据库的表的定义,该菜单定义了索引的主健、描述、版本、属性字段以及全量同步数据来源(从接口定义获取),对索引进行增删改查的管理。
- 菜单路径:
搜索中心
>索引配置
索引配置管理列表
列表字段:
- 索引:索引编码
- 版本:版本号,同一个索引会存在多个版本号,每次对索引的修改,相当于版本的升级,会全量同步数据。
- 状态:有效/失效
- 描述:对当前索引的描述
- 数据来源:从接口定义获取,显示为接口定义的编码
查询
查询字段:
- 索引:索引编码,支持模糊查询
- 版本:版本号
- 状态:列表选择状态
- 描述:对当前索引的描述
- 数据来源:列表选择数据来源,支持模糊查询
点击按钮可根据查询字段筛选出对应信息。 查询结果如下图所示:
新建
点击按钮,进入新建界面, 如下图所示:
必输字段:
- 索引:索引编码,唯一标识
- 数据来源:列表选择数据来源,从接口定义中创建
非必输字段
- 描述:对当前索引的描述
- 分片数量:ES分配数量的设置
- 副本数量:ES副本数量的设置
- 同步字段:该索引的全量字段配置
- 点击添加同步字段如下:
- 填写字段,点击保存完成。
- 如果需要删除,则通过每一列的操作点击删除按钮进行操作。
编辑
- 在列表操作列点击编辑按钮,进入编辑界面。
- 只能在失效的情况下才能进行编辑。可以修改描述、数据来源、同步字段,其它字段不允许修改。
- 如果需要删除同步字段,则通过每一列的操作点击删除按钮进行操作
- 点击按钮完成修改。
升版
- 在列表操作列点击升版按钮,进入升级版本界面。
- 除了索引和版本不可以修改,其他都能修改。
- 点击按钮完成修改,修改完成后会新创建一条索引,版本自动更新+1,原版本变为失效状态。
有效/失效
- 在列表操作列点击有效/失效,进行索引的状态切换。
- 同一个索引修改为有效时,其他版本会修改为无效(一个索引只会有一个有效的版本)。
同步
- 在列表操作列点击编辑按钮或者升版按钮,进入到操作界面,出现的操作按钮。
- 只有有效状态下的索引才允许同步。
- 点击同步按钮会触发从配置的接口数据源的全量同步。
使用 HZERO 增量同步
简述菜单功能 主要应用于索引配置完成,全量更新完成后,不再进行ES全量数据更新,只需要通过数据源更新部分字段的业务场景。
- 菜单路径:
搜索中心
>增量同步
增量同步配置列表
列表字段:
- 索引:关联索引的编码
- 版本:关联索引的版本号
- 最近同步时间:最后一次同步时间
- 数据来源:同步的数据源,从接口定义获取,显示为接口定义的编码
- 描述:对当前增量同步数据的描述
- 回调:同步成功后的回调地址,从接口定义获取,显示为接口定义的编码
查询
查询字段:
- 索引:关联索引的编码
- 版本:关联索引的版本号
- 数据来源:列表选择数据来源
- 回调:列表选择数据来源
- 最近同步时间从:时间选择框
- 最近同步时间至:时间选择框
- 描述:对当前索引的描述,支持模糊查询
点击按钮可根据查询字段筛选出对应信息。 查询结果如下图所示:
新建
点击按钮,进入新建界面, 如下图所示:
必输字段:
- 索引:关联索引的编码
- 数据来源:列表选择数据来源,从接口定义中创建
- 回调:列表选择数据来源,从接口定义中创建
非必输字段
- 描述:对当前索引的描述
- 同步字段:增量字段配置
- 保存后,出现按钮,点击新增添加同步字段如下:
- 选择关联字段,字段来源于当前选择的索引字段。
- 映射字段可以进行修改。
- 点击完成创建。
编辑
- 在列表操作列点击编辑按钮,进入编辑界面。
- 可以修改描述、数据来源、回调,其它字段不允许修改。
- 点击按钮完成修改。
同步
- 在列表操作列点击编辑按钮,进入到操作界面,出现的操作按钮。
- 点击同步按钮会触发从配置的接口数据源的全量同步。
删除
- 在列表操作列点击删除按钮,将该条增量同步数据删除。
使用 HZERO 接口定义
简述菜单功能 此功能用于维护搜索中心中的接口定义,为搜索全量/增量同步提供数据源。
- 菜单路径:
搜索中心
>接口定义
接口定义列表
列表字段:
- 接口编码:接口唯一标识。
- 服务名称:可访问的服务编码。
- 接口权限编码:服务权限编码。
- 接口说明:接口用途描述。
- 状态: 有效/失效
- 来源: 预定义、自定义。
- 操作:可编辑和删除接口定义。
查询
查询字段:
- 接口编码:接口定义的唯一标识。支持模糊查询。
- 服务名称:列表选择服务。
- 接口说明:接口定义的描述信息。支持模糊查询。 点击按钮可根据查询字段筛选出对应信息。 查询结果如下图所示:
新建
点击按钮,进入新建界面, 如下图所示:
必输字段:
- 接口编码:接口定义的唯一标识。
- 服务名称: 列表选择服务。
- 接口权限编码: 选择完服务名称之后才能选择列表选择接口权限编码。
- 接口说明:默认由选中的接口权限编码的描述填充,可修改。
- 状态:表明此接口是否有效。
非必输字段:
- 参数:接口定义的参数。
- 添加参数如下:
- 点击按钮,弹出参数维护界面。如图所示:
- 填写字段,其中红星标识为必输字段。
- 点击确定完成参数添加。
- 字段填写完毕后,点击按钮完成新建。
编辑
- 在列表操作列点击编辑按钮,进入编辑界面。
- 只能编辑服务名称、接口权限编码、接口说明。其它字段不允许修改。
- 点击按钮完成修改。
删除
- 在列表操作列点击删除按钮。
- 删除提示中点击确定完成删除。
使用 HZERO 查询配置
索引预定义查询条件管理 ,配置查询API,可应用已定义好的查询字段、顺序、是否显示等,也可以自己随意写条件,定义好只会,只需要通过传入定义的查询API编码,和需要的查询参数,进行统一接口查询调用,获取查询结果。
- 菜单路径:
搜索中心
>查询配置
查询配置列表
列表字段:
- 编码:查询配置唯一标识
- 索引:关联索引的编码
- 版本号:关联索引的版本号
- 状态:查询状态是否生效
- 描述:对当前查询配置的描述
查询
查询字段:
- 编码:查询配置唯一标识
- 索引:关联索引的编码
- 版本号:关联索引的版本号
- 状态:列表选择状态
- 描述:对当前查询配置的描述,支持模糊查询 点击按钮可根据查询字段筛选出对应信息。 查询结果如下图所示:
新建
点击按钮,进入新建界面, 如下图所示:
必输字段:
- 编码:查询配置的唯一标识
- 索引:关联索引的编码
- 状态:是否有效,有效/失效
非必输字段
- 描述:对当前索引的描述
- 查询JSON:自定义查询条件
- 字段表信息:增量字段配置
- 保存后,出现按钮,点击新增添加字段如下:
- 选择字段名称,字段来源于当前选择的索引字段。
- 点击完成创建。
编辑
- 在列表操作列点击编辑按钮,进入编辑界面。
- 可以修改描述、查询JSON、字段表信息,是否启用,其它字段不允许修改。
- 点击按钮完成修改。
测试
- 在列表操作列点击编辑按钮,进入到操作界面,出现的操作按钮。
- 点击测试,根据你填写的查询JSON的参数会出现,对应的参数界面,点击会显示出接口查询出来的结果。
使用 HZERO 同步日志
全量同步和增量同步后的结果记录,可以方便查看到同步的历史记录。
- 菜单路径:
搜索中心
>同步日志
同步日志查询列表
列表字段:
- 触发事件:触发事件类型
- 同步状态:同步是否成功
- 索引:关联索引的编码
- 版本号:关联索引的版本号
- 触发时间:触发同步的时间
- 同步时间:同步完成的时间
查询
查询字段:
- 触发事件:触发事件类型,下拉列表选择
- 同步状态:同步是否成功,下拉列表选择
- 索引:关联索引的编码,通过LOV选择,并带出版本号
- 版本号:关联索引的版本号,不可填写
- 触发时间从:触发同步的时间从
- 触发时间至:触发同步的时间至
- 同步时间从:同步完成的时间从
- 同步时间至:同步完成的时间至 点击按钮可根据查询字段筛选出对应信息。 查询结果如下图所示:
详情
- 查看详情,无法编辑任何字段
点击按钮,进入详情界面, 如下图所示: