Django-Sphinx 项目技术文档

1. 安装指南

安装最新稳定版本

sudo easy_install django-sphinx

安装最新开发版本

git clone git://github.com/dcramer/django-sphinx.git
cd django-sphinx
sudo python setup.py install

注意事项

• 你需要将 sphinxapi.py 包安装到你的 Python 路径中，或者使用项目中包含的版本。
• 如果使用项目中包含的版本，你需要在 settings.py 文件中指定以下内容：

# Sphinx 0.9.9
SPHINX_API_VERSION = 0x116

# Sphinx 0.9.8
SPHINX_API_VERSION = 0x113

# Sphinx 0.9.7
SPHINX_API_VERSION = 0x107

2. 项目使用说明

基本用法

from djangosphinx.models import SphinxSearch

class MyModel(models.Model):
    search = SphinxSearch()  # 可选：默认为 db_table
    # 如果你的索引名称与 MyModel._meta.db_table 不匹配
    search = SphinxSearch('index_name')

    # 或者你可能想要更具体
    searchdelta = SphinxSearch(
        index='index_name delta_name',
        weights={
            'name': 100,
            'description': 10,
            'tags': 80,
        },
        mode='SPH_MATCH_ALL',
        rankmode='SPH_RANK_NONE',
    )

queryset = MyModel.search.query('query')
results1 = queryset.order_by('@weight', '@id', 'my_attribute')
results2 = queryset.filter(my_attribute=5)
results3 = queryset.filter(my_other_attribute=[5, 3, 4])
results4 = queryset.exclude(my_attribute=5)[0:10]
results5 = queryset.count()

# 从 2.0 版本开始，你可以通过属性访问权重和其他参数
for result in results1:
    print result, result._sphinx
# 你也可以在 queryset 本身上访问类似的元数据（一旦它被切片或以任何方式执行）
print results1._sphinx

其他方法

• count()
• extra()（传递给 queryset）
• all()（无操作）
• select_related()（传递给 queryset）
• group_by(field, field, field)
• set_options(index='', weights={}, weights=[], mode='SPH_MODE_*', rankmode='SPH_MATCH_*')

多索引查询

from djangosphinx.models import SphinxSearch

SphinxSearch('index1 index2 index3').query('hello')

3. 项目API使用文档

配置生成

from djangosphinx.utils import *

from myproject.myapp.models import MyModel

output = generate_config_for_model(MyModel)

print output

多模型配置生成

model_classes = (ModelOne, ModelTwoWhichResemblesModelOne)

output = generate_config_for_models(model_classes)

命令行生成配置

./manage.py generate_sphinx_config <appname>

4. 项目安装方式

使用配置生成器

# 基本路径为 sphinx 文件的根目录。子目录将包括 data, log, 和 run。
SPHINX_ROOT = '/var/sphinx-search/'

# 可选，默认为 'conf/sphinx.html'。这应该是配置模板。
SPHINX_CONFIG_TEMPLATE = 'conf/sphinx.html'

使用 Sphinx 命令

# 索引你的数据
DJANGO_SETTINGS_MODULE=myproject.settings indexer --config /path/to/djangosphinx/config.py --all --rotate

# 启动守护进程
DJANGO_SETTINGS_MODULE=myproject.settings searchd --config /path/to/djangosphinx/config.py

# 查询守护进程
DJANGO_SETTINGS_MODULE=myproject.settings search --config /path/to/djangosphinx/config.py my query

# 杀死守护进程
kill -9 $(cat /var/sphinx-search/run/searchd.pid)

注意事项

• 确保你的 PYTHON_PATH 设置正确！