admin 管理员组

文章数量: 888297


2024年2月20日发(作者:挂载nfs access denied)

Coreseek 全文检索服务器 2.0 (Sphinx 0.9.8)参考手册文档版本:v0.9目录 1. 简介

1.1. 什么是 Sphinx

1.2. Sphinx 的特性

1.3. 如何获得 Sphinx

1.4. 许可协议

1.5. 作者和贡献者

1.6. 开发历史

2. 安装

2.1. 支持的操作系统

2.2. 依赖的工具

2.3. 安装 Sphinx

2.4. 已知的问题和解决方法

2.5. Sphinx 快速入门教程

3. 建立索引

3.1. 数据源

3.2. 属性

3.3. 多值属性 ( MVA : multi-valued attributes)

3.4. 索引

3.5. 数据源的限制

3.6. 字符集 , 大小写转换 , 和转换表

3.7. SQL 数据源 (MySQL, PostgreSQL)

3.8. xmlpipe 数据源

3.9. xmlpipe2 数据源

3.10. 实时索引 更新

3.11. 索引合并

4. 搜索

4.1. 匹配模式

4.2. 布尔查询

4.3. 扩展查询

4.4. 权值计算

4.5. 排序模式

4.6. 结果分组(聚类)

4.7. 分布式搜索

4.8. searchd 日志格式

5. API 参考

5.1. 通用 API 方法

5.1.1. GetLastError5.1.2. GetLastWarning5.1.3. SetServer

5.1.4. SetRetries5.1.5. SetArrayResult 5.2. 通用搜索设置

5.2.1. SetLimits5.2.2. SetMaxQueryTime 5.3. 全文搜索设置

5.3.1. SetMatchMode5.3.2. SetRankingMode5.3.3. SetSortMode5.3.4. SetWeights5.3.5. SetFieldWeights5.3.6. SetIndexWeights 5.4. 结果集过滤设置

5.4.1. SetIDRange5.4.2. SetFilter5.4.3. SetFilterRange5.4.4. SetFilterFloatRange5.4.5. SetGeoAnchor 5.5. GROUP BY 设置

5.5.1. SetGroupBy5.5.2. SetGroupDistinct 5.6. 搜索

5.6.1. Query5.6.2. AddQuery5.6.3. RunQueries5.6.4. ResetFilters5.6.5. ResetGroupBy 5.7. 额外的方法

5.7.1. BuildExcerpts5.7.2. UpdateAttributes 6. MySQL 存储引擎 (SphinxSE)

6.1. SphinxSE 概览

6.2. 安装 SphinxSE

6.2.1. 在 MySQL 5.0.x 上 编译 SphinxSE

6.2.2. 在 MySQL 5.1.x 上编译 SphinxSE

6.2.3. SphinxSE 安装测试

6.3. 使用 SphinxSE

7. 报告 bugs

8. 选项参考

8.1. Data source 配置选项

8.1.1. type8.1.2. sql_host8.1.3. sql_port8.1.4. sql_user8.1.5. sql_pass8.1.6. sql_db8.1.7. sql_sock8.1.8. mysql_connect_flags8.1.9. sql_query_pre8.1.10. sql_query

8.1.11. sql_query_range8.1.12. sql_range_step8.1.13. sql_attr_uint8.1.14. sql_attr_bool8.1.15. sql_attr_timestamp8.1.16. sql_attr_str2ordinal8.1.17. sql_attr_float8.1.18. sql_attr_multi8.1.19. sql_query_post8.1.20. sql_query_post_index8.1.21. sql_ranged_throttle8.1.22. sql_query_info8.1.23. xmlpipe_command8.1.24. xmlpipe_field8.1.25. xmlpipe_attr_uint8.1.26. xmlpipe_attr_bool8.1.27. xmlpipe_attr_timestamp8.1.28. xmlpipe_attr_str2ordinal8.1.29. xmlpipe_attr_float8.1.30. xmlpipe_attr_multi 8.2. 索引配置选项

8.2.1. type8.2.2. source8.2.3. path8.2.4. docinfo8.2.5. mlock8.2.6. morphology8.2.7. stopwords8.2.8. wordforms8.2.9. exceptions8.2.10. min_word_len8.2.11. charset_type8.2.12. charset_table8.2.13. ignore_chars8.2.14. min_prefix_len8.2.15. min_infix_len8.2.16. prefix_fields8.2.17. infix_fields8.2.18. enable_star8.2.19. ngram_len8.2.20. ngram_chars8.2.21. phrase_boundary8.2.22. phrase_boundary_step8.2.23. html_strip8.2.24. html_index_attrs8.2.25. html_remove_elements8.2.26. local8.2.27. agent8.2.28. agent_connect_timeout8.2.29. agent_query_timeout8.2.30. preopen8.2.31. charset_dictpath

8.3. indexer 程序配置选项

8.3.1. mem_limit8.3.2. max_iops8.3.3. max_iosize 8.4. searchd 程序配置选项

8.4.1. address8.4.2. port8.4.3. log8.4.4. query_log8.4.5. read_timeout8.4.6. max_children8.4.7. pid_file8.4.8. max_matches8.4.9. seamless_rotate8.4.10. preopen_indexes8.4.11. unlink_old1. 简介1.1. 什么是SphinxSphinx 是一个在GPLv2 下发布的一个全文检索引擎,商业授权(例如, 嵌入到其他程序中)需要联系我们()以获得商业授权。一般而言,Sphinx是一个独立的搜索引擎,意图为其他应用提供高速、低空间占用、高结果相关度的全文搜索功能。Sphinx可以非常容易的与SQL数据库和脚本语言集成。当前系统内置MySQL和PostgreSQL 数据库数据源的支持,也支持从标准输入读取特定格式的XML数据。通过修改源代码,用户可以自行增加新的数据源(例如:其他类型的DBMS的原生支持)。搜索API支持PHP、Python、Perl、Rudy和Java,并且也可以用作MySQL存储引擎。搜索API非常简单,可以在若干个小时之内移植到新的语言上。Sphinx 是SQL Phrase Index的缩写,但不幸的和CMU的Sphinx项目重名。Coreseek

全文检索服务器2.0

是在Sphinx基础上开发的全文检索软件,按照GPLv2协议发行。Coreseek ()

为sphinx在中国地区的用户提供支持服务,如果您不希望纠缠与琐碎的技术细节,请直接联系我。本文可能存在潜在的翻译错误,如果您发现本文的翻译错误,请联系我:我的联系方式:coreseek@

李沫南1.2. Sphinx的特性高速的建立索引(在当代CPU上,峰值性能可达到10 MB/秒);高性能的搜索(在2 – 4GB 的文本数据上,平均每次检索响应时间小于0.1秒);可处理海量数据(目前已知可以处理超过100 GB的文本数据, 在单一CPU的系统上可处理100 M 文档);提供了优秀的相关度算法,基于短语相似度和统计(BM25)的复合Ranking方法;

支持分布式搜索;provides document exceprts generation;可作为MySQL的存储引擎提供搜索服务;支持布尔、短语、词语相似度等多种检索模式;文档支持多个全文检索字段(最大不超过32个);文档支持多个额外的属性信息(例如:分组信息,时间戳等);停止词查询;支持单一字节编码和UTF-8编码;原生的MySQL支持(同时支持MyISAM 和InnoDB );原生的PostgreSQL 支持.1.3. 如何获得SphinxSphinx 可以从官方网站/ 下载,支持中文分词的Sphinx可以从/ 下载。

目前,Sphinx的发布包包括如下软件:indexer: 用于创建全文索引;search: 一个简单的命令行(CLI) 的测试程序,用于测试全文索引;searchd: 一个守护进程,其他软件可以通过这个守护进程进行全文检索;sphinxapi: 一系列searchd 的客户端API 库,用于流行的Web脚本开发语言(PHP,

Python, Perl, Ruby)。1.4. 许可 协议This program is free software; you can redistribute it and/or modify it under the terms of the GNU

General Public License as published by the Free Software Foundation; either version 2 of the

License, or (at your option) any later version. See COPYING file for details.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;

without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR

PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if

not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA

02111-1307 USA

If you don't want to be bound by GNU GPL terms (for instance, if you would like to embed Sphinx

in your software, but would not like to disclose its source code), please contact the author to obtain

a commercial license.

1.5. 作者和贡献者作者Sphinx 的最初作者和目前的主要开发人员:

Andrew Aksyonoff, 贡献者为Sphinx的开发出过力的人员和他们的贡献如下(以下排名不分先后):

Robert "coredev" Bengtsson (Sweden), initial version of PostgreSQL data source;Len Kranendonk, Perl APIDmytro Shteflyuk, Ruby API此外,还有许多人提出了宝贵的想法、错误报告以及修正。在此一并致谢。1.6. 历史Sphinx 的开发工作可以上溯到2001年,当时作者试图为一个数据库驱动的网站寻找一个可接受的搜索的解决方案,但是当时没有任何方案能够满足要求。事实上,主要是如下问题:

搜索质量(例如:有效的相关度算法)

单纯的统计学方法的效果非常糟糕,特别是在大量的短篇文档的集合上,例如:论坛、博客等等。搜索速度特别是当搜索的短语包括“停止词”时,表现的尤其明显,例如:"to be or not

to be"建立索引时,可控的磁盘和CPU消耗在虚拟主机的环境下,这一点的重要性要超过对索引构造速度的要求年复一年,其他的解决方案有了很多改进,但是,我个人认为仍然没有一种解决方案足够的好,能让我将搜索平台迁移过去。去年,Sphinx的用户给了我很多正面的反馈,因此,显而易见的,Sphinx的开发过程将会继续(也许将持续到世界末日)。2. 安装2.1. 支持的操作系统在绝大多数现代的Unix类操作系统上,只需要一个C++编译器就可以编译并运行Sphinx,而不需要对源码进行任何改动。目前,Sphinx可以在以下系统上运行:

Linux 2.4.x, 2.6.x (包括各种发行版)Windows 2000, XPFreeBSD 4.x, 5.x, D 1.6, 3.0Solaris 9, 11Mac OS X支持的CPU种类包括X86, X86-64, SPARC64。我希望Sphinx也能够在其他的Unix平台上工作,如果你运行Sphinx使用的操作系统不在上面的名单中,请告诉我。

目前的阶段,Sphinx的Windows版可用于测试和调试,但不建议用于生产系统。最突出的两个问题是:1)缺少并发查询的支持;2)缺少索引数据热切换的支持。虽然目前已经有成功的生产环境克服了这两个问题,仍然不推荐在Windows下运行Sphinx提供高强度的搜索服务。

2.2. 依赖的工具在UNIX平台上,你需要以下的工具用来编译和安装Sphinx:C++编译器。GNU gcc 就能够干这个活。make程序。GNU make 就能够干这个活。在Windows平台上,你需要Microsoft Visual C/C++ Studio .NET 2003 or 2005。其他的编译器/开发环境也许也能搞定这件事,但你可能需要自己手工制作他们所需的Makefile或者工程文件。2.3. 安装Sphinx1.将你下载的tar包解压,并进入sphinx 子目录:$ tar xzvf $ cd sphinx2.运行configuration 程序:$ ./configureconfigure程序有很多运行选项。完整的列表可以通过使用 --help 开关得到。最重要的如下:--prefix, 定义将Sphinx安装到何处;--with-mysql, 当自动检测失败时,指出在那里能找到MySQL 头文件和库文件;--with-pgsql, 指出在那里能找到PostgreSQL头文件和库文件。3.制作二进制程序:$ make4.按照二进制程序到你选好的目录下:$ make install2.4. 已知的问题和解决方法如果configure 程序没有找到MySQL 的头文件和库文件,请试图检查 mysql-devel 这个包是否安装了。在有些系统上,默认安装包括这个包。如果make程序给出如下错误提示,/bin/sh: g++: command not foundmake[1]: *** [libsphinx_a-sphinx.o] Error 127请检查gcc-c++ 这个包是否安装了。如果你在编译时得到如下错误:67: error: invalid application of `sizeof' to incomplete type `Private::SizeError'这意味着某些编译时的类型检查失败了,一个最有可能的原因是在你的系统上类型off_t的长度小于64bit。一个快速的修复手段是,你可以修改sphinx.h ,将在定义类型SphOffset_t

处,将off_t 替换成DWORD,需要注意,这种改动将使你的全文索引文件不能超过2GB。

即便这种修改有用,也请汇报这一问题,在汇报中请包括具体的错误信息以及操作系统编译器的配置情况。这样,我可能能够在下一个版本中解决这一问题。如何你遇到了其他的任何问题,或者前面的建议对你没有帮助,别犹豫,请立刻联系我。2.5. Sphinx 快速入门教程以下所有的例子都假设你将sphinx安装在目录 /usr/local/sphinx 中了。

为了使用Sphinx,你需要:

