跳转到主要内容

将Sphinx生成的文档索引到elasticsearch中

项目描述

将通过Sphinx构建的文档项目索引到elasticsearch中。这是readthedocs.org使用的功能的独立提取,与elasticsearch-6兼容。

使用方法

设置

  • 安装 elasticsearch

  • 安装包: virtualenv --python=python3 .; bin/pip install sphinx_elasticsearch

  • 创建索引: bin/sphinx-elasticsearch create-index --es-url=http://localhost:9200 --replicas=1 --shards=5 bin/sphinx-elasticsearch put-mapping --es-url=http://localhost:9200

默认情况下,我们使用名为< span class="docutils literal"> docs 的索引和文档类型< span class="docutils literal"> page ,您可以通过< span class="docutils literal"> --index 和< span class="docutils literal"> --type 参数进行自定义(但您需要将它们传递给所有三个命令,create-index、put-mapping和index)。

注意,您可能最好自己管理索引创建和映射设置;这两个设置命令更多的是为了快速入门和直接使用。

索引您的sphinx项目

  • 将项目构建为JSON格式(便于解析):bin/sphinx-build -b json . json-build

  • 索引到ES:bin/sphinx-elasticsearch index --es-url=http://localhost:9200 --index=docs json-build (如果传递--commit,则之前索引的已删除页面将被自动删除。)

Elasticsearch映射

project:

项目的简称。客户端将使用它来构建URL。

path:

页面的相对路径,不包含扩展名。

id:

唯一标识符(项目路径的哈希值)

commit:

可选,允许在后续索引运行中删除已删除的页面。

title:

页面的标题

headers:

页面上的所有标题列表

content:

页面的正文(ES将移除任何HTML标记)

sphinx_elasticsearch变更

1.0.1 (2018-12-11)

  • 在索引后和删除前刷新,以防止冲突错误

1.0.0 (2018-12-09)

  • 初始发布

项目详情


下载文件

下载适用于您的平台的文件。如果您不确定选择哪个,请了解有关安装包的更多信息。

源分布

sphinx_elasticsearch-1.0.1.tar.gz (9.5 kB 查看哈希值

支持者: