Xapian-haystack 技术文档

1. 安装指南

首先，您需要在您的机器上安装 Xapian。可以使用提供的脚本来安装，例如 install_xapian.sh。在激活虚拟环境后调用该脚本进行安装：

source <path>/bin/activate
./install_xapian.sh <version>

其中 <version> 必须大于等于 1.4.0。这个过程大约需要10分钟。

完成 Xapian 的安装后，最后通过以下命令安装 Xapian-haystack：

pip install xapian-haystack

2. 项目的使用说明

Xapian-haystack 是一个为 Django-Haystack 提供的 Xapian 搜索引擎后端。它支持以下标准特性：

• 权重
• 多维度搜索（日期、查询等）
• 排序
• 拼写建议
• EdgeNGram 和 Ngram（用于自动完成）

请注意，Xapian-haystack 不支持 endswith 搜索操作。

在使用之前，您需要在 Django 项目的配置文件中设置 Haystack 连接。以下是一个示例配置：

HAYSTACK_CONNECTIONS = {
    'default': {
        'ENGINE': 'xapian_backend.XapianEngine',
        'PATH': os.path.join(os.path.dirname(__file__), 'xapian_index')
    },
}

此外，还有一些可选的设置参数，您可以根据需求进行配置。

3. 项目API使用文档

Xapian-haystack 的 API 使用与 Django-Haystack 的其他后端类似。您可以通过配置文件中的 HAYSTACK_CONNECTIONS 来使用不同的参数，例如：

• HAYSTACK_XAPIAN_LANGUAGE: 设置 Xapian 的词干语言。
• HAYSTACK_XAPIAN_WEIGHTING_SCHEME: 设置影响权重计算的参数。
• HAYSTACK_XAPIAN_FLAGS: 设置解析查询时使用的选项。
• HAYSTACK_XAPIAN_STEMMING_STRATEGY: 选择 Xapian 使用的词干策略。
• XAPIAN_NGRAM_MIN_LENGTH 和 XAPIAN_NGRAM_MAX_LENGTH: 自定义 n-gram（短语）长度。
• HAYSTACK_XAPIAN_USE_LOCKFILE: 是否使用锁文件来防止在运行管理命令时出现数据库锁定错误。

4. 项目安装方式

项目的安装方式已在安装指南中说明。首先通过脚本安装 Xapian，然后使用 pip 命令安装 Xapian-haystack。

以上就是 Xapian-haystack 的技术文档。如果您在使用过程中有任何问题，可以随时在项目的 GitHub 仓库中提出问题或发起 pull request。同时，您也可以在 django-haystack 的邮件列表或 irc #haystack 频道中咨询。