1.创建配置文件缺省的配置文件名为。全部的Sphinx提供的程序默认都在当前工作的目录下寻找该文件。由configure 程序生成的示例配置文件 中包括全部选项的注释,复制并编辑这个文件使之适用于你的具体情况:$ cd /usr/local/sphinx/etc$ cp $ vi 在示例配置文件中,将试图对MySQL数据库test中的documents 表建立索引;因此在这里还提供了 用于给测试表增加数据用于测试:$ mysql -u test < /usr/local/sphinx/etc/2.运行indexer 创建你的全文索引:$ cd /usr/local/sphinx/etc$ /usr/local/sphinx/bin/indexer3.检索你新创建的索引!你可以使用search实用程序可以从命令行对索引进行检索:$ cd /usr/local/sphinx/etc$ /usr/local/sphinx/bin/search test如果要从PHP脚本检索索引,你需要:1.运行守护进程searchd,PHP脚本需要连接到searchd上进行检索 :$ cd /usr/local/sphinx/etc$ /usr/local/sphinx/bin/searchd2.运行PHP API 附带的test 脚本(运行之前请确认searchd守护进程已启动):

$ cd sphinx/api$ php test3.将API文件(位于api/) 包含进你自己的脚本,开始编程。

搜索愉快!

3. 建立索引3.1. 数据源索引的数据可以来自各种各样不同的来源:SQL数据库、纯文本、HTML文件、邮件等等。从Sphinx的视角看,索引数据是一个结构化的文档的集合,其中每个文档是字段的集合,这和SQL数据库的视角有所不同,在那里,每一行代表一个文档,每一列代表一个字段。由于数据来源的不同,需要不同的代码来获取数据、处理数据以供Sphinx进行索引的建立。这种代码被称之为数据源驱动程序(简称:驱动或数据源)。在本文撰写时,Sphinx中包括MySQL和PostgreSQL数据源的驱动程序,这些驱动使用数据库系统提供的C/C++原生接口连接到数据库服务器并获取数据。此外,Sphinx还提供了额外的被成为xmlpipe的数据源驱动,该驱动运行某个具体的命令,并从该命令的输出中读入数据。数据的格式在 3.8, “xmlpipe 数据源 ” 中有介绍。如果确有必要,一个索引的数据可以来自多个数据源。这些数据将严格按照配置文件中定义的顺序进行处理。所有从这些数据源获取到的文档将被合并,共同产生一个索引,如同他们来源于同一个数据源一样。3.2. 属性属性是附加在每个文档上的额外的信息(值),可以在搜索的时候用于过滤和排序。搜索结果通常不仅仅是进行文档的匹配和相关度的排序,经常还需要根据其他与文档相关联的值,对结果进行额外的处理。例如,用户可能需要对新闻检索结果依次按日期和相关度排序,检索特定价格范围内的产品,检索某些特定用户的blog日志,或者将检索结果按月分组。为了高效地完成上述工作,Sphinx允许给文档附加一些额外的值,并把这些值存储在全文索引中,以便在对全文匹配结果进行过滤、排序或分组时使用。论坛帖子表是一个很好的例子。假设只有帖子的标题和内容这两个字段需要全文检索,但是有时检索结果需要被限制在某个特定的作者的帖子或者属于某个子论坛的帖子中(也就是说,只检索在SQL表的author_id和forum_id这两个列上有特定值的那些行),或者需要按post_date列对匹配的结果排序,或者根据post_date列对帖子按月份分组,并对每组中的帖子计数。为实现这些功能,可以将上述各列(除了标题和内容列)作为属性做索引,之后即可使用API调用来设置过滤、排序和分组。以下是一个例子:示例:片断:...sql_query = SELECT id, title, content, author_id, forum_id, post_date FROM my_forum_postssql_attr_uint = author_idsql_attr_uint = forum_idsql_attr_timestamp = 示例: 应用程序代码 (PHP):// only search posts by author whose ID is 123$cl->SetFilter ( "author_id", array ( 123 ) );

// only search posts in sub-forums 1, 3 and 7$cl->SetFilter ( "forum_id", array ( 1,3,7 ) );// sort found posts by posting date in descending order$cl->SetSortMode ( SPH_SORT_ATTR_DESC, "post_date" );可以通过名字来指示特定的属性,并且这个名字是大小写无关的(注意:直到目前为止,Sphinx还不支持中文作为属性的名称)。属性并不会被全文索引,他们只是按原封不动的存储在索引文件中。目前支持的属性类型如下:无符号整数(1-32位宽)UNIX 时间戳(timestamps)浮点值(32位,IEEE 754单精度)字符串叙述 (尤其是计算出的整数值); 多值属性 MVA (multi-value attributes)(32位无符号整形值的变长序列).由各个文档的全部的属性信息构成了一个集合,它也被称为文档信息(docinfo),docinfo可以按如下两种方式之一存储:与全文索引数据分开存储(“外部存储”,在.spa文件中存储)在全文索引数据中,每出现一次文档ID 就出现相应的文档信息(“内联存储”,在.spd文件中存储).当采用外部存储方式时,searchd总是在RAM中保持一份.spa文件的拷贝(该文件包含所有文档的所有文档信息)。这是主要是为了提高性能,因为磁盘的随机访问太慢了。相反,内联存储并不需要任何额外的RAM,但代价是索引文件的体积大大地增加了;请注意,全部属性值在文档ID出现的每一处都被复制了一份,而文档ID出现的次数恰是文档中不同关键字的数目。仅当有一个很小的属性集、庞大的数据集和受限的RAM时,内联存储才是一个可考虑的选择。在大多数情况下,外部存储可令建立索引和检索的效率都大幅提高。检索时采用外部存储方式产生的的内存需求为 (1+number_of_attrs)*number_of_docs*4字节,也就是说,带有两个属性和一个时间戳的1千万篇文档会消耗(1+2+1)*10M*4 = 160 MB的RAM。这是每个检索的守护进程(daemon)消耗的量,而不是每次查询,searchd仅在启动时分配160MB的内存,读入数据并在不同的查询之间保持这些数据。子进程并不会对这些数据做额外的拷贝。3.3. 多值属性MVA (multi-valued attributes)多值属性MVA (multi-valued attributes)是文档属性的一种重要的特例,MVA使得向文档附加一系列的值作为属性的想法成为可能。这对文章的tags,产品类别等等非常有用。MVA属性支持过滤和分组(但不支持分组排序)。目前MVA列表项的值被限制为32位无符号整数。列表的长度不受限制,只要有足够的RAM,任意个数的值都可以被附加到文档上(包含MVA值的.spm文件会被searchd预缓冲到RAM中)。源数据既可以来自一个单独的查询,也可以来自文档属性,参考

sql_attr_multi 中的源类型。在第一种情况中,该查询须返回文档ID和MVA值的序对;而在第二种情况中,该字段被分析为整型值。对于多值属性的输入数据的顺序没有任何限制,在索引过程中这些值会自动按文档ID分组(而相同文档ID下的数据也会排序)。在过滤过程中,MVA属性中的任何一个值满足过滤条件,则文档与过滤条件匹配(因此通

过排他性过滤的文档不会包含任何被禁止的值)。按MVA属性分组时,一篇文档会被分到与多个不同MVA值对应的多个组。例如,如果文档集只包含一篇文档,它有一个叫做tag的MVA属性,该属性的值是5、7和11,那么按tag的分组操作会产生三个组,它们的@count都是1,@groupby键值分别是5、7和11。还要注意,按MVA分组可能会导致结果集中有重复的文档:因为每篇文文档可能属于不同的组,而且它可能在多个组中被选为最佳结果,这会导致重复的ID。由于历史原因,PHP API对结果集的行进行按文档ID的有序hash,因此用PHP API进行对MVA属性的分组操作时你还需要使用 SetArrayResult()

3.4. 索引为了快速地相应查询,Sphinx需要从文本数据中建立一种为查询做优化的特殊的数据结构。这种数据结构被称为索引(index);而建立索引的过程也叫做索引或建立索引(indexing)。不同的索引类型是为不同的任务设计的。比如,基于磁盘的B-Tree存储结构的索引可以更新起来比较简单(容易向已有的索引插入新的文档),但是搜起来就相当慢。因此Sphinx的程序架构允许实现多种不同类型的索引。目前在Sphinx中实现的唯一一种索引类型是为最优化建立索引和检索的速度而设计的。随之而来的代价是更新索引相当的很慢。理论上讲,更新这种索引甚至可能比从头重建索引还要慢。不过大多数情况下这可以靠建立多个索引来解决索引更新慢的问题,细节请参考 节 3.10, “ 实时索引更新 ”

实现更多的索引类型支持,已列入计划,其中包括一种可以实时更新的类型。每个配置文件都可以按需配置足够多的索引。indexer 工具可以将它们同时重新索引(如果使用了--all选项)或者仅更新明确指出的一个。 Searchd工具会为所有被指明的索引提供检索服务,而客户端可以在运行时指定使用那些索引进行检索。3.5源数据的限制Sphinx索引的源数据有一些限制,其中最重要的一条是:所有文档的ID必须是唯一的无符号非零整数(根据Sphinx构造时的选项,可能是32位或64位)如果不满足这个要求,各种糟糕的情况都可能发生。例如,Sphinx建立索引时可能在突然崩溃,或者由于冲突的文档ID而在索引结果中产生奇怪的结果。也可能,一只重达1000磅的大猩猩最后跳出你的电脑,向你扔木桶。我告诉你咯!3.6字符集、大小写转换和转换表当建立索引时,Sphinx从指定的数据源获得文本文档,将文本分成词的集合,再对每个词做大小写转换,于是“Abc”,“ABC”和“abc”都被当作同一个词(word,或者更学究一点,词项term)为了正确完成上述工作,Sphinx需要知道:源文本是什么编码的那些字符是字母,哪些不是哪些字符需要被转换,以及被转换成什么

这些都可以用charset_type 和 charset_table 选项为每个索引单独配置。charset_type 指定文档的编码是单字节的(SBCS)还是UTF-8的(注意:Sphinx目前只支持这两种编码,GBK及BIG5的编码需要预先转成UTF-8的)。charset_table 则指定了字母类字符到它们的大小写转换版本的对应表,没有在这张表中出现的字符被认为是非字母类字符,并且在建立索引和检索时被当作词的分割符来看待。注意,尽管默认的转换表并不包含空格符 (ASCII 0x20, Unicode U+0020),但这么做是完全合法的。这在某些情况下可能有用,比如在对tag云构造索引的时候,这样一个用空格分开的词集就可以被当作一个单独的查询项了。默认转换表目前包括英文和俄文字符。请您提交您为其他语言撰写的转换表!3.7. SQL数据源 (MySQL, PostgreSQL)对于所有的SQL驱动,建立索引的过程如下:连接到数据库执行预查询 (参见 节 8.1.9, “sql_query_pre” ) ,以便完成所有必须的初始设置,比如为MySQL连接设置编码执行主查询(参见 节 8.1.10, “sql_query” ),其返回的的数据将被索引执行后查询 (参见 节 8.1.19, “sql_query_post” ),以便完成所有必须的清理工作关闭到数据库的连接对短语进行排序 (或者学究一点, 索引类型相关的后处理)再次建立到数据库的连接执行后索引查询 (参见 节 8.1.20, “sql_query_post_index” ) ,以便完成所有最终的清理工作再次关闭到数据库的连接大多数参数是很直观的,例如数据库的用户名、主机、密码。不过,还有一些细节上的问题需要讨论。分区查询Sphinx需要通过主查询来获取全部的文档信息,一种简单的实现是将整个表的数据读入内存,但是这可能导致整个表被锁定并使得其他操作被阻止(例如:在MyISAM格式上的INSERT操作),同时,将浪费大量内存用于存储查询结果,诸如此类的问题吧。为了避免出现这种情况,Sphinx支持一种被称作“分区查询”的技术。首先,Sphinx从数据库中取出文档ID的最小值和最大值,将由最大值和最小值定义自然数区间分成若干份,一次获取数据,建立索引。现举例如下:例 1. 使用分区查询的例子# in l_query_range = SELECT MIN(id),MAX(id) FROM documentssql_range_step = 1000sql_query = SELECT * FROM documents WHERE id>=$start AND id<=$end如果这个表(documents)中,字段ID的最小值和最大值分别是1 和2345,则sql_query将执行3次:

1.将$start 替换为1 ,并且将$end 替换为1000;

2.将$start 替换为1001 ,并且将 $end 替换为2000;3.将$start 替换为2000 ,并且将 $end 替换为2345.显然,这对于只有2000行的表,分区查询与整个读入没有太大区别,但是当表的规模扩大到千万级(特别是对于MyISAM格式的表),分区查询将提供一些帮助。后查询(sql_post) vs. 索引后查询(sql_post_index)后查询和索引后查询的区别在于,当Sphinx获取到全部文档数据后,立即执行后查询,但是构建索引的过程仍然可能因为某种原因失败。在另一方面,当索引后查询被执行时,可以理所当然的认为索引已经成功构造完了。因为构造索引可能是个漫长的过程,因此对与数据库的连接在执行后索引操作后被关闭,在执行索引后操作前被再次打开。3.8. xmlpipe 数据源xmlpipe 数据源是处于让用户能够将现有数据嵌入Sphinx而无需开发新的数据源驱动的目的被设计和提供的。它将每篇文档限制为只能包括两个可全文索引的字段,以及只能包括两个属性。xmlpipe数据源已经被废弃,在 节 3.9, “xmlpipe2 数据源 ” 中描述了xmlpipe的替代品xmlpipe2数据源。对于新的数据,建议采用xmlpipe2。.

为了使用xmlpipe,需要将配置文件改为类似如下的样子:

source example_xmlpipe_source{ type = xmlpipe xmlpipe_command = perl /www//bin/}indexer 实用程序将要运行xmlpipe_command 所指定的命令,而后读取其向标准输出上输出的数据,并对之进行解析并建立索引。严格的说,是Sphinx打开了一个与指定命令相连的管道,并从这个管道读取数据。indexer 实用程序假定在从标准输入读入的XML格式的数据中中存在一个或更多的文档。下面是一个包括两个文档的文档数据流的例子:Example 2. XMLpipe 文档数据流123451132223498test titlethis is my document body124461132223498another testthis is another document

遗留的xmlpipe的遗留的数据驱动使用内置的解析器来解析xml文档,这个解析器的速度非常快,但是并没有提供对XML格式完整支持。这个解析器需要文档中包括全部的字段,并且严格按照例子中给出的格式给出,而且字段的出现顺序需要严格按照例子中给出的顺序。仅有一个字段timestamp是可选的,它的缺省值为1。3.9. xmlpipe2 数据源xmlpipe2使你可以用另一种自定义的XML格式向Sphinx传输任意文本数据和属性数据。数据模式(即数据字段的集合或者属性集)可以由XML流本身指定,也可以在配置文件中数据源的配置部分中指定。Xmlpipe2

在对xmlpipe2数据源做索引时,索引器运行指定的命令,打开一个连接前述命令标准输出的管道,并等待接受具有正确格式的XML数据流。以下是一个数据流的样本:

示例3 xmlpipe2文档流

this is the main content entry must be

handled properly by xml parser lib]]>1012325463note how field/attr tags can be in randomized

ordersome undeclared element任意多的数据字段和属性都是允许的。数据字段和属性在同一文档元素中出现的先后顺序没有特别要求。。单一字段数据的最大长度有限制,超过2MB的数据会被截短到2MB(但这个限制可以在配置文件中数据源部分修改)数据模式,即数据字段和属性的完整列表,必须在任何文档被分析之前就确定。这既可以在配置文件中用xmlpipe_field和xmlpipe_attr_xxx选项指定,也可以就在数据流中用元素指定。 元素是可选的,但如果出现,就必须是元素的第一个子元素。如果没有在数据流中内嵌的数据模式定义,配置文件中的相关设置就会生效,否则数据流内嵌的设置被优先采用。未知类型的标签(既不是数据字段,也不是属性的标签)会被忽略,但会给出警告。在上面的例子中,标签会被忽略。所有嵌入在其他标签中的标签及其属性都会被无视(例如上述例子中嵌入在标签中的标签)支持输入数据流的何种字符编码取决于系统中是否安装了iconv。xmlpipe2是用libexpat解析

器解析的,该解析器内置对US-ASCII,ISO-8859-1,UTF-8和一些UTF-16变体的支持。Sphinx的configure脚本也会检查libiconv是否存在并使用它来处理其他的字符编码。libexpat也隐含的要求在Sphinx端使用UTF-8,因为它返回的分析过的数据总是UTF-8的。

xmlpipe2可以识别的XML元素(标签)(以及前述元素可用的属性)如下:sphinx:docset 顶级元素,用于标明并包括xmlpipe2文档。Sphinx:schema可选元素,它要么是sphinx:docset的第一个子元素,要么干脆不出现。声明文档的模式。包括数据字段和属性的声明。若此元素出现,则它会覆盖配置文件中对数据源的设定。

Sphinx:field可选元素,sphinx:schema的子元素。声明一个全文数据字段。唯一可识别的属性是“name”,它指定了字段的名称,后续数据文档中具有此名称的元素的数据都被当作待检索的全文数据对待。sphinx:attr可选元素,sphinx:schema的子元素。用于声明具体属性。其已知的属性有:●“name”,设定该属性名称,后续文档中具有该名称的元素应被当作一个属性对待。●”type”,设定该属性的类型。可能的类型包括“int”,“timestamp”,“str2ordinal”,“bool”和“float”●“bits”,设定“int”型属性的宽度,有效值为1到32●“default”,设定该属性的默认值,若后续文档中没有指定这个属性,则使用此默认值。Sphinx:document必须出现的元素,必须是sphinx:docset的子元素。包含任意多的其他元素,这些子元素带有待索引的数据字段和属性值,而这些数据字段或属性值既可以是用sphinx:field和sphinx:attr元素声明的,也可以在配置文件中声明。唯一的已知属性是“id”,它必须包含一个唯一的整型的文档ID。3.10. 实时索引更新有这么一种常见的情况:整个数据集非常大,以至于难于经常性的重建索引,但是每次新增的记录却相当地少。一个典型的例子是:一个论坛有1000000个已经归档的帖子,但每天只有1000个新帖子。在这种情况下可以用所谓的“主索引+增量索引”(main+delta)模式来实现“近实时”的索引更新。这种方法的基本思路是设置两个数据源和两个索引,对很少更新或根本不更新的数据建立主索引,而对新增文档建立增量索引。在上述例子中,那1000000个已经归档的帖子放在主索引中,而每天新增的1000个帖子则放在增量索引中。增量索引更新的频率可以非常快,而文档可以在出现几分种内就可以被检索到。确定具体某一文档的分属那个索引的分类工作可以自动完成。一个可选的方案是,建立一个计数表,记录将文档集分成两部分的那个文档ID,而每次重新构建主索引时,这个表都会

被更新。示例4 全自动的即时更新# in MySQLCREATE TABLE sph_counter( counter_id INTEGER PRIMARY KEY NOT NULL, max_doc_id INTEGER NOT NULL);# in urce main{ # ... sql_query_pre = REPLACE INTO sph_counter SELECT 1, MAX(id) FROM documents sql_query = SELECT id, title, body FROM documents WHERE id<=( SELECT max_doc_id FROM sph_counter WHERE counter_id=1 )}source delta : main{ sql_query_pre = sql_query = SELECT id, title, body FROM documents WHERE id>( SELECT max_doc_id FROM sph_counter WHERE counter_id=1 )}index main{ source = main path = /path/to/main # ... all the other settings}# note how all other settings are copied from main,# but source and path are overridden (they MUST be)index delta : main{ source = delta path = /path/to/delta}3.11. 索引合并合并两个已有的索引比重新对所有数据做索引更有效率,而且有时候必须这样做(例如在“主索引+增量索引”分区模式中应合并主索引和增量索引,而不是简单地重新索引“主索引对应的数据)。因此indexer有这个选项。合并索引一般比重新索引快,但在大型索引上仍然不是一蹴而就。基本上,待合并的两个索引都会被读入内存一次,而合并后的内容需要写入磁盘一次。例如,合并100GB和1GB的两个索引将导致202GB的IO操作(但很可能还是比重新索引少)基本的命令语法如下:

indexer --merge DSTINDEX SRCINDEX [--rotate]

SRCINDEX的内容被合并到DSTINDEX中,因此只有DSTINDEX索引会被改变。若DSTINDEX已经被searchd用于提供服务,则--rotate参数是必须的。最初设计的使用模式是,将小量的更新从SRCINDEX合并到DSTINDEX中。因此,当属性被合并时,一旦出现了重复的文档ID,SRCINDEX中的属性值更优先(会覆盖DSTINDEX中的值)。不过要注意,“旧的”关键字并不会被自动删除。例如,在DSTINDEX中有一个叫做“old”的关键字与文档123相关联,而在SRCINDEX中则有关键字“new”与同一个文档相关,那么在合并后用这两个关键字都能找到文档123。您可以给出一个显式条件来将文档从DSTINDEX中移除,以便应对这种情况,相关的开关是--merge-dst-range:indexer --merge main delta --merge-dst-range deleted 0 0这个开关允许您在合并过程中对目标索引实施过滤。过滤器可以有多个,只有满足全部过滤条件的文档才会在最终合并后的索引中出现。在上述例子中,过滤器只允许“deleted”为0的那些条件通过,而去除所有标记为已删除(“deleted”)的记录(可以通过调用UpdateAttributes() 设置文档的属性)。4. 搜索4.1. 匹配模式有如下可选的匹配模式:SPH_MATCH_ALL, 匹配所有查询词(默认模式)SPH_MATCH_ANY, 匹配查询词中的任意一个SPH_MATCH_PHRASE, 将整个查询看作一个词组,要求按顺序完整匹配SPH_MATCH_BOOLEAN, 将查询看作一个布尔表达式 (参见 节 4.2, “ 布尔查询语

法 ”

SPH_MATCH_EXTENDED, 将查询看作一个Sphinx内部查询语言的表达式(参见 节 4.3, “ 扩展的查询语法 ” )还有一个特殊的“完整扫描”模式,当如下条件满足时,该模式被自动激活:1.查询串是空的(即长度为零)2. docinfo 存储方式为extern在完整扫描模式中,全部已索引的文档都被看作是匹配的。这类匹配仍然会被过滤、排序或分组,但是并不会做任何真正的全文检索。这种模式可以用来统一全文检索和非全文检索的代码,或者减轻SQL服务器的负担(有些时候Sphinx扫描的速度要优于类似的MySQL查询)

4.2. 布尔查询布尔查询允许使用下列特殊操作符:显式的与(AND)操作符hello & world或(OR)操作符

hello | world

非(NOT)操作符

hello -worldhello !world分组(grouping)

( hello world )以下是一个使用了如上全部操作符的例子:示例5 布尔查询示例( cat -dog ) | ( cat -mouse)与(AND)操作符为默认操作,所以“hello world”其实就是“hello & world”或(OR)操作符的优先级高于与操作符,因此“lookingfor cat | dog | mouse”意思是"looking for (

cat | dog | mouse )" 而不是 "(looking for cat) | dog | mouse"像“-dog”这种查询不能被执行,因为它差不多包括索引所有文档。这既有技术上的原因,也有性能上的原因。从技术上说,Sphinx并不总是保持一个全部文档ID的列表。性能方面,当文档集非常大的时候(即10-100M个文档),对这种执行查询可能需要很长的时间。4.3. 扩展查询在扩展查询模式中可以使用如下特殊操作符:或(OR)操作符hello | world非(NOT)操作符

hello -worldhello !world字段(field)搜索符:

@title hello @body world词组搜索符

"hello world"近似搜索符

"hello world"~10阀值匹配符"the world is a wonderful place"/3下例使用了上述大多数操作符:

示例6 扩展查询示例"hello world" @title "example program"~5 @body python -(php|perl)与(AND)操作为默认操作,因此“hello world”意思是“hello”和“world”必须同时存在文档才

能匹配。或(OR)操作符的优先级要高于与操作符,因此"looking for cat | dog | mouse" 意思是"looking for ( cat | dog | mouse )" 而不是"(looking for cat) | dog | mouse";近似距离以词为单位,随词数变化而变化,并应用于引号中的全部词。举个例子,"cat dog

mouse"~5 这个查询的意思是必须有一个少于8个词的词串,它要包含全部的三个词,也就是说"CAT aaa bbb ccc DOG eee fff MOUSE" 这个文档不会匹配这个查询,因为这个词串正好是8个词。阀值匹配符引入了一种模糊匹配。它允许至少含有某个阈值数量个匹配词的文档通过。上述例子("the world is a wonderful place"/3)会匹配含有指定的六个词中的至少三个的那些文档。类似如下查询中嵌套的括号aaa | ( bbb ccc | ( ddd eee ) )目前还是不允许的,但是这会在今后得以改进。

取否(也就是非(NOT)操作符)只允许用在最外一层且不能在括号(也就是分组)里。这个特性不会改变,因为支持嵌套的非操作会大大提高词组相关度计算实现的复杂性。4.4. 权值计算采用何种权值计算函数(目前)取决于查询的模式。There are these major parts which are used in the weighting functions:

权值计算函数进行如下两部分主要部分:1.词组评分2.统计学评分词组评分根据文档和查询的最长公共子串(LCS,longest common subsequence)的长度进行。因此如果文档对查询词组有一个精确匹配(即文档直接包含该词组),那么它的词组评分就取得了可能的最大值,也就是查询中词的个数。统计学评分基于经典的BM25函数,该函数仅考虑词频。如果某词在整个数据库中很少见(即文档集上的低频词)或者在某个特定文档中被经常提及(即特定文档上的高频词),那么它就得到一个较高的权重。最终的BM25权值是一个0到1之间的浮点数。在所有模式中,数据字段的词组评分是LCS乘以用户指定的数据字段权值。数据字段权值是整数,默认为1,且字段的权值必须不小于1。在SPH_MATCH_BOOLEAN模式中,不做任何权重估计,每一个匹配项的权重都是1。

在SPH_MATCH_ALL和SPH_MATCH_PHRASE模式中,最终的权值是词组评分的加权和。在SPH_MATCH_ANY模式中,于前面述两模式的基本思想类似,只是每个数据字段的权重都再加上一个匹配词数目。在那之前,带权的词组相关度被额外乘以一个足够大的数,以便确保任何一个有较大词组评分的数据字段都会使整个匹配的相关度较高,即使该数据字段的权重比较低。在SPH_MATCH_EXTENDED模式中,最终的权值是带权的词组评分和BM25权重的和,再乘以1000并四舍五入到整数。这个行为将会被修改,以便使MATCH_ALL和MATCH_ANY这两个模式也能使用BM25算

法。这将使词组评分相同的搜索结果片断得到改进,这在只有一个词的查询中尤其有用。关键的思想(对于除布尔模式以外的全部模式中)是子词组的匹配越好则评分越高,精确匹配(匹配整个词组)评分最高。作者的经验是,这种基于词组相似性的评分方法可以提供比任何单纯的统计模型(比如其他搜索引擎中广泛使用的BM25)明显更高的搜索质量。4.5. 排序模式可使用如下模式对搜索结果排序:SPH_SORT_RELEVANCE 模式, 按相关度降序排列(最好的匹配排在最前面)SPH_SORT_ATTR_DESC 模式, 按属性降序排列 (属性值越大的越是排在前面)SPH_SORT_ATTR_ASC模式, 按属性升序排列(属性值越小的越是排在前面)SPH_SORT_TIME_SEGMENTS 模式, 先按时间段(最近一小时/天/周/月)降序,再按相关度降序SPH_SORT_EXTENDED 模式, 按一种类似SQL的方式将列组合起来,升序或降序排列。SPH_SORT_EXPR 模式,按某个算术表达式排序。SPH_SORT_RELEVANCE忽略任何附加的参数,永远按相关度评分排序。所有其余的模式都要求额外的排序子句,子句的语法跟具体的模式有关。SPH_SORT_ATTR_ASC,

SPH_SORT_ATTR_DESC以及SPH_SORT_TIME_SEGMENTS这三个模式仅要求一个属性名。SPH_SORT_RELEVANCE模式等价于在扩展模式中按"@weight DESC, @id ASC"排序,SPH_SORT_ATTR_ASC 模式等价于"attribute ASC, @weight DESC, @id ASC",而SPH_SORT_ATTR_DESC 等价于"attribute DESC, @weight DESC, @id ASC"。

SPH_SORT_TIME_SEGMENTS模式在SPH_SORT_TIME_SEGMENTS模式中,属性值被分割成“时间段”,然后先按时间段排序,再按相关度排序。时间段是根据搜索发生时的当前时间戳计算的,因此结果随时间而变化。所说的时间段有如下这些值:最近一小时最近一天最近一星期最近一个月最近三个月其他值时间段的分法固化在搜索程序中了,但如果需要,也可以比较容易地改变(需要修改源码)。这种模式是为了方便对Blog日志和新闻提要等的搜索而增加的。使用这个模式时,处于更近时间段的记录会排在前面,但是在同一时间段中的记录又根据相关度排序-这不同于单纯按时间戳排序而不考虑相关度。SPH_SORT_EXTENDED 模式在 SPH_SORT_EXTENDED 模式中,您可以指定一个类似SQL的排序表达式,但涉及的属

性(包括内部属性)不能超过5个,例如:@relevance DESC, price ASC, @id DESC只要做了相关设置,不管是内部属性(引擎动态计算出来的那些属性)还是用户定义的属性就都可以使用。内部属性的名字必须用特殊符号@开头,用户属性按原样使用就行了。在上面的例子里,@relevance和@id是内部属性,而price是用户定义属性。已知的内部属性:@id (match ID)@weight (match weight)@rank (match weight)@relevance (match weight)@id(匹配的ID)@weight(匹配权值)@rank(匹配权值)@relevance(匹配权值)@rank和@relevance只是@weight的额外别名。SPH_SORT_EXPR 模式表达式排序模式使您可以对匹配项按任何算术表达式排序,表达式中的项可以是属性值,内部属性(@id和@weight),算术运算符和一些内建的函数。例如:

$cl->SetSortMode ( SPH_SORT_EXPR, "@weight + ( user_karma + ln(pageviews) )*0.1" );支持的运算符和函数如下。它们是模仿MySQL设计的。函数接受参数,参数的数目根据具体函数的不同而不同。Operators: +, -, *, /, <, > <=, >=, =, <>.Unary (1-argument) functions: abs(), ceil(), floor(), sin(), cos(), ln(), log2(), log10(), exp(),

sqrt().Binary (2-argument) functions: min(), max(), pow().Ternary (3-argument) functions: if().运算符: +, -, *, /, <, > <=, >=, =, <>.一元函数(一个参数):abs(), ceil(), floor(), sin(), cos(), ln(), log2(), log10(), exp(),

sqrt().二元函数(两个参数):min(), max(), pow().三元函数(三个参数):if().全部的计算都以单精度32位IEEE754浮点数进行。比较操作符(比如=和<=)在条件为真时返回1.0,否则返回0.0。例如(a=b)+3在属性“a”与属性“b”相等时返回4,否则返回3。与MySQL不同,相等性比较符(即=和<>)中引入了一个小的阈值(默认是1e-6)。如果被比较的两个值的差异在阈值之内,则二者被认为相等。全部的一元和二元函数的意义都很明确,他们的行为跟在数学中的定义一样。但IF()的行为

需要点详细的解释。它接受3个参数,检查第一个参数是否为0.0,若非零则返回第二个参数,为零时则返回第三个参数。注意,与比较操作符不同,IF()并不使用阈值!因此在第一个参数中使用比较结果是安全的,但使用算术运算符则可能产生意料之外的结果。比如,下面两个调用会产生不同的结果,虽然在逻辑上他们是等价的:IF ( sqrt(3)*sqrt(3)-3<>0, a, b )IF ( sqrt(3)*sqrt(3)-3, a, b )在第一种情况下,由于有阈值,比较操作符<>返回0.0(逻辑假),于是IF()总是返回‘b’。在第二种情况下,IF()函数亲自在没有阈值的情况下将同样的

sqrt(3)*sqrt(3)-3与零值做比较。但由于浮点数运算的精度问题,该表达式的结果与0值会有微小的差异,因此该值与零值的相等比较不会通过,上述第二种情况中IF()会返回‘a’做为结果。4.6. 结果分组(聚类)有时将搜索结果分组(或者说“聚类”)并对每组中的结果计数是很有用的-例如画个漂亮的图来展示每个月有多少的blog日志,或者把Web搜索结果按站点分组,或者把找到的论坛帖子按其作者分组。理论上,这可以分两步实现:首先在Sphinx中做全文检索,再在SQL服务器端对得到的ID分组。但是现实中在大结果集(10K到10M个匹配)上这样做通常会严重影响性能。为避免上述问题,Sphinx提供了一种“分组模式”,可以用API调用SetGroupBy()来开启。在分组时,根据group-by值给匹配项赋以一个分组。这个值用下列内建函数之一根据特定的属性值计算:SPH_GROUPBY_DAY,从时间戳中按YYYYMMDD格式抽取年、月、日SPH_GROUPBY_WEEK,从时间戳中按YYYYNNN格式抽取年份和指定周数(自年初计起)的第一天SPH_GROUPBY_MONTH,从时间戳中按YYYYMM格式抽取月份SPH_GROUPBY_YEAR,从时间戳中按YYYY格式抽取年份SPH_GROUPBY_ATTR,使用属性值自身进行分组最终的搜索结果中每组包含一个最佳匹配。分组函数值和每组的匹配数目分别以“虚拟”属性@group和@count的形式返回。结果集按group-by排序子句排序,语法与SPH_SORT_EXTENDED 排序子句的语法相似。除了@id和@weight,分组排序子句还包括:

@group(groupby函数值)@count(组中的匹配数目)默认模式是根据groupby函数值降序排列,即按照“@group desc”排序完成时,结果参数total_found会包含在整个索引上匹配的组的总数目。注意:分组操作在固定的内存中执行,因此它给出的是近似结果;所以total_found报告的数目可能比实际给出的个分组数目的和多。@count也可能被低估。要降低不准确性,应提高max_matches。如果max_matches允许存储找到的全部分组,那结果就是百分之百准确的。例如,如果按相关度排序,同时用SPH_GROUPBY_DAY函数按属性“published”分组,那么:

结果中包含每天的匹配结果中最相关的那一个,如果那天有记录匹配的话。结果中还附加给出天的编号和每天的匹配数目结果以天的编号降序排列(即最近的日子在前面)4.7. 分布式搜索为提高可伸缩性,Sphnix提供了分布式检索能力。分布式检索可以改善查询延迟问题(即缩短查询时间)和提高多服务器、多CPU或多核环境下的吞吐率(即每秒可以完成的查询数)。这对于大量数据(即十亿级的记录数和TB级的文本量)上的搜索应用来说是很关键的。其关键思想是将待搜索数据做水平分区(HP,Horizontally partition),然后并行处理。分区不能自动完成,您需要:在不同服务器上设置Sphinx程序集(indexer和searchd)的多个实例让这些实例对数据的不同部分做索引(并检索)在searchd的一些实例上配置一个特殊的分布式索引然后对这个索引进行查询这个特殊索引只包括对其他本地或远程索引的引用,因此不能对它执行重新建立索引的操作,相反,如果要对这个特殊索引进行重建,要重建的是那些被这个索引被引用到的索引。当searchd收到一个对分布式索引的查询时,它做如下操作:1.连接到远程代理2.执行查询3.(在远程代理执行搜索的同时)对本地索引进行查询4.接收来自远程代理的搜索结果5.将所有结果合并,删除重复项6.将合并后的结果返回给客户端在应用程序看来,普通索引和分布式索引完全没有区别。任一个searchd实例可以同时做为主控端(master,对搜索结果做聚合)和从属端(只做本地搜索)。这有如下几点好处:1.集群中的每台机器都可以做为主控端来搜索整个集群,搜索请求可以在主控端之间获得负载平衡,相当于实现了一种HA(high availability,高可用性),可以应对某个节点失效的情况。2.如果在单台多CPU或多核机器上使用,一个做为代理对本机进行搜索的searchd实例就可以利用到全部的CPU或者核。更好的HA支持已在计划之中,到时将允许指定哪些代理之间互相备份、有效性检查、跟踪运行中的代理、对检索请求进行负载均衡,等等。4.8. searchd 日志格式searchd将全部成功执行的搜索查询都记录在查询日志文件中。以下是一个类似记录文件的例子:

[Fri Jun 29 21:17:58 2007] 0.004 sec [all/0/rel 35254 (0,20)] [lj] test[Fri Jun 29 21:20:34 2007] 0.024 sec [all/0/rel 19886 (0,20) @channel_id] [lj]

test日志格式如下[query-date] query-time [match-mode/filters-count/sort-mode total-matches (offset,limit) @groupby-attr] [index-name] query匹配模式(match-mode)可以是如下值之一:

"all" 代表 SPH_MATCH_ALL 模式;"any" 代表 SPH_MATCH_ANY 模式;"phr" 代表 SPH_MATCH_PHRASE 模式;"bool" 代表 SPH_MATCH_BOOLEAN 模式;"ext" 代表 SPH_MATCH_EXTENDED 模式.排序模式(sort-mode)可以取如下值之一:"rel" 代表 SPH_SORT_RELEVANCE 模式;"attr-" 代表 SPH_SORT_ATTR_DESC 模式;"attr+" 代表 SPH_SORT_ATTR_ASC 模式;"tsegs" 代表 SPH_SORT_TIME_SEGMENTS 模式;"ext" 代表 SPH_SORT_EXTENDED 模式.5. API 参考Sphnix有几种不同编程语言的searchd客户端API的实现。在本文完成之时,我们对我们自己的PHP,Python和java实现提供官方支持。此外,也有一些针对Perl,Ruby和C++的第三方免费、开源API实现。API的参考实现是用PHP写成的,因为(我们相信)较之其他语言,Sphinx在PHP中应用最广泛。因此这份参考文档基于PHP API的参考,而且这节中的所有的代码样例都用PHP给出。当然,其他所有API都提供相同的方法,也使用完全相同的网络协议。因此这份文档对他们同样适用。在方法命名习惯方面或者具体数据结构的使用上可能会有小的差别。但不同语言的API提供的功能上绝不会有差异。5.1. 通用API 方法5.1.1. GetLastError原型: function GetLastError()以人类可读形式返回最近的错误描述信息。如果前一次API调用没有错误,返回空字符串。任何其他函数(如 Query())失败后(函数失败一般返回false),都应该调用这个函数,它将返回错误的描述。此函数本身并不重置对错误描述,因此如有必要,可以多次调用。

5.1.2. GetLastWarning原型: function GetLastWarning ()Returns last warning message, as a string, in human readable format. If there were no warnings

during the previous API call, empty string is returned.

以人类可读格式返回最近的警告描述信息。如果前一次API调用没有警告,返回空字符串。您应该调用这个函数来确认您的请求(如 Query())是否虽然完成了但产生了警告。例如,即使几个远程代理超时了,对分布式索引的搜索查询也可能成功完成。这时会产生一个警告信息。此函数本身不会重置警告信息,因此如有必要,可以多次调用。5.1.3. SetServer原型:function SetServer ( $host, $port )设置searchd的主机名和TCP端口。此后的所有请求都使用新的主机和端口设置。默认的主机和端口分别是“localhost”和3312。5.1.4. SetRetries原型: function SetRetries ( $count, $delay=0 )设置分布式搜索重试的次数和延迟时间。对于暂时的失败,searchd对每个代理重试至多$count次。$delay是两次重试之间延迟的时间,以毫秒为单位。默认情况下,重试是禁止的。注意,这个调用不会使API本身对暂时失败进行重试,它只是让searchd这样做。目前暂时失败包括connect()调用的各种失败和远程代理超过最大连接数(过于繁忙)的情况。5.1.5. SetArrayResult原型: function SetArrayResult ( $arrayresult )PHP专用。控制搜索结果集的返回格式(匹配项按数组返回还是按hash返回)$arrayresult参数应为布尔型。如果$arrayresult为假(默认),匹配项以PHP hash格式返回,文档ID为键,其他信息(权重、属性)为值。如果$arrayresult为真,匹配项以普通数组返回,包括匹配项的全部信息(含文档ID)这个调用是对MVA属性引入分组支持时同时引入的。对MVA分组的结果可能包含重复的文档ID。因此需要将他们按普通数组返回,因为hash对每个文档ID仅能保存一个记录。5.2. 通用搜索设置5.2.1. SetLimits原型: function SetLimits ( $offset, $limit, $max_matches=0, $cutoff=0 )给服务器端结果集设置一个偏移量($offset)和从那个偏移量起向客户端返回的匹配项数目限制($limit)。并且可以在服务器端设定当前查询的结果集大小($max_matches),另有一个阈值($cutoff),当找到的匹配项达到这个阀值时就停止搜索。全部这些参数都必须是非负整数。

前两个参数的行为与MySQL LIMIT子句中参数的行为相同。他们令searchd从编号为$offset的匹配项开始返回最多$limit个匹配项。偏移量($offset)和结果数限制($limit)的默认值分别是0和20,即返回前20个匹配项。

max_match这个设置控制搜索过程中searchd在内存中所保持的匹配项数目。一般来说,即使设置了max_matches为1,全部的匹配文档也都会被处理、评分、过滤和排序。但是任一时刻只有最优的N个文档会被存储在内存中,这是为了性能和内存使用方面的原因,这个设置正是控制这个N的大小。注意,max_matches在两个地方设置。针对单个查询的限制由这个API调用指定。但还有一个针对整个服务器的限制,那是由配置文件中的max_matches设置控制的。为防止滥用内存,服务器不允许单个查询的限制高于服务器的限制。在客户端不可能收到超过max_matches个匹配项。默认的限制是1000,您应该不会遇到需要设置得更高的情况。1000个记录足够向最终用户展示了。如果您是想将结果传输给应用程序以便做进一步排序或过滤,那么请注意,在Sphinx端完成效率要高得多。$cutoff设置是为高级性能优化而提供的。它告诉searchd 在找到并处理$cutoff个匹配后就强制停止。5.2.2. SetMaxQueryTime原型: function SetMaxQueryTime ( $max_query_time )设置最大搜索时间,以毫秒为单位。参数必须是非负整数。默认值为0,意思是不做限制。

这个设置与SetLimits()中的$cutoff相似,不过这个设置限制的是查询时间,而不是处理的匹配数目。一旦处理时间已经太久,本地搜索查询会被停止。注意,如果一个搜索查询了多个本地索引,那这个限制独立地作用于这几个索引。5.3. 全文搜索设置5.3.1. SetMatchMode原型: function SetMatchMode ( $mode )设置全文查询的匹配模式,参见节4.1 “匹配模式”中的描述。参数必须是一个与某个已知模式对应的常数。警告:(仅PHP)查询模式常量不能包含在引号中,那给出的是一个字符串而不是一个常量。

$cl->SetMatchMode ( "SPH_MATCH_ANY" ); // INCORRECT! will not work as expected$cl->SetMatchMode ( SPH_MATCH_ANY ); // correct, works OK5.3.2. SetRankingMode原型: function SetRankingMode ( $ranker )设置评分模式。目前只在SPH_MATCH_EXTENDED2这个匹配模式中提供。参数必须是与某个已知模式对应的常数。Sphinx默认计算两个对最终匹配权重有用的因子。主要是查询词组与文档文本的相似度。其次是称之为BM25的统计函数,该函数值根据关键字文档中的频率(高频导致高权重)和在整个索引中的频率(低频导致高权重)在0和1之间取值。

然而,有时可能需要换一种计算权重的方法——或者可能为了提高性能而根本不计算权值,结果集用其他办法排序。这个目的可以通过设置合适的相关度计算模式来达到。已经实现的模式包括:

SPH_RANK_PROXIMITY_BM25, 默认模式,同时使用词组评分和BM25评分,并且将二者结合。SPH_RANK_BM25,统计相关度计算模式,仅使用BM25评分计算(与大多数全文检索引擎相同)。这个模式比较快,但是可能使包含多个词的查询的结果质量下降。SPH_RANK_NONE,禁用评分的模式,这是最快的模式。实际上这种模式与布尔搜索相同。所有的匹配项都被赋予权重1。5.3.3. SetSortMode原型: function SetSortMode ( $mode, $sortby="" )设置匹配项的排序模式,见 节 4.5, “ 排序模式 ” 中的描述。参数必须为与某个已知模式对应的常数。

警告:(仅PHP)查询模式常量不能包含在引号中,那给出的是一个字符串而不是一个常量。$cl->SetSortMode ( "SPH_SORT_ATTR_DESC" ); // INCORRECT! will not work as

expected$cl->SetSortMode ( SPH_SORT_ATTR_ASC ); // correct, works OK5.3.4. SetWeights原型: function SetWeights ( $weights )按在索引中出现的先后顺序给字段设置权重。不推荐,请使用SetFieldWeights() 。5.3.5. SetFieldWeights原型: function SetFieldWeights ( $weights )按字段名称设置字段的权值。参数必须是一个hash(关联数组),该hash将代表字段名字的字符串映射到一个整型的权值上。字段权重影响匹配项的评级。 节 4.4, “ 权值计算 ” 解释了词组相似度如何影响评级。这个调用用于给不同的全文数据字段指定不同于默认值的权值。给定的权重必须是正的32位整数。最终的权重也是个32位的整数。默认权重为1。未知的属性名会被忽略。目前对权重没有强制的最大限制。但您要清楚,设定过高的权值可能会导致出现32位整数的溢出问题。例如,如果设定权值为10000000并在扩展模式中进行搜索,那么最大可能的权值为10M(您设的值)乘以1000(BM25的内部比例系数,参见 节 4.4, “ 权值计算 ” )再乘以1或更多(词组相似度评级)。上述结果最少是100亿,这在32位整数里面没法存储,将导致意想不到的结果。5.3.6. SetIndexWeights原型: function SetIndexWeights ( $weights )设置索引的权重,并启用不同索引中匹配结果权重的加权和。参数必须为在代表索引名的字符串与整型权值之间建立映射关系的hash(关联数组)。默认值是空数组,意思是关闭带权

加和。当在不同的本地索引中都匹配到相同的文档ID时,Sphinx默认选择查询中指定的最后一个索引。这是为了支持部分重叠的分区索引。然而在某些情况下索引并不仅仅是被分区了,您可能想将不同索引中的权值加在一起,而不是简单地选择其中的一个。SetIndexWeights()允许您这么做。当开启了加和功能后,最后的匹配权值是各个索引中的权值的加权合,各索引的权由本调用指定。也就是说,如果文档123在索引A被找到,权值是2,在B中也可找到,权值是3,而且您调用了SetIndexWeights ( array ( "A"=>100, "B"=>10 ) ),那么文档123最终返回给客户端的权值为2*100+3*10 = 230。5.4. 结果集过滤设置5.4.1. SetIDRange原型: function SetIDRange ( $min, $max )设置接受的文档ID范围。参数必须是整数。默认是0和0,意思是不限制范围。此调用执行后,只有ID在$min和$max(包括$min和$max)之间的文档会被匹配。5.4.2. SetFilter原型: function SetFilter ( $attribute, $values, $exclude=false )增加整数值过滤器。此调用在已有的过滤器列表中添加新的过滤器。$attribute是属性名。$values是整数数组。$exclude是布尔值,它控制是接受匹配的文档(默认模式,即$exclude为假时)还是拒绝它们。只有当索引中$attribute列的值与$values中的任一值匹配时文档才会被匹配(或者拒绝,如果$exclude值为真)5.4.3. SetFilterRange原型 : function SetFilterRange ( $attribute, $min, $max, $exclude=false )添加新的整数范围过滤器。此调用在已有的过滤器列表中添加新的过滤器。$attribute是属性名, $min、$max定义了一个整数闭区间,$exclude布尔值,它控制是接受匹配的文档(默认模式,即$exclude为假时)还是拒绝它们。只有索引中$attribute列的值落在$min和$max之间(包括$min和$max),文档才会被匹配(或者拒绝,如果$exclude值为真)。5.4.4. SetFilterFloatRange原型: function SetFilterFloatRange ( $attribute, $min, $max, $exclude=false )增加新的浮点数范围过滤器。

此调用在已有的过滤器列表中添加新的过滤器。$attribute是属性名, $min、$max定义了一个浮点数闭区间,$exclude必须是布尔值,它控制是接受匹配的文档(默认模式,即$exclude为假时)还是拒绝它们。只有当索引中$attribute列的值落在$min和$max之间(包括$min和$max),文档才会被匹配(或者拒绝,如果$exclude值为真)。5.4.5. SetGeoAnchor原型: function SetGeoAnchor ( $attrlat, $attrlong, $lat, $long )为地表距离计算设置锚点,并且允许使用它们。$attrlat和$attrlong是字符串,分别指定了对应经度和纬度的属性名称。$lat和$long是浮点值,指定了锚点的经度和纬度值,以角度为单位。一旦设置了锚点,您就可以在您的过滤器和/或排序表达式中使用@geodist特殊属性。Sphinx将在每一次全文检索中计算给定经纬度与锚点之前的地表距离,并把此距离附加到匹配结果上去。SetGeoAnchor和索引属性数据中的经纬度值都是角度。而结果会以米为单位返回,因此地表距离1000.0代表1千米。一英里大约是1609.344米。5.5. GROUP BY 设置5.5.1. SetGroupBy原型: function SetGroupBy ( $attribute, $func, $groupsort="@group desc" )设置进行分组的属性、函数和组间排序模式,并启用分组(参考 节 4.6, “ 结果分组(聚类)

中的描述)。$attribute是字符串,为进行分组的属性名。$func为常数,它指定内建函数,该函数以前面所述的分组属性的值为输入,目前的可选的值为:SPH_GROUPBY_DAY, SPH_GROUPBY_WEEK, SPH_GROUPBY_MONTH,

SPH_GROUPBY_YEAR, SPH_GROUPBY_ATTR 。$groupsort是控制分组如何排序的子句。其语法与 节 4.5, “SPH_SORT_EXTENDED 模式 ” 中描述的相似。分组与SQL中的GROUP BY子句本质上相同。此函数调用产生的结果与下面伪代码产生的结果相同。SELECT ... GROUP BY $func($attribute) ORDER BY $groupsort注意,影响最终结果集中匹配项顺序的是$groupsort。排序模式(见 节 5.3.3,“SetSortMode

”)影响每个分组内的顺序,即每组内哪些匹配项被视为最佳匹配。比如,组之间可以根据每组中的匹配项数量排序的同时每组组内又根据相关度排序。5.5.2. SetGroupDistinct原型: function SetGroupDistinct ( $attribute )设置分组中需要计算不同取值数目的属性名。只在分组查询中有效。$attribute是包含属性名的字符串。每个组的这个属性的取值都会被储存起来(只要内存允许),其后此属性在此组中不同值的总数会被计算出来并返回给客户端。这个特性与标准

SQL中的COUNT(DISTINCT)子句类似。因此如下Sphinx调用$cl->SetGroupBy ( "category", SPH_GROUPBY_ATTR, "@count desc" );$cl->SetGroupDistinct ( "vendor" );等价于如下的SQL语句:SELECT id, weight, all-attributes, COUNT(DISTINCT vendor) AS @distinct, COUNT(*) AS @countFROM productsGROUP BY categoryORDER BY @count DESC在上述示例伪代码中,SetGroupDistinct()调用只与COUNT(DISTINCT vendor)对应。GROUP BY,ORDER By和COUNT(*)子句则与SetGroupBY()调用等价。两个查询都会在每类中返回一个匹配的行。除了索引中的属性,匹配项还可以包含每类的匹配项计数和每类中不同vendor ID的计数。5.6. Querying5.6.1. Query原型: function Query ( $query, $index="*" )连接到searchd服务器,根据服务器的当前设置执行给定的查询,取得并返回结果集。$query是查询字串,$index是包含一个或多个索引名的字符串。一旦发生一般错误,则返回假并设置GetLastError()信息。若成功则返回搜索的结果集。$index的默认值是“*”,意思是对全部本地索引做查询。索引名中允许的字符包括拉丁字母(a-z),数字(0-9),减号(-)和下划线(_),其他字符均视为分隔符。因此,下面的示例调用都是有效的,而且会搜索相同的两个索引。$cl->Query ( "test query", "main delta" );$cl->Query ( "test query", "main;delta" );$cl->Query ( "test query", "main, delta" );给出多个索引时的顺序是有意义的。如果同一个文档ID的文档在多个索引中找到,那么权值和属性值会取最后一个索引中所存储的作为该文档ID的权值和属性值,用于排序、过滤,并返回给客户端(除非用SetIndexWeights()显式改变默认行为)。因此在上述示例中,索引“delta”中的匹配项总是比索引“main”中的更优先。如果搜索成功,Query()返回的结果集包含找到的全部匹配项中的一部分(根据SetLimits()之设定)和与查询相关的统计数据。结果集是hash(仅PHP,其他语言的API可能使用其他数据结构),包含如下键和值:"matches":是一个hash表,存储文档ID以及其对应的另一个包含文档权重和属性值的hash表(或者是数组,如果启用了SetArrayResult())。"total":此查询在服务器检索所得的匹配文档总数(即服务器端结果集的大小)。这是在当前设置下,用当前查询可以从服务器端获得的匹配文档数目的上限。

"total_found":(服务器上找到和处理了的)索引中匹配文档的总数。"words":一个hash,它将查询关键字(关键字已经过大小写转换,取词干和其他处理)映射到一个包含关于关键字的统计数据(“docs”——在多少文档中出现,“hits”——共出现了多少次)的小hash表上。"error":searchd报告的错误信息(人类可读的字符串)。若无错误则为空字符串。"warning":searchd报告的警告信息(人类可读字符串)。若无警告则为空串。5.6.2. AddQuery原型: function AddQuery ( $query, $index="*" )向批量查询增加一个查询。$query为查询串。$index为包含一个或多个索引名的字符串。返回RunQueries()返回的数组中的一个下标。批量查询(或多查询)使searchd能够进行可能的内部优化,并且无论在任何情况下都会减少网络连接和进程创建方面的开销。相对于单独的查询,批量查询不会引入任何额外的开销。因此当您的Web页运行几个不同的查询时,一定要考虑使用批量查询。例如,多次运行同一个全文查询,但使用不同的排序或分组设置,这会使searchd仅运行一次开销昂贵的全文检索和相关度计算,然后在此基础上产生多个分组结果。有时您不仅需要简单地显示搜索结果,而且要显示一些与类别相关的计数信息,例如按制造商分组后的产品数目,此时批量查询会节约大量的开销。若无批量查询,您会必须将这些本质上几乎相同的查询运行多次并取回相同的匹配项,最后产生不同的结果集。若使用批量查询,您只须将这些查询简单地组成一个批量查询,Sphinx会在内部优化掉这些冗余的全文搜索。AddQuery()在内部存储全部当前设置状态以及查询,您也可在后续的SubQuery()调用中改变设置。早先加入的查询不会被影响,实际上没有任何办法可以改变它们。下面是一个示例:$cl->SetSortMode ( SPH_SORT_RELEVANCE );$cl->AddQuery ( "hello world", "documents" );$cl->SetSortMode ( SPH_SORT_ATTR_DESC, "price" );$cl->AddQuery ( "ipod", "products" );$cl->AddQuery ( "harry potter", "books" );$results = $cl->RunQueries ();用上述代码,第一个查询会在“documents”索引上查询“hello world”并将结果按相关度排序,第二个查询会在“products”索引上查询“ipod”并将结果按价格排序,第三个查询在“books”索引上搜索“harry potter”,结果仍按价格排序。注意,第二个SetSortMode()调用并不会影响第一个查询(因为它已经被添加了),但后面的两个查询都会受影响。AddQuery()并不修改当前状态。也就是说,现有的全部排序、过滤和分组设置都不会因这个

调用而发生改变,因此后续的查询很容易地复用现有设置。AddQuery()返回RunQueries()返回的数组中的一个下标。它是一个从0开始的递增整数,即,第一次调用返回0,第二次返回1,以此类推。这个方便的特性使你在需要这些下标的时候不用手工记录它们。5.6.3. RunQueries原型: function RunQueries ()连接到searchd,运行由AddQuery()添加的全部查询,获取并返回它们的结果集。若发生一般错误(例如网络I/O失败)则返回假并设置GetLastError()信息。若成功则返回结果集的简单数组。该数组中的每一个结果集都跟Query()返回的结果集完全相同。注意,批量查询请求自身几乎总是成功——除非有网络错误、正在进行索引轮换,或者其他导致整个查询无法被处理的因素。然而其中的单个的查询很可能失败。此时与之对应的结果集只包含一个非空的“错误”信息,而没有关于匹配或查询的统计信息。在极端情况下,批量查询中的所有单个查询可能都失败。但这仍然不会导致报告一般错误,因为API已经成功地连接到searchd,提交了批量查询并得到返回结果——但每个结果集都只包含特定的错误信息。5.6.4. ResetFilters原型: function ResetFilters ()清除当前设置的过滤器。通常此调用在使用批量查询的时候会用到。您可能需要为批量查询中的不同查询提供不同的过滤器,为达到这个目的,您需要调用ResetFilters()然后用其他调用增加新的过滤器。5.6.5. ResetGroupBy原型: function ResetGroupBy ()清除现有的全部分组设置,并关闭分组。通常此调用在使用批量查询的时候会用到。单独的分组设置可以用SetGroupBy()和SetGroupDistinct()来改变,但它们不能关闭分组。ResetGroupBy()将之前的分组设置彻底重置并在当前状态下关闭分组模式,因此后续的AddQuery()可以进行无分组的搜索。5.7. 额外的方法5.7.1. BuildExcerpts原型: function BuildExcerpts ( $docs, $index, $words, $opts=array() )该函数用来产生文档片段(摘要)。连接到searchd,要求它从指定文档中产生片段(摘要),并返回结果。$docs为包含各文档内容的数组。$index为包含索引名字的字符串。给定索引的不同设置(例如字符集、形态学、词形等方面的设置)会被使用。$words为包含需要高亮的关键字的字符串。它们会按索引的设置被处理。例如,如果英语取词干(stemming)在索引中被设置

为允许,那么即使关键词是“shoe”,“shoes”这个词也会被高亮。$opts为包含其他可选的高亮参数的hash:"before_match":在匹配的关键字前面插入的字符串。默认为“”"chunk_separator":在摘要块(段落)之间插入的字符串。默认为“...”"limit":摘要最多包含的符号(码点)数。整数,默认为256."around":每个关键词块左右选取的词的数目。整数,默认为5."exact_phrase":是否仅高亮精确匹配的整个查询词组,而不是单独的关键词。布尔值,默认为假。"single_passage":是否仅抽取最佳的一个段落。布尔值,默认为否。失败时返回假。成功时返回包含有片段(摘要)字符串的数组。5.7.2. UpdateAttributes原型: function UpdateAttributes ( $index, $attrs, $values )立即更新指定文档的指定属性值。成功则返回实际被更新的文档数目(0或更多),失败则返回-1。$index为待更新的(一个或多个)索引名。$attrs为属性名字符串的数组,其所列的属性会被更新。$values为hash表,$values表的键为文档ID,$values表的值为新的属性值的简单数组。$index既可以是一个单独的索引名,也可以是一个索引名的列表,就像Query()的参数。与Query()不同的是不允许通配符,全部待更新的索引必须明确指出。索引名列表可以包含分布式索引。对分布式索引,更新会同步到全部代理上。只有在docinfo=extern这个存储策略下才可以运行更新。更新非常快,因为操作完全在内存中进行,但它们也可以变成持久的,更新会在searchd干净关闭时(收到SIGTERM信号时)被写入磁盘。使用示例:$cl->UpdateAttributes ( "test1", array("group_id"), array(1=>array(456)) );$cl->UpdateAttributes ( "products", array ( "price", "amount_in_stock" ), array ( 1001=>array(123,5), 1002=>array(37,11), 1003=>(25,129) ) );第一条示例语句会更新索引“test1”中的文档1,设置“group_id”为456.第二条示例语句则更新索引“products”中的文档1001,1002和1003。文档1001的“price”会被更新为123,“amount_in_stock”会被更新为5;文档1002,“price”变为37而“amount_in_storage”变为11,等等。

6. MySQL storage engine (SphinxSE)6. MySQL 存储引擎 (SphinxSE)6.1. SphinxSE 概览SphinxSE是一个可以编译进MySQL 5.x版本的MySQL存储引擎,它利用了该版本MySQL的插件式体系结构。SphinxSE不能用于MySQL 4.x系列,它需要MySQL 5.0.22或更高版本;或MySQL 5.1.12或更高版本。尽管被称作“存储引擎”,SphinxSE自身其实并不存储任何数据。它其实是一个允许MySQL服务器与searchd交互并获取搜索结果的嵌入式客户端。所有的索引和搜索都发生在MySQL之外。显然,SphinxSE的适用于:使将MySQL FTS 应用程序移植到Sphinx使没有Sphinx API的那些语言也可以使用Sphinx当需要在MySQL端对Sphinx结果集做额外处理(例如对原始文档表做JOIN,MySQL端的额外过滤等等)时提供优化6.2.安装SphinxSE您需要搞到一份MySQL的源码,并重新编译MySQL。MySQL源码()可在网站获得。针对某些版本的MySQL,Sphinx 网站提供了包含支持SphinxSE的打过补丁tarball压缩包。将这些文件解压出来替换原始文件,就可以配置(configure)、构建(build)以生成带有内建Shpinx支持的MySQL了。如果网站上没有对应版本的tarball,或者由于某种原因无法工作,那您可能需要手工准备这些文件。您需要一份安装好的GUN Autotools框架(autoconf,automake和libtool)来完成这项任务。6.2.1. 在MySQL 5.0.x 上编译SphinxSE如果使用我们事先做好的打过补丁的tarball,那请跳过步骤1-31.将补丁文件复制到MySQL源码目录并运行patch -p1 < 如果没有与您的MySQL版本完全匹配的.diff文件,请尝试一个最接近版本的.diff文件。确保补丁顺利应用,没有rejects。2.在MySQL源码目录中运行sh BUILD/3.在MySQL源码目录中建立sql/sphinx目录,并把Sphinx源码目录中mysqlse目录下的全部文件拷贝到这个目录。cp

-R /root/builds/sphinx-0.9.7/mysqlse /root/builds/mysql-5.0.24/sql/sphinx

4.配置(configure)MySQL,启用Sphinx引擎./configure --with-sphinx-storage-engine5.构建(build)并安装MySQLmakemake install6.2.2. 在MySQL 5.1.x 上编译SphinxSE如果使用我们事先做好的打过补丁的tarball,那请跳过步骤1-31.在MySQL源码目录中建立storage/sphinx目录,并将Sphinx源码目录中的mysqlse目录下的全部文件拷贝到这个目录。cp

-R /root/builds/sphinx-0.9.7/mysqlse /root/builds/mysql-5.1.14/storage/sphinx2.在MySQL源码目录运行sh BUILD/3.配置(configure)MySQL,启用Sphinx引擎./configure --with-plugins=sphinx4.构建(build)并安装MySQLmakemake install6.2.3. SphinxSE 安装测试为了检查SphinxSE是否成功地编入了MySQL,启动新编译出的MySQL服务器,运行mysql客户端,执行SHOW ENGLINES查询,这会显示一个全部可用引擎的列表。Sphinx应该出现在这个列表中,而且在“Support”列上显示“YES”

mysql> show engines;+------------+----------+----------------------------------------------------------------+| Engine | Support | Comment

|+------------+----------+----------------------------------------------------------------+| MyISAM | DEFAULT | Default engine as of MySQL 3.23 with great performance

| ...| SPHINX | YES | Sphinx storage engine

| ...+------------+----------+----------------------------------------------------------------+13 rows in set (0.00 sec)

6.3. 使用SphinxSE要通过SphinxSE搜索,您需要建立特殊的ENGINE=SPHINX的“搜索表”,然后使用SELECT语句从中检索,把全文查询放在WHERE子句中。让我们从一个create语句和搜索查询的例子开始:CREATE TABLE t1( id INTEGER NOT NULL, weight INTEGER NOT NULL, query VARCHAR(3072) NOT NULL, group_id INTEGER, INDEX(query)) ENGINE=SPHINX CONNECTION="sphinx://localhost:3312/test";SELECT * FROM t1 WHERE query='test it;mode=any';搜索表前三列的类型必须是INTEGER,INTEGER和VARCHAR,这三列分别对应文档ID,匹配权值和搜索查询。查询列必须被索引,其他列必须无索引。列的名字会被忽略,所以可以任意命名。额外的列的类型必须是INTEGER或TIMESPTAMP之一。它们必须与Sphinx结果集中提供的属性按名称绑定,即它们的名字必须与中指定的属性名一一对应。如果Sphinx搜索结果中没有某个属性名,该列的值就为NULL.特殊的“虚拟”属性名也可以与SphinxSE列绑定。但特殊符号@用_sph_代替。例如,要取得@group和@count虚属性,列名应使用_sph_group和_sph_count。可以使用字符串参数CONNECTION来指定用这个表搜索时的默认搜索主机、端口号和索引。如果CREATE TABLE中没有使用连接(connection)串,那么默认使用索引名“*”(搜索所有索引)和localhost:3312。连接串的语法如下:CONNECTION="sphinx://HOST:PORT/INDEXNAME"默认的连接串也可以日后改变:ALTER TABLE t1 CONNECTION="sphinx://NEWHOST:NEWPORT/NEWINDEXNAME";也可以在查询中覆盖全部这些选项。如例子所示,查询文本和搜索选项都应放在WHERE子句中对query列的限制中(即第三列),选项之间用分号分隔,选项名与选项值用等号隔开。可以指定任意数目的选项。可用的选项如下:query —— 查询文本mode —— 匹配模式.必须是“all”, “any”, “phrase”, “boolean” 或 “extended之一,默认为“All”sort —— 匹配项排序模式 必须是“relevance”,“attr_desc”,“attr_asc”,

“time_segments”或“extended”之一。除了“relevance”模式,其他模式中还必须在一个冒号后附上属性名(或“extended”模式中的排序子句)。... WHERE query='test;sort=attr_asc:group_id';... WHERE query='test;sort=extended:@weight desc, group_id asc';offset —— 结果集中的偏移量,默认是0。

limit —— 从结果集中获取的匹配项数目,默认为20。Index —— 待搜索的索引:... WHERE query='test;index=test1;';... WHERE query='test;index=test1,test2,test3;';minid, maxid —— 匹配文档ID的最小值和最大值weights —— 逗号分隔的列表,指定Sphinx全文数据字段的权值... WHERE query='test;weights=1,2,3;';filter, !filter —— 逗号分隔的列表,指定一个属性名和一系列可匹配的属性值:# only include groups 1, 5 WHERE query='test;filter=group_id,1,5,19;';# exclude groups 3 WHERE query='test;!filter=group_id,3,11;';range, !range —— 逗号分隔的列表,指定一个属性名和该属性可匹配的最小值和最大值:# include groups from 3 to 7, WHERE query='test;range=group_id,3,7;';# exclude groups from 5 WHERE query='test;!range=group_id,5,25;';maxmatches —— 此查询最大匹配的数量:... WHERE query='test;maxmatches=2000;';groupby —— 分组(group-by)函数和属性:... WHERE query='test;groupby=day:published_ts;';... WHERE query='test;groupby=attr:group_id;';groupsort —— 分组(group-by)排序子句... WHERE query='test;groupsort=@count desc;';indexweights —— 逗号分隔的列表,指定一系列索引名和搜索时这些索引对应的权值... WHERE query='test;indexweights=idx_exact,2,idx_stemmed,1;';非常重要的注意事项:让Sphinx来对结果集执行排序、过滤和切片(slice)要比提高最大匹配项数量然后在MySQL端用WHERE、ORDER BY和LIMIT子句完成对应的功能来得高效得多。这有两方面的原因。首先,Sphinx对这些操作做了一些优化,比MySQL效率更高一些。其次,searchd可以打包更少的数据,SphinxSE也可以传输和解包更少的数据。除了结果集,额外的查询信息可以用SHOW ENGINE SPHINX STATUS语句获得:mysql> SHOW ENGINE SPHINX STATUS;+--------+-------+-------------------------------------------------+| Type | Name | Status |+--------+-------+-------------------------------------------------+| SPHINX | stats | total: 25, total found: 25, time: 126, words: 2 |

| SPHINX | words | sphinx:591:1256 soft:11076:15945 |

+--------+-------+-------------------------------------------------+2 rows in set (0.00 sec)

可以对SphinxSE搜索表和其他引擎的表之间使用JOIN,以下是一个例子,例中“documents”来自:mysql> SELECT content, date_added FROM nts docs-> JOIN t1 ON (=)

-> WHERE query="one document;mode=any";+-------------------------------------+---------------------+| content | docdate |+-------------------------------------+---------------------+| this is my test document number two | 2006-06-17 14:04:28 |

| this is my test document number one | 2006-06-17 14:04:28 |

+-------------------------------------+---------------------+2 rows in set (0.00 sec)mysql> SHOW ENGINE SPHINX STATUS;+--------+-------+---------------------------------------------+| Type | Name | Status |+--------+-------+---------------------------------------------+| SPHINX | stats | total: 2, total found: 2, time: 0, words: 2 |

| SPHINX | words | one:1:2 document:2:2 |

+--------+-------+---------------------------------------------+2 rows in set (0.00 sec)7. 报告 bugs很不幸,Sphinx还没有达到100%无bug(尽管我们正向这个目标努力),因此您可能偶尔遇到些问题。对于每个问题的报告越详细越好,这很重要——因为要想修复bug,我们必须重现bug并调试它,或者根据您提供的信息来推断出产生bug的原因。因此在此提供一些如何报告bug的指导。构建时问题如果Sphinx构建失败,请您:1.确认您的DBMS的头文件和库文件都正确安装了(例如,检查mysql-devel包已经安装)2.报告Sphinx的版本和配置文件(别忘了删除数据库连接密码),MySQL(或PostgreSQL)配置文件信息,gcc版本,操作系统版本和CPU类型(例如x86、x86-64、PowerPC等)mysql_configgcc --versionuname -a3.报告configure脚本或者gcc给出的错误信息(只需错误信息本身,不必附上整个构建日志)

运行时问题如果Sphinx已经成功构建并能运行,但运行过程中出现了问题,请您:1.描述您遇到的bug(即,您预期的行为和实际发生的行为),以及重现您遇到的问题需要的步骤。2.附带Sphinx的版本和配置文件(别忘了删除密码),MySQL(或PostgreSQL)配置文件信息,gcc版本,操作系统版本和CPU类型(例如x86、x86-64、PowerPC等)mysql --versiongcc --versionuname -a3.构建、安装和运行调试版本的全部Sphinx程序(这会启用很多内部校验,或称断言)make distclean./configure --with-debugmake installkillall -TERM searchd4.重新索引,检查是否有断言被触发(如果是,那很可能是索引损坏了并造成了问题)5.如果bug在调试版本中没有重现,请回到非调试版本并在报告中说明这个情况。6.如果bug可以在您的数据库的很小的子集(1-100条记录)上重现,请提供一个该子集的gzip压缩包。7.如果问题与searchd有关,请在bug报告中提供和中的相关条目。8.如果问题与searchd有关,请尝试在console模式下运行它并检查它是否因断言失败而退出。./searchd --console9.如果任何一个程序因断言失败而退出,请提供断言信息。调试断言,崩溃和停止响应如果任何一个程序因断言失败而退出,崩溃或停止响应,您可以额外生成一个内存转储文件并检查它。1.启用内存转储。在大多数Linux系统上,可以用ulimit命令启用它。ulimit -c 327682.运行程序,尝试重现bug。3.如果程序崩溃(可能有断言失败的情况也可能没有),在当前目录下找到内存转储文件(一般会打印“Segmentation fault (core dumped)”消息)4.如果程序停止响应,在另一个控制台上用kill -SEGV强制退出并获得内存转储:kill -SEGV HANGED-PROCESS-ID5.使用gdb检查转储文件,查看backtracegdb ./CRASHED-PROGRAM-FILE-NAME CORE-DUMP-FILE-NAME(gdb) bt(gdb) quit提示: HANGED-PROCESS-ID(停止响应的进程ID), CRASHED-PROGRAM-FILE-NAME(崩溃程序的文件名) and CORE-DUMP-FILE-NAME(核心转储文件的文件名)应

该被换成具体的数字和文件名。例如,一次对停止响应的searchd的调试会话看起来应该像下面这样:# kill -SEGV 12345# ls *core*core.12345# gdb ./searchd core.12345(gdb) bt...(gdb) quit注意ulimit并不是整个服务器范围的,而是仅影响当前的shell会话。因此您不必还原任何服务器范围的限制——但是一旦重新登陆,您就需要再次设置ulimit。核心内存转储文件会存放在当前工作目录下(Sphinx的各个程序不会改变工作目录),因此它们就在那。不要立刻删除转储文件,从它里面可能获得更多有用的信息。您不需要把这个文件发送给我们(因为调试信息与您的系统本身紧密相关),但我们可能会向您询问一些与之相关的问题。8. 选项参考8.1. 数据源配置选项8.1.1. type数据源类型。必须选项,无默认值。已知的类型包括mysql,pgsql,xmlpipe和xmlpipe2。所有其他与数据源相关的选项都依赖于这个选项指定的源类型。与SQL数据源(即MySQL和PostgreSQL)相关的选项以“sql_”开头,而与xmlpipe和xmlpipe2数据源相关的选项则以“xmlpipe_”开头。示例:type = mysql8.1.2. sql_host要连接的SQL服务器主机地址。必须选项,无默认值。仅对SQL数据源(mysql和pgsql)有效。最简单的情形下,Sphinx与MySQL或PostgreSQL服务器安装在同一台主机上,此时您只须设置为localhost即可。注意,MySQL客户端库根据主机名决定是通过TCP/IP还是UNIX

socket连接到服务器。一般来说,“localhost”使之强制使用UNIX socket连接(这是默认的也是推荐的模式),而“127.0.01”会强制使用TCP/IP。细节请参考 MySQL 文档 。示例:sql_host = localhost8.1.3. sql_port要连接的SQL服务器的IP端口。可选选项,默认值为mysql端口3306,pgsql端口5432。

仅适用于SQL数据源(mysql和pgsql)。注意,此选项是否实际被使用依赖于sql_host选项。示例:sql_port = 33068.1.4. sql_user连接到sql_host时使用的SQL用户名。必须选项,无默认值。仅适用于SQL数据源(mysql和pgsql)。示例:sql_user = test8.1.5. sql_pass连接到sql_host时使用的SQL用户密码。必须选项,无默认值。仅适用于SQL数据源(mysql和pgsql)。示例:sql_pass = mysecretpassword8.1.6. sql_db连接到SQL数据源之后使用的SQL数据库,此后的查询均在此数据库上进行。必须选项,无默认值。仅适用于SQL数据源(mysql和pgsql)。示例:sql_db = test8.1.7. sql_sock连接到本地SQL服务器时使用的UNIX socket名称。可选选项,默认值为空(使用客户端库的默认设置)。仅适用于SQL数据源(mysql和pgsql)。在Linux上,通常是/var/lib/mysql/。 而在FreeBSD上通常是/tmp/。注意此选项是否实际被使用依赖与sql_host的设置。示例:sql_sock = /tmp/8.1.8. mysql_connect_flagsMySQL客户端的连接标志(connection flags)。可选选项,默认值为0(不设置任何标志)。仅适用于SQL数据源(mysql和pgsql)。此选项必须包含各标志相加所得的整型值。此整数将被原样传递给mysql_real_connect() 。可用的标志在mysql_com.h中列举。下面列举的是几个与索引相关的标志和它们的值:

CLIENT_COMPRESS = 32; 允许使用压缩协议CLIENT_SSL = 2048; 握手后切换到SSLCLIENT_SECURE_CONNECTION = 32768; 新的4.1版本身份认证例如,标志2080(2048+32)代表同时使用压缩和SSL,32768代表仅使用新的身份验证。起初这个选项是为了在indexer和mysql位于不同主机的情况下使用压缩协议而引入的。尽管降低了网络带宽消耗,但不管在理论上还是在现实中,在1Gbps的链路上启用压缩很可能恶化索引时间。然而在100Mbps的连输上启用压缩可能会明显地改善索引时间(有报告说总的索引时间降低了20-30%)。根据您网络的连接情况,您获得的改善程度可能会有所不同。示例:mysql_connect_flags = 32 # enable compression8.1.9. sql_query_pre取前查询(pre-fetch query),或预查询(pre-query)。多值选项,可选选项,默认为一个空的查询列表。仅适用于SQL数据源(mysql和pgsql)。多值意思是您可以指定多个预查询。它们在主查询之前执行,而且会严格按照在配置文件中出现的顺序执行。预查询的结果会被忽略。预查询在很多时候有用。它们被用来设置字符编码,标记待索引的记录,更新内部计数器,设置SQL服务器连接选项和变量等等。也许预查询最常用的一个应用就是用来指定服务器返回行时使用的字符编码。这必须与Sphinx期待的编码相同(在charset_type 和charset_table 选项中设置)。以下是两个与MySQL有关的设置示例:sql_query_pre = SET CHARACTER_SET_RESULTS=cp1251sql_query_pre = SET NAMES utf8对于MySQL数据源,在预查询中禁用查询缓冲(query cache)(仅对indexer连接)是有用的,因为索引查询一般并会频繁地重新运行,缓冲它们的结果是没有意义的。这可以按如下方法实现:sql_query_pre = SET SESSION query_cache_type=OFF示例:sql_query_pre = SET NAMES=utf8sql_query_pre = SET SESSION query_cache_type=OFF8.1.10. sql_query获取文档的主查询。必须的选项,无默认选项。仅适用于SQL数据源(mysql和pgsql)。只能有一个主查询。它被用来从SQL服务器获取文档(文档列表)。可以指定多达32个全文数据字段(严格来说是在sphinx.h中定义的SPH_MAX_FIELDS个)和任意多个属性。所有既不是文档ID(第一列)也不是属性的列的数据会被用于建立全文索引。文档ID必须是第一列,而且必须是唯一的正整数值(不能是0也不能是负数),既可以是32位的也可以是64位的,这要根据Sphinx是如何被构建的,默认情况下文档ID是32位的,

但在运行configure脚本时指定--enable-id64选项会打开64位文档ID和词ID的支持。示例:sql_query = SELECT id, group_id, UNIX_TIMESTAMP(date_added) AS date_added, title, content FROM documents8.1.11. sql_query_range分区查询设置。可选选项,默认为空。仅适用于SQL数据源(mysql和pgsql)。设置这个选项会启用文档的分区查询(参看 节 3.7, “ 分区查询 ” )。分区查询有助于避免在索引大量数据时发生MyISAM表臭名昭著的死锁问题。(同样有助于解决其他不那么声名狼藉的问题,比如大数据集上的性能下降问题,或者InnoDB对多个大型读事务(read

transactions)进行序列化时消耗额外资源的问题。)此选项指定的查询语句必须获取用于分区的最小和最大文档ID。它必须返回正好两个整数字段,先是最小ID然后是最大ID,字段的名字会被忽略。当启用了分区查询时,sql_query要求包括$start和$end宏(因为重复多次索引整个表显然是个错误)。注意,$start..$end所指定的区间不会重叠,因此不会在查询中删除ID正好等于$start或$end的文档。 节 3.7, “ 分区查询 ” 中的例子解释了这个问题,注意大于等于或小于等于比较操作是如何被使用的。示例:sql_query_range = SELECT MIN(id),MAX(id) FROM documents8.1.12. sql_range_step分区查询的步进。可选选项,默认为1024。仅适用于SQL数据源(mysql和pgsql)。仅当启用ranged queries 时有效。用sql_query_range 取得的文档ID区间会被以这个不小的间隔步数跳跃遍历。例如,如果取得的最小和最大ID分别是12和3456,而间隔步数是1000,那么indexer会用下面这些值重复调用几次sql_query()$start=12, $end=1011$start=1012, $end=2011$start=2012, $end=3011$start=3012, $end=3456示例:sql_range_step = 10008.1.13. sql_attr_uint声明无符号整数属性(attribute)。可声明同一类型的多个不同名称的属性,可选项。仅适用于SQL数据源(mysql和pgsql)。被声明的列的值必须在32位无符号整型可表示的范围内。超出此范围的值也会被接受,但

会溢出。例如-1会变成 2^32-1 或者说4,294,967,295。您可以在属性名后面附加“:BITCOUNT”(见下面的示例)以便指定整型属性的位数。属性小于默认32位(此时称为位域)会有损性能。但它们在外部存储( extern storage ) 模式下可以节约内存:这些位域被组合成32位的块存储在.spa属性数据文件中。如果使用内联存储(inline storage),则位宽度的设置会被忽略。示例:sql_attr_uint = group_idsql_attr_uint = forum_id:9 # 9 bits for forum_id8.1.14. sql_attr_bool声明布尔属性(attribute)。可声明同一类型的多个不同名称的属性,可选项。仅适用于SQL数据源(mysql和pgsql)。等价于用sql_attr_uint声明为1位。示例:sql_attr_bool = is_deleted # will be packed to 1 bit8.1.15. sql_attr_timestamp声明UNIX时间戳属性(attribute)。可声明同一类型的多个不同名称的属性,可选项。仅适用于SQL数据源(mysql和pgsql)。这个列的值必须是UNIX格式的时间戳,即32位无符号整数表示的自格林尼治平时1970年1月1日午夜起过去的秒数。时间戳在内部是按整数值存储和处理的。但除了将时间戳按整数使用,还可以对它们使用多种与日期相关的函数——比如时间段排序模式,或为分组(GROUP BY)抽取天/星期/月/年。注意MySQL中的DATE和DATETIME列类型不能直接作为时间戳使用,必须使用UNIX_TIMESTAMP函数将这些列做显式转换。示例:sql_attr_timestamp = UNIX_TIMESTAMP(added_datetime) AS added_ts8.1.16. sql_attr_str2ordinal声明字符串序数属性(attribute )。可声明同一类型的多个不同名称的属性,可选项。仅适用于SQL数据源(mysql和pgsql)。这个属性类型(简称为字串序数)的设计是为了允许按字符串值排序,但不存储字符串本身。对字串序数做索引时,字符串值从数据库中取出、暂存、排序然后用它们在该有序数组中的序数代替它们自身,因此字串序数是个整型,对它们的大小比较与在原字串上做字典序比较结果相同。早期版本上,对字串序数做索引可能消耗大量的RAM。自r1112起,字串序数的积累和排序也可在固定大小的内存中解决了(代价是额外的临时磁盘空间),并受mem_limit 设置限制。理想中字符串可以根据字符编码和本地选项(locale)排序。例如,如果已知字符串为KOI8R编码下的俄语字串,那么对字节0xE0,0xE1和0xE2排序结果应为0xE1,0xE2和0xE0,因为0xE0在KOI8R中代表的字符明显应在0xE1和0xE2之后。但很不幸,Sphinx目

前不支持这个功能,而是简单地按字节值大小排序。示例:sql_attr_str2ordinal = author_name8.1.17. sql_attr_float声明浮点型属性(attribute)。可声明同一类型的多个不同名称的属性,可选项。仅适用于SQL数据源(mysql和pgsql)。属性值按单精度32位IEEE754格式存储。可表示的范围大约是1e-38到1e+38。可精确表示的小数大约是7位。浮点属性的一个重要应用是存储经度和纬度值(以角度为单位),经纬度值在查询时的地表距离计算中有用。示例:sql_attr_float = lat_radianssql_attr_float = long_radians8.1.18. sql_attr_multi声明多值属性(MVA,Multi-valued attribute)。可声明同一类型的多个不同名称的属性,可选项。仅适用于SQL数据源(mysql和pgsql)。简单属性每篇文档只允许一个值。然而有很多情况(比如tags或者类别)需要将多个值附加给同一个属性,而且要对这个属性值列表做过滤或者分组。声明格式如下(用反斜线只是为了清晰,您仍可以在一行之内完成声明):sql_attr_multi = ATTR-TYPE ATTR-NAME 'from' SOURCE-TYPE [;QUERY] [;RANGE-QUERY]其中ATTR-TYPE 是 'uint' 或 'timestamp'之一SOURCE-TYPE 是 'field', 'query', 或 'ranged-query'之一QUERY 是用来取得全部(文档ID,属性值)序对的SQL查询RANGE-QUERY 是用来取得文档ID的最小值与最大值的SQL查询,与'sql_query_range'类似示例:sql_attr_multi = uint tag from query; SELECT id, tag FROM tagssql_attr_multi = uint tag from ranged-query; SELECT id, tag FROM tags WHERE id>=$start AND id<=$end; SELECT MIN(id), MAX(id) FROM tags8.1.19. sql_query_post取后查询。可选项,默认值为空。仅适用于SQL数据源(mysql和pgsql)。此查询在sql_query 成功执行后立即执行。如果取后查询产生了错误,该错误被当作警告被

报告,但索引不会因此终止。取后查询的结果会被忽略。注意当取后查询执行时索引还尚未完成,而后面的索引仍然可能失败。因此在这个查询中不应进行任何永久性的更新。例如,不应在此查询中更新辅助表中存储的最近成功索引的文档ID值,请在后索引查询(post-index query)中操作。示例:sql_query_post = DROP TABLE my_tmp_table8.1.20. sql_query_post_index后索引查询。可选项,默认值为空。仅适用于SQL数据源(mysql和pgsql)。此查询在索引完全成功结束后执行。如果此查询产生错误,该错误会被当作警告报告,但索引不会因此而终止。该查询的结果集被忽略。此查询中可以使用宏$maxid,它会被扩展为索引过程中实际得到的最大的文档ID。示例:sql_query_post_index = REPLACE INTO counters ( id, val ) VALUES ( 'max_indexed_id', $maxid )8.1.21. sql_ranged_throttle分区查询的间隔时间(throttling),单位是毫秒。可选选项,默认值为0(无间隔时间)。仅适用于SQL数据源(mysql和pgsql)。此选项旨在避免indexer对数据库服务器构成了太大的负担。它会使indexer在每个分区查询的步之后休眠若干毫秒。休眠无条件执行,并在取结果的查询之前执行。示例:sql_ranged_throttle = 1000 # sleep for 1 sec before each query step8.1.22. sql_query_info文档信息查询。可选选项,默认为空。仅对mysql数据源有效。仅被CLI搜索所用,用来获取和显示文档信息,目前仅对MySQL有效,且仅用于调试目的。此查询为每个文档ID获取CLI搜索工具要显示的文档信息。示例:sql_query_info = SELECT * FROM documents WHERE id=$id8.1.23. xmlpipe_command调用xmlpipe流提供者的Shell命令。必须选项。仅对xml_pipe和xml_pipe2数据源有效。指定的命令会被运行,其输出被当作XML文档解析。具体格式描述请参考 节 3.8, “xmlpipe

数据源”或 节 3.9, “xmlpipe2 数据源 ”

示例:xmlpipe_command = cat /home/sphinx/8.1.24. xmlpipe_field声明xmlpipe数据字段。可声明同一类型的多个不同名称的属性,可选项。仅对xmlpipe2数据源有效。参考 节 3.9, “xmlpipe2 数据源 ”

示例:xmlpipe_field = subjectxmlpipe_field = content8.1.25. xmlpipe_attr_uint声明xmlpipe整型属性。可声明同一类型的多个不同名称的属性,可选项。仅对xmlpipe2数据源有效。语法与sql_attr_uint 完全相同。示例:xmlpipe_attr_uint = author8.1.26. xmlpipe_attr_bool声明xmlpipe布尔型属性。可声明同一类型的多个不同名称的属性,可选项。仅对xmlpipe2数据源有效。语法与sql_attr_bool 完全相同。示例:xmlpipe_attr_bool = is_deleted # will be packed to 1 bit8.1.27. xmlpipe_attr_timestamp声明xmlpipe UNIX时间戳属性。可声明同一类型的多个不同名称的属性,可选项。仅对xmlpipe2数据源有效。语法与sql_attr_timestamp 完全相同。示例:xmlpipe_attr_timestamp = published8.1.28. xmlpipe_attr_str2ordinal声明xmlpipe字符序数属性。可声明同一类型的多个不同名称的属性,可选项。仅对xmlpipe2数据源有效。语法与sql_attr_str2ordinal 完全相同。示例:xmlpipe_attr_str2ordinal = author_sort

8.1.29. xmlpipe_attr_float声明xmlpipe浮点型属性。可声明同一类型的多个不同名称的属性,可选项。仅对xmlpipe2数据源有效。语法与sql_attr_float 完全相同。示例:xmlpipe_attr_float = lat_radiansxmlpipe_attr_float = long_radians8.1.30. xmlpipe_attr_multi声明xmlpipe MVA属性。可声明同一类型的多个不同名称的属性,可选项。仅对xmlpipe2数据源有效。这个选项为xmlpipe2流声明一个MVA属性标签。该标签的内容会被试图解析成一个整型值的列表(数组),此列表构成一个MVA属性值,这与把MVA属性的数据源设置为“字段”时sql_attr_multi 分析SQL列内容的方式类似。示例:xmlpipe_attr_multi = taglist8.2.索引配置选项8.2.1. type索引类型。可选选项,默认值为空(索引为简单本地索引)。可用的值包括空字符串或“distributed”Sphinx支持两种不同的索引类型:本地——在本机上存储和处理,和远程——不仅涉及本地搜索,而且同时通过网络向远程searchd实力做查询。索引类似选项使您可以选择使用何种索引。索引默认是本地型。指定“distributed”索引类型会运行分布式搜索,参看 节 4.7, “ 分

布式搜索”示例:type = distributed8.2.2. source向本地索引增加文档源。可以出现多次,必须选项。为当前索引指定一个从中可以获取文档的文档源。必须至少有一个文档源。可以有多个文档源,任何数据源类型都可接受:即您可以从MySQL服务器中获取一部分数据,从PostgreSQL中获取另一部分,再在文件系统上使用xmlpipe2 wrapper获取一部分。然而,对源数据却有一些限制。首先,文档ID必须在所有源的总体上是唯一的。如果这个条件不满足,那可能导致非预期的搜索结果。其次,源的模式必须相同,以便在同一个索引

中存储。数据来源的ID不会被自动存储。因此,为了获知匹配的文档是从哪个数据源中来的,需要手工存储一些额外的信息。通常有两种方法:1.修改文档ID,将源ID编码进去:source src1{ sql_query = SELECT id*10+1, ... FROM table1 ...}source src2{ sql_query = SELECT id*10+2, ... FROM table2 ...}2.将数据来源存储为一个属性source src1{ sql_query = SELECT id, 1 AS source_id FROM table1 sql_attr_uint = source_id ...}source src2{ sql_query = SELECT id, 2 AS source_id FROM table2 sql_attr_uint = source_id ...}示例:source = srcpart1source = srcpart2source = srcpart38.2.3. path索引文件的路径和文件名(不包括扩展名)。必须选项。path既包括文件夹也包括文件名,但不包括扩展名。indexer在产生永久和临时索引文件的最终名字时会附加上不同的扩展名。永久数据文件有几个不同的扩展名,都以“.sp”开头,临时文件的扩展名以“.tmp”开头。如果indexer没有成功地自动删除.tmp*文件,手工删除是安全的。以下是不同索引文件所存储的数据种类,供参考:.spa 存储文档属性(仅在extern_docinfo存储模式中使用).spd 存储每个词ID可匹配的文档ID列表.sph 存储索引头信息.spi 存储词列表(词ID和指向.spd文件的指针)


本文标签: 查询 文档 属性 结果