原型： function GetLastError()

以可读形式返回最近的错误描述信息。如果前一次API调用没有错误，返回空字符串。

任何其他函数（如 Query()）失败后（函数失败一般返回false），都应该调用这个函数，它将返回错误的描述。

此函数本身并不重置对错误描述，因此如有必要，可以多次调用。

原型： function GetLastWarning ()

以可读格式返回最近的警告描述信息。如果前一次API调用没有警告，返回空字符串。

您应该调用这个函数来确认您的请求（如 Query()）是否虽然完成了但产生了警告。例如，即使几个远程代理超时了，对分布式索引的搜索查询也可能成功完成。这时会产生一个警告信息。

此函数本身不会重置警告信息，因此如有必要，可以多次调用。

原型： function SetServer ( $host, $port )

设置searchd的主机名和TCP端口。此后的所有请求都使用新的主机和端口设置。默认的主机和端口分别是“localhost”和9312。

原型： function SetRetries ( $count, $delay=0 )

设置分布式搜索重试的次数和延迟时间。

对于暂时的失败，searchd对每个代理重试至多$count次。$delay是两次重试之间延迟的时间，以毫秒为单位。默认情况下，重试是禁止的。注意，这个调用不会使API本身对暂时失败进行重试，它只是让searchd这样做。目前暂时失败包括connect()调用的各种失败和远程代理超过最大连接数（过于繁忙）的情况。

原型： function SetConnectTimeout ( $timeout )

设置连接超时时间，在与服务器连接时，如果超过这个时间没有连上就放弃。

有时候服务器在响应上会有所延迟，这有可能由于网络的延时，也有可能是因为服务器未处理完的查询太多，堆积所致。不管是什么情况，有了这个选项，就给客户端应用程序提供了一定的控制权，让它可以决定当searchd不可用的时候如何处理，而且可以避免脚本由于超过运行限制而运行失败（尤其是在PHP里）

当连接失败的而时候，会将合适的错误码返回给应用程序，以便在应用程序级别进行错误处理和通知用户。

原型： function SetArrayResult ( $arrayresult )

PHP专用。控制搜索结果集的返回格式（匹配项按数组返回还是按hash返回）

$arrayresult 参数应为布尔型。如果$arrayresult为false（默认），匹配项以PHP hash格式返回，文档ID为键，其他信息（权重、属性）为值。如果$arrayresult为true，匹配项以普通数组返回，包括匹配项的全部信息（含文档ID）

这个调用是对MVA属性引入分组支持时同时引入的。对MVA分组的结果可能包含重复的文档ID。因此需要将他们按普通数组返回，因为hash对每个文档ID仅能保存一个记录。

原型： function IsConnectError ()

检查上一个错误是API层面的网络错误还是searchd返回的远程错误。如果是上一次连接searchd的尝试在API层面失败了，返回真，否则返回假（错误发生在远程，或者根本没有尝试连接）。 这是在版本0.9.9-rc1引入的。

原型： 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_matches这个设置控制搜索过程中searchd在内存中所保持的匹配项数目。一般来说，即使设置了max_matches为1，全部的匹配文档也都会被处理、评分、过滤和排序。但是任一时刻只有最优的N个文档会被存储在内存中，这是为了性能和内存使用方面的原因，这个设置正是控制这个N的大小。注意，max_matches在两个地方设置。针对单个查询的限制由这个API调用指定。但还有一个针对整个服务器的限制，那是由配置文件中的max_matches设置控制的。为防止滥用内存，服务器不允许单个查询的限制高于服务器的限制。

在客户端不可能收到超过max_matches个匹配项。默认的限制是1000，您应该不会遇到需要设置得更高的情况。1000个记录足够向最终用户展示了。如果您是想将结果传输给应用程序以便做进一步排序或过滤，那么请注意，在Sphinx端完成效率要高得多。

$cutoff 设置是为高级性能优化而提供的。它告诉searchd 在找到并处理$cutoff个匹配后就强制停止。

原型： function SetMaxQueryTime ( $max_query_time )

设置最大搜索时间，以毫秒为单位。参数必须是非负整数。默认值为0，意思是不做限制。

这个设置与SetLimits()中的$cutoff相似，不过这个设置限制的是查询时间，而不是处理的匹配数目。一旦处理时间已经太久，本地搜索查询会被停止。注意，如果一个搜索查询了多个本地索引，那这个限制独立地作用于这几个索引。

原型： function SetOverride ( $attrname, $attrtype, $values )

设置一个临时的（只对单个查询有效）针对不同文档的属性值覆盖。只支持标量属性。$value是一个哈希表，他的键是要覆盖属性的文档ID，之是对应该文档ID的要覆盖的值。 于版本0.9.9-rc1引入。

属性覆盖特性使用户可以针对一次查询“临时性地”修改一些文档的值，不影响其他查询。这个函数可以用来进行数据个性化。例如，假设正在实现一个个性 化搜索函数，用来将朋友推荐的帖子排在前面，这类数据不仅是动态的，而且是个性化的，因此不能简单地把这种数据放入索引，因为不能影响其他用户的搜索。而 覆盖机制是针对单个查询的，不会影响其他人。因此可以，比如说，给每个文档设置一个“friends_weight”属性，默认值是0，然后临时将文档 123，456，789（当前用户的朋友推荐的）的这个属性设置为1，最后用这个值进行相关度计算。

原型： function SetSelect ( $clause )

设置select子句，列出具体要取出的属性以及要计算并取出的expressions。子句的语法模仿了SQL。于版本0.9.9-rc1引入。

SetSelect()于标准SQL查询中SELECT和FROM之间的部分非常相近。它允许你指定要取出哪些属性（列），以及在这些列上要计算和 取出哪些表达式。与SQL语言的区别是，表达式必须用关键字AS给每个表达式取一个别名，别名必须是有效的标识符（由字母和数字组成）。在SQL里面可以 这样做，但是不是强制的。Sphinx强制必须有别名，以便计算结果总是可以以一个“正常”的名字在结果集中返回，或者在其他子句中引用，等等。

其他方面基本上等同于SQL。支持星号（“*”），支持函数，支持任意数目的表达式。计算出的表达式可以用于排序、过滤和分组，这与其他常规属性相同。

从版本0.9.9-rc2开始，允许使用GROUP BY的时候使用聚集函数（AVG(), MIN(), MAX(), SUM()）。

表达式排序（Section 4.5, “SPH_SORT_EXPR 模式”）和地表距离计算函数（Section 6.4.5, “SetGeoAnchor （设置地表距离锚点）”）现在的内部实现就是这种表达式计算机制，分别使用“魔法名字”“@expr”和“@geodist”。

示例：

$cl->SetSelect ( "*, @weight+(user_karma+ln(pageviews))*0.1 AS myweight" );
$cl->SetSelect ( "exp_years, salary_gbp*{$gbp_usd_rate} AS salary_usd,
   IF(age>40,1,0) AS over40" );
$cl->SetSelect ( "*, AVG(price) AS avgprice" );

原型： function SetMatchMode ( $mode )

设置全文查询的匹配模式，见Section 4.1, “匹配模式”中的描述。参数必须是一个与某个已知模式对应的常数。

警告： （仅PHP）查询模式常量不能包含在引号中，那给出的是一个字符串而不是一个常量：

$cl->SetMatchMode ( "SPH_MATCH_ANY" ); // INCORRECT! will not work as expected
$cl->SetMatchMode ( SPH_MATCH_ANY ); // correct, works OK

原型： function SetRankingMode ( $ranker )

设置评分模式。目前只在SPH_MATCH_EXTENDED2这个匹配模式中提供。参数必须是与某个已知模式对应的常数。

Sphinx默认计算两个对最终匹配权重有用的因子。主要是查询词组与文档文本的相似度。其次是称之为BM25的统计函数，该函数值根据关键字文档中的频率（高频导致高权重）和在整个索引中的频率（低频导致高权重）在0和1之间取值。

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

已经实现的模式包括：

原型： function SetSortMode ( $mode, $sortby="" )

设置匹配项的排序模式，见Section 4.5, “排序模式”中的描述。参数必须为与某个已知模式对应的常数。

警告： （仅PHP）查询模式常量不能包含在引号中，那给出的是一个字符串而不是一个常量：

$cl->SetSortMode ( "SPH_SORT_ATTR_DESC" ); // INCORRECT! will not work as expected
$cl->SetSortMode ( SPH_SORT_ATTR_ASC ); // correct, works OK

原型： function SetWeights ( $weights )

按在索引中出现的先后顺序给字段设置权重。 不推荐使用, 建议使用 SetFieldWeights()。

原型： function SetFieldWeights ( $weights )

按字段名称设置字段的权值。参数必须是一个hash（关联数组），该hash将代表字段名字的字符串映射到一个整型的权值上。

字段权重影响匹配项的评级。Section 4.4, “权值计算” 解释了词组相似度如何影响评级。这个调用用于给不同的全文数据字段指定不同于默认值的权值。

给定的权重必须是正的32位整数。最终的权重也是个32位的整数。默认权重为1。未知的属性名会被忽略。

目前对权重没有强制的最大限制。但您要清楚，设定过高的权值可能会导致出现32位整数的溢出问题。例如，如果设定权值为10000000并在扩展模式中进行搜索，那么最大可能的权值为10M（您设的值）乘以1000（BM25的内部比例系数，参见Section 4.4, “权值计算”, “权值计算”）再乘以1或更多（词组相似度评级）。上述结果最少是100亿，这在32位整数里面没法存储，将导致意想不到的结果。

原型： function SetIndexWeights ( $weights )

设置索引的权重，并启用不同索引中匹配结果权重的加权和。参数必须为在代表索引名的字符串与整型权值之间建立映射关系的hash（关联数组）。默认值是空数组，意思是关闭带权加和。

当在不同的本地索引中都匹配到相同的文档ID时，Sphinx默认选择查询中指定的最后一个索引。这是为了支持部分重叠的分区索引。

然而在某些情况下索引并不仅仅是被分区了，您可能想将不同索引中的权值加在一起，而不是简单地选择其中的一个。SetIndexWeights()允许您这么做。当开启了加和功能后，最后的匹配权值是各个索引中的权值的加权合，各索引的权由本调用指定。也就是说，如果文档123在索引A被找到，权值是2，在B中也可找到，权值是3，而且您调用了SetIndexWeights ( array ( "A"=>100, "B"=>10 ) )，那么文档123最终返回给客户端的权值为2*100+3*10 = 230。

原型： function SetIDRange ( $min, $max )

设置接受的文档ID范围。参数必须是整数。默认是0和0，意思是不限制范围。

此调用执行后，只有ID在$min和$max（包括$min和$max）之间的文档会被匹配。

原型： function SetFilter ( $attribute, $values, $exclude=false )

增加整数值过滤器。

此调用在已有的过滤器列表中添加新的过滤器。$attribute是属性名。$values是整数数组。$exclude是布尔值，它控制是接受匹配的文档（默认模式，即$exclude为false时）还是拒绝它们。

只有当索引中$attribute列的值与$values中的任一值匹配时文档才会被匹配（或者拒绝，如果$exclude值为true）

原型： function SetFilterRange ( $attribute, $min, $max, $exclude=false )

添加新的整数范围过滤器。

此调用在已有的过滤器列表中添加新的过滤器。$attribute是属性名, $min 、$max定义了一个整数闭区间，$exclude布尔值，它控制是接受匹配的文档（默认模式，即$exclude为false时）还是拒绝它们。

只有当索引中$attribute列的值落在$min 和 $max之间（包括$min 和 $max），文档才会被匹配（或者拒绝，如果$exclude值为true）。

原型： function SetFilterFloatRange ( $attribute, $min, $max, $exclude=false )

增加新的浮点数范围过滤器。

此调用在已有的过滤器列表中添加新的过滤器。$attribute是属性名, $min 、$max定义了一个浮点数闭区间，$exclude必须是布尔值，它控制是接受匹配的文档（默认模式，即$exclude为false时）还是拒绝它们。

只有当索引中$attribute列的值落在$min 和 $max之间（包括$min 和 $max），文档才会被匹配（或者拒绝，如果$exclude值为true）。

原型： function SetGeoAnchor ( $attrlat, $attrlong, $lat, $long )

为地表距离计算设置锚点，并且允许使用它们。

$attrlat 和 $attrlong是字符串，分别指定了对应经度和纬度的属性名称。$lat 和 $long是浮点值，指定了锚点的经度和纬度值，以角度为单位。

一旦设置了锚点，您就可以在您的过滤器和/或排序表达式中使用"@geodist"特殊属性。Sphinx将在每一次全文检索中计算给定经纬度与锚点之前的地表距离，并把此距离附加到匹配结果上去。SetGeoAnchor和索引属性数据中的经纬度值都是角度。而结果会以米为单位返回，因此地表距离1000.0代表1千米。一英里大约是1609.344米。

原型： function SetGroupBy ( $attribute, $func, $groupsort="@group desc" )

设置进行分组的属性、函数和组间排序模式，并启用分组（参考Section 4.6, “结果分组（聚类）”中的描述）。

$attribute是字符串，为进行分组的属性名。$func为 常数，它指定内建函数，该函数以前面所述的分组属性的值为输入，目前的可选的值为： SPH_GROUPBY_DAY、SPH_GROUPBY_WEEK、 SPH_GROUPBY_MONTH、 SPH_GROUPBY_YEAR、SPH_GROUPBY_ATTR 。 $groupsort 是控制分组如何排序的子句。其语法与Section 4.5, “SPH_SORT_EXTENDED 模式”中描述的相似。

分组与SQL中的GROUP BY子句本质上相同。此函数调用产生的结果与下面伪代码产生的结果相同。

SELECT ... GROUP BY $func($attribute) ORDER BY $groupsort

注意，影响最终结果集中匹配项顺序的是$groupsort。排序模式（见Section 6.3.3, “SetSortMode （设置排序模式）”）影响每个分组内的顺序，即每组内哪些匹配项被视为最佳匹配。比如，组之间可以根据每组中的匹配项数量排序的同时每组组内又根据相关度排序。

从版本 0.9.9-rc2 开始, 聚合函数 (AVG(), MIN(), MAX(), SUM()) 可以在GROUP BY时被 SetSelect() API 调用。

原型： 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 @count
FROM products
GROUP BY category
ORDER BY @count DESC

在上述示例伪代码中，SetGroupDistinct()调用只与COUNT(DISINCT vendor)对应。GROUP BY，ORDER By和COUNT(*)子句则与SetGroupBY()调用等价。两个查询都会在每类中返回一个匹配的行。除了索引中的属性，匹配项还可以包含每类的匹配项计数和每类中不同来源 ID的计数。

原型： function Query ( $query, $index="*", $comment="" )

连接到searchd服务器，根据服务器的当前设置执行给定的查询，取得并返回结果集。

$query是查询字串，$index是包含一个或多个索引名的字符串。一旦发生一般错误，则返回假并设置GetLastError()信息。若成功则返回搜索的结果集。 此外, $comment 将被发送到查询日志中搜索部分的前面，这对于调试是非常有用的。目前，注释的长度限制为128个字符以内。

$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可能使用其他数据结构） ，包含如下键和值：

需要指出的是 Query() 索执行的操作，与没有中间步骤的 AddQuery()和 RunQueries() 相同 ； 它类似一次单独的AddQuery()调用，紧跟一次相应的RunQueries()调用，然后返回匹配的第一个数组元素 （从第一次，也是仅有的一次查询返回）。

原型： function AddQuery ( $query, $index="*", $comment="" )

向批量查询增加一个查询。$query为查询串。$index为包含一个或多个索引名的字符串。 此外, 如果提供了$comment，它 将被发送到查询日志中搜索部分的前面，这对于调试是非常有用的。目前，注释的长度限制为128个字符以内。返回RunQueries()返回的数组中的一个下标。

批量查询（或多查询）使searchd能够进行可能的内部优化，并且无论在任何情况下都会减少网络连接和进程创建方面的开销。相对于单独的查询，批量查询不会引入任何额外的开销。因此当您的Web页运行几个不同的查询时，一定要考虑使用批量查询。

例如，多次运行同一个全文查询，但使用不同的排序或分组设置，这会使searchd仅运行一次开销昂贵的全文检索和相关度计算，然后在此基础上产生多个分组结果。

有时您不仅需要简单地显示搜索结果，而且要显示一些与类别相关的计数信息，例如按制造商分组后的产品数目，此时批量查询会节约大量的开销。若无批量 查询，您会必须将这些本质上几乎相同的查询运行多次并取回相同的匹配项，最后产生不同的结果集。若使用批量查询，您只须将这些查询简单地组成一个批量查 询，Sphinx会在内部优化掉这些冗余的全文搜索。

AddQuery() 在内部存储全部当前设置状态以及查询，您也可在后续的AddQuery()调用中改变设置。早先加入的查询不会被影响，实际上没有任何办法可以改变它们。下面是一个示例：

$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()之前设置的任何过滤，都会被后续查询继续使用。因此，如果在第一个查询前使用SetFilter()，则通过AddQuery()执行的第二个查询（以及随后的批量查询）都会应用同样的过滤，除非你先调用ResetFilters()来清除过滤规则。同时，你还可以随时加入新的过滤规则

AddQuery()并不修改当前状态。也就是说，已有的全部排序、过滤和分组设置都不会因这个调用而发生改变，因此后续的查询很容易地复用现有设置。

AddQuery()返回RunQueries()结果返回的数组中的一个下标。它是一个从0开始的递增整数，即，第一次调用返回0，第二次返回1，以此类推。这个方便的特性使你在需要这些下标的时候不用手工记录它们。

原型： function RunQueries ()

连接到searchd，运行由AddQuery()添加的全部查询，获取并返回它们的结果集。若发生一般错误（例如网络I/O失败）则返回假并设置GetLastError()信息。若成功则返回结果集的简单数组。

该数组中的每一个结果集都跟Query()返回的结果集完全相同。

注意，批量查询请求自身几乎总是成功——除非有网络错误、正在进行索引轮换，或者其他导致整个查询无法被处理的因素。

然而其中的单个的查询很可能失败。此时与之对应的结果集只包含一个非空的"error"信息，而没有关于匹配或查询的统计信息。在极端情况下，批量查询中的所有单个查询可能都失败。但这仍然不会导致报告一般错误，因为API已经成功地连接到searchd，提交了批量查询并得到返回结果——但每个结果集都只包含特定的错误信息。

原型： function ResetFilters ()

清除当前设置的过滤器。

通常此调用在使用批量查询的时候会用到。您可能需要为批量查询中的不同查询提供不同的过滤器，为达到这个目的，您需要调用ResetFilters()然后用其他调用增加新的过滤器。

原型： function ResetGroupBy ()

清除现有的全部分组设置，并关闭分组。

通常此调用在使用批量查询的时候会用到。单独的分组设置可以用SetGroupBy()和SetGroupDistinct()来改变，但它们不能关闭分组。ResetGroupBy()将之前的分组设置彻底重置并在当前状态下关闭分组模式，因此后续的AddQuery()可以进行无分组的搜索。

原型： function BuildExcerpts ( $docs, $index, $words, $opts=array() )

该函数用来产生文档片段（摘要）。连接到searchd，要求它从指定文档中产生片段（摘要），并返回结果。

$docs为包含各文档内容的数组。$index为包含索引名字的字符串。给定索引的不同设置（例如字符集、形态学、词形等方面的设置）会被使用。$words为包含需要高亮的关键字的字符串。它们会按索引的设置被处理。例如，如果英语取词干（stemming）在索引中被设置为允许，那么即使关键词是“shoe”，“shoes”这个词也会被高亮。从版本0.9.9-rc1开始，关键字可以包含通配符，与查询支持的star-syntax类似。$opts为包含其他可选的高亮参数的hash表：

失败时返回false。成功时返回包含有片段（摘要）字符串的数组。

原型： function UpdateAttributes ( $index, $attrs, $values )

立即更新指定文档的指定属性值。成功则返回实际被更新的文档数目（0或更多），失败则返回-1。

$index 为待更新的（一个或多个）索引名。$attrs为属性名字符串的数组，其所列的属性会被更新。$attrs为hash表，$values表的键为文档ID，$values表的值为新的属性值的简单数组。

$index 既可以是一个单独的索引名，也可以是一个索引名的列表，就像Query()的参数。与Query()不同的是不允许通配符，全部待更新的索引必须明确指出。索引名列表可以包含分布式索引。对分布式索引，更新会同步到全部代理上。

只有在docinfo=extern这个存储策略下才可以运行更新。更新非常快，因为操作完全在内存中进行，但它们也可以变成持久的，更新会在searchd干净关闭时（收到SIGTERM信号时）被写入磁盘。在额外限制条件下，MVA属性也可以被更新，参见mva_updates_pool详细了解。

使用示例

$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，等等。

原型： function BuildKeywords ( $query, $index, $hits )

根据指定索引的符号化（tokenizer）方式的设置，从查询中抽取关键词，也可以同时返回每个关键词出现次数的统计信息。返回一个数组，其元素是一些字典，每个字典包含一个关键字的信息。

$query 是抽取关键字的目标。$index是某个索引的名字，系统会使用这个索引的符号化（tokenizer）设置，关键词出现次数的统计信息也从这个索引中得出。$hits是一个布尔值，它指定了是否需要返回关键词出现此处的信息。

使用示例：

$keywords = $cl->BuildKeywords ( "this.is.my query", "test1", false );

原型： function EscapeString ( $string )

查询语言分析器将某些字符理解成特殊操作符，这个函数对字符串中的那些有特殊意义的字符进行转义。返回转义后的字符串。

$string 是待转义的字符串。

表面上看这个函数是多余的，因为可以很容易地在可能调用这个函数的程序里实现这个转义功能。然而这些特殊字符的集合可能随着时间而改变，因此理应提供一个API调用来完成这个功能，并保证任何时候都可以正确地转义全部特殊字符。

使用示例：

$escaped = $cl->EscapeString ( "escaping-sample@query/string" );

原型： function Status ()

查询searchd的状态，返回一个数组，数组元素是由状态变量名和值的键值对构成。

使用示例：

$status = $cl->Status ();
foreach ( $status as $row )
	print join ( ": ", $row ) . "\n";

原型： function Open ()

打开到服务器的持久连接。

原型： function Close ()

关闭先前打开的持久连接。

如果使用我们事先做好的打过补丁的tarball，那请跳过步骤1-3。

如果使用我们事先做好的打过补丁的tarball，那请跳过步骤1-3：

为了检查SphinxSE是否成功地编入了MySQL，启动新编译出的MySQL服务器，运行mysql客户端，执行SHOW ENGINES查询，这会显示一个全部可用引擎的列表。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)

数据源类型。必须选项，无默认值。 已知的类型包括 mysql, pgsql, mssql, xmlpipe and xmlpipe2, 以及 odbc.

在CoreSeek的分发版本中，数据源类型还可以是python，从而得以启用Python数据源支持。

所有其他与数据源相关的选项都依赖于这个选项指定的源类型。与SQL数据源（即MSSQL、MySQL和PostgreSQL）相关的选项以“sql_”开头，而与xmlpipe和xmlpipe2数据源相关的选项则以“xmlpipe_”开头。 除了xmlpipe是默认支持外，其他数据源类型的支持是有前提条件的；依赖与您的设置和已安装的数据库客户端库文件，它们可能被支持或者不被支持。例如，mssql仅在Windows系统提供支持。odbc在Windows系统上是原生支持，而在Linux系统上通过UnixODBC library支持。

在CoreSeek的分发版本中，python通过Python提供支持，在安装了Pythin的Windows系统和Linux系统上都可以支持。

示例：

type = mysql

要连接的SQL服务器主机地址。必须选项，无默认值。仅对SQL数据源（mysql, pgsql, mssql）有效。

最简单的情形下，Sphinx与MySQL或PostgreSQL服务器安装在同一台主机上，此时您只须设置为localhost即可。注 意，MySQL客户端库根据主机名决定是通过TCP/IP还是UNIX socket连接到服务器。一般来说，“localhost”使之强制使用UNIX socket连接（这是默认的也是推荐的模式），而“127.0.01”会强制使用TCP/IP。细节请参考 MySQL manual。

示例：

sql_host = localhost

要连接的SQL服务器的IP端口。可选选项，默认值为mysql端口3306，pgsql端口5432。仅适用于SQL数据源（mysql, pgsql, mssql）。注意，此选项是否实际被使用依赖于sql_host选项。

示例：

sql_port = 3306

连接到sql_host时使用的SQL用户名。必须选项，无默认值。仅适用于SQL数据源（mysql, pgsql, mssql）。

示例：

sql_user = test

连接到sql_host时使用的SQL用户密码。必须选项，无默认值。 仅适用于SQL数据源（mysql, pgsql, mssql）。

示例：

sql_pass = mysecretpassword

连接到SQL数据源之后使用的SQL数据库，此后的查询均在此数据库上进行。必须选项，无默认值。 仅适用于SQL数据源（mysql, pgsql, mssql）。

示例：

sql_db = test

连接到本地SQL服务器时使用的UNIX socket名称。可选选项，默认值为空（使用客户端库的默认设置）。 仅适用于SQL数据源（mysql, pgsql, mssql）。

在Linux上，通常是/var/lib/mysql/mysql.sock。 而在FreeBSD上通常是/tmp/mysql.sock。注意此选项是否实际被使用依赖与sql_host的设置。

示例：

sql_sock = /tmp/mysql.sock

MySQL客户端的连接标志（connection flags）。可选选项，默认值为0（不设置任何标志）。仅适用于mysql数据源。

此选项必须包含各标志相加所得的整型值。此整数将被原样传递给mysql_real_connect() 。 可用的标志在mysql_com.h中列举。下面列举的是几个与索引相关的标志和它们的值：

例如，标志2080（2048+32）代表同时使用压缩和SSL，32768代表仅使用新的身份验证。起初这个选项是为了在indexer和mysql位 于不同主机的情况下使用压缩协议而引入的。尽管降低了网络带宽消耗，但不管在理论上还是在现实中，在1Gbps的链路上启用压缩很可能恶化索引时间。然而 在100Mbps的连输上启用压缩可能会明显地改善索引时间（有报告说总的索引时间降低了20-30%）。根据您网络的连接情况，您获得的改善程度可能会 有所不同。

示例：

mysql_connect_flags = 32 # enable compression

连接MySQL服务器时使用的SSL认证选项。可选参数，默认值是空串（即不使用SSL认证）。 Applies to mysql source type only.

这些指令用来在indexer和MySQL之间建立安全的SSL连接。关于怎样建立认证机制和设置MySQL服务器的信息可以参考MySQL文档。仅适用于mysql数据源。

示例：

mysql_ssl_cert = /etc/ssl/client-cert.pem
mysql_ssl_key = /etc/ssl/client-key.pem
mysql_ssl_ca = /etc/ssl/cacert.pem

要连接的ODBC DSN。必须选项，没有默认值。 仅适用于odbc数据源。

ODBC DSN（数据源名字，Data Source Name）指定了连接ODBC数据源时使用的认证选项（主机地址，用户名，密码等）。具体的格式与ODBC的具体驱动有关。

示例：

odbc_dsn = Driver={Oracle ODBC Driver};Dbq=myDBName;Uid=myUsername;Pwd=myPassword

取前查询（pre-fetch query），或预查询（pre-query）。多值选项，可选选项，默认为一个空的查询列表。 仅适用于SQL数据源（mysql, pgsql, mssql）。

多值意思是您可以指定多个预查询。它们在the main fetch query之前执行，而且会严格按照在配置文件中出现的顺序执行。预查询的结果会被忽略。

预查询在很多时候有用。它们被用来设置字符编码，标记待索引的记录，更新内部计数器，设置SQL服务器连接选项和变量等等。

也许预查询最常用的一个应用就是用来指定服务器返回行时使用的字符编码。这必须与Sphinx期待的编码相同（在charset_type 和charset_table 选项中设置）。以下是两个与MySQL有关的设置示例：

sql_query_pre = SET CHARACTER_SET_RESULTS=cp1251
sql_query_pre = SET NAMES utf8

对于MySQL数据源，在预查询中禁用查询缓冲（query cache）（仅对indexer连接）是有用的，因为索引查询一般并会频繁地重新运行，缓冲它们的结果是没有意义的。这可以按如下方法实现：

sql_query_pre = SET SESSION query_cache_type=OFF

示例：

sql_query_pre = SET NAMES utf8
sql_query_pre = SET SESSION query_cache_type=OFF

获取文档的主查询。必须的选项，无默认选项。 仅适用于SQL数据源（mysql, pgsql, mssql）。

只能有一个主查询。它被用来从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 documents

分区查询设置。可选选项，默认为空。 仅适用于SQL数据源（mysql, pgsql, mssql）。

设置这个选项会启用文档的区段查询（参看Section 3.7, “区段查询”）。分区段查询有助于避免在索引大量数据时发生MyISAM表臭名昭著的死锁问题。（同样有助于解决其他不那么声名狼藉的问题，比如大数据集上的性能下降问题，或者InnoDB对多个大型读事务（read transactions）进行序列化时消耗额外资源的问题。）

此选项指定的查询语句必须获取用于分区的最小和最大文档ID。它必须返回正好两个整数字段，先是最小ID然后是最大ID，字段的名字会被忽略。

当启用了分区段查询时，sql_query要求包括$start 和 $end宏（因为重复多次索引整个表显然是个错误）。注意，$start .. $end所指定的区间不会重叠，因此不会在查询中删除ID正好等于$start 或$end的文档。Section 3.7, “区段查询”中的例子解释了这个问题，注意大于等于或小于等于比较操作是如何被使用的。

示例：

sql_query_range = SELECT MIN(id),MAX(id) FROM documents

区段查询的步进。可选选项，默认为1024。 仅适用于SQL数据源（mysql, pgsql, mssql）。

仅当启用ranged queries 时有效。用sql_query_range 取得的文档ID区间会被以这个不小的间隔步数跳跃遍历。例如，如果取得的最小和最大ID分别是12和3456，而间隔步数是1000，那么indexer会用下面这些值重复调用几次sql_query：

示例：

sql_range_step = 1000

用于得到Kill-list的查询。可选选项，默认为空（不设定查询）。 仅适用于SQL数据源（mysql, pgsql, mssql）。 Introduced in version 0.9.9-rc1.

这个查询返回的结果集应该只有一列，每行是一个文档ID。返回的这些文档ID将被存储在一个索引里。根据查询中提到的索引的顺序，一个索引的kill-list会抑制来自其他索引的结果。这个设计的目的是要帮助用户实现在现有索引上的删除或者更新，而不用重建索引（甚至根本不用访问这个索引），尤其是为了结果解决“幽灵结果”问题。

让我们来分析一个实际的例子。假设我们有两个索引，‘main’和‘delta’。假设文档2、3和5在上一次重建索引‘main’的时候就被删除 了，而文档7和文档11则被更新了（即他们的文字内容发生了变化）。假设在建立索引‘main’的时候，关键字‘test’在所有这些提到的文档中都出现 了。而当我们建立索引‘delta’的时候文档7中也出现了关键字‘test’，但是文档11中不再有关键字‘test’了。现在我们重新建立索引 ‘delta’，然后以合适的顺序（较旧的排在较新的之前）对这两个索引进行检索：

$res = $cl->Query ( "test", "main delta" );

首先，我们要正确地处理删除的情况。结果集合不应该包含文档2、3或5。其次，我们也要避免出现幽灵结果。如果我们不做点什么，文档11就会出现在搜索结果中。因为它会被在‘main’中查到（但在‘delta’中查不到它），并出现在最终的结果集合中，除非我们做点什么防止这种情况的发生。

Kill-list，或者缩写成K-list就是我们要做的。附加在‘delta’索引上的Kill-list会屏蔽掉前面所有各索引中检索到的特定行，在这个例子中，也就是‘main’中的行。因此，想要得到预期的结果，我们应该将更新了的和删除了的文档ID都放进Kill-list。

示例：

sql_query_killlist = \
	SELECT id FROM documents WHERE updated_ts>=@last_reindex UNION \
	SELECT id FROM documents_deleted WHERE deleted_ts>=@last_reindex

声明无符号整数属性(attribute)。可声明同一类型的多个不同名称的属性，可选项。 仅适用于SQL数据源（mysql, pgsql, mssql）。

被声明的列的值必须在32位无符号整型可表示的范围内。超出此范围的值也会被接受，但会溢出。例如-1会变成 2^32-1 或者说4,294,967,295。

您可以在属性名后面附加“:BITCOUNT”（见下面的示例）以便指定整型属性的位数。属性小于默认32位（此时称为位域）会有损性能。但它们在外部存储（extern storage）模式下可以节约内存：这些位域被组合成32位的块存储在.spa属性数据文件中。如果使用内联存储（inline storage），则位宽度的设置会被忽略。

示例：

sql_attr_uint = group_id
sql_attr_uint = forum_id:9 # 9 bits for forum_id

声明布尔属性（attribute）。可声明同一类型的多个不同名称的属性，可选项。仅适用于SQL数据源（mysql和pgsql）。 仅适用于SQL数据源（mysql, pgsql, mssql）。 等价于用sql_attr_uint声明为1位。

示例：

sql_attr_bool = is_deleted # will be packed to 1 bit

64位整数属性（attribute）声明。多个值（可以同时声明多个属性），可选选项。 仅适用于SQL数据源（mysql, pgsql, mssql）。 注意，与sql_attr_uint不同，这些值是有符号的。于版本0.9.9-rc1引入。

示例：

sql_attr_bigint = my_bigint_id

声明UNIX时间戳属性（attribute）。可声明同一类型的多个不同名称的属性，可选项。 仅适用于SQL数据源（mysql, pgsql, mssql）。

这个列的值必须是UNIX格式的时间戳，即32位无符号整数表示的自格林尼治平时1970年1月1日午夜起过去的秒数。时间戳在内部是按整数值存储 和处理的。但除了将时间戳按整数使用，还可以对它们使用多种与日期相关的函数——比如时间段排序模式，或为分组（GROUP BY）抽取天/星期/月/年。注意MySQL中的DATE和DATETIME列类型不能直接作为时间戳使用，必须使用UNIX_TIMESTAMP函数将这些列做显式转换。

示例：

sql_attr_timestamp = UNIX_TIMESTAMP(added_datetime) AS added_ts

声明字符串序数属性（attribute ）。可声明同一类型的多个不同名称的属性，可选项。 仅适用于SQL数据源（mysql, pgsql, mssql）。

这个属性类型（简称为字串序数）的设计是为了允许按字符串值排序，但不存储字符串本身。对字串序数做索引时，字符串值从数据库中取出、暂存、排序然后用它们在该有序数组中的序数代替它们自身，因此字串序数是个整型，对它们的大小比较与在原字串上做字典序比较结果相同。

早期版本上，对字串序数做索引可能消耗大量的RAM。自r1112起，字串序数的积累和排序也可在固定大小的内存中解决了（代价是额外的临时磁盘空间），并受 mem_limit 设置限制。

理想中字符串可以根据字符编码和本地字符集（locale）排序。例如，如果已知字符串为KOI8R编码下的俄语字串，那么对字节 0xE0,0xE1和0xE2排序结果应为0xE1,0xE2和0xE0，因为0xE0在KOI8R中代表的字符明显应在0xE1和0xE2之后。但很不 幸，Sphinx目前不支持这个功能，而是简单地按字节值大小排序。

请注意，这里的序号是每个索引根据自身数据计算的，因此在同时读取多个索引事实无法同时保留正确的顺序进行合并的。处理后的字符串被替换为处理时其 在索引中的序列号，但是不同的索引具有不同的字符串集。例如，如果'main'索引包含字符串"aaa", "bbb", "ccc", 直到 "zzz"，它们将会被分别分配数值为1,2,3,直到26。但是'delta'如果仅包含"zzz"，则会被分配数值1。那么在合并后，该顺序将被打 乱。不幸的是，在不存储原始字符串的情况下，这个问题无法解决（一旦存储原始字符串，序号将没有任何用处了）。

示例：

sql_attr_str2ordinal = author_name

声明浮点型属性 attribute 。 可声明同一类型的多个不同名称的属性，可选项。 仅适用于SQL数据源（mysql, pgsql, mssql）。

属性值按单精度32位IEEE754格式存储。可表示的范围大约是1e-38到1e+38。可精确表示的小数大约是7位。浮点属性的一个重要应用是存储经度和纬度值（以角度为单位），经纬度值在查询时的地表距离计算中有用。

示例：

sql_attr_float = lat_radians
sql_attr_float = long_radians

声明多值属性（Multi-valued attribute ，MVA)）. 可声明同一类型的多个不同名称的属性，可选项。 仅适用于SQL数据源（mysql, pgsql, mssql）。

简单属性每篇文档只允许一个值。然而有很多情况（比如tags或者类别）需要将多个值附加给同一个属性，而且要对这个属性值列表做过滤或者分组。

声明格式如下（用反斜线只是为了清晰，您仍可以在一行之内完成声明）：

sql_attr_multi = ATTR-TYPE ATTR-NAME 'from' SOURCE-TYPE \
	[;QUERY] \
	[;RANGE-QUERY]

其中

示例：

sql_attr_multi = uint tag from query; SELECT id, tag FROM tags
sql_attr_multi = uint tag from ranged-query; \
	SELECT id, tag FROM tags WHERE id>=$start AND id<=$end; \
	SELECT MIN(id), MAX(id) FROM tags

后取查询。可选项，默认值为空。 仅适用于SQL数据源（mysql, pgsql, mssql）。

此查询在sql_query成功执行后立即执行。如果取后取查询产生了错误，该错误被当作警告被报告，但索引不会因此终止。取后查询的结果会被忽略。注意当取后查询执行时索引还尚未完成，而后面的索引仍然可能失败。因此在这个查询中不应进行任何永久性的更新。例如，不应在此查询中更新辅助表中存储的最近成功索引的文档ID值，请在后索引查询（post-index query ）中操作。

示例：

sql_query_post = DROP TABLE my_tmp_table

后索引查询。可选项，默认值为空。 仅适用于SQL数据源（mysql, pgsql, mssql）。

此查询在索引完全成功结束后执行。如果此查询产生错误，该错误会被当作警告报告，但索引不会因此而终止。该查询的结果集被忽略。此查询中可以使用宏$maxid，它会被扩展为索引过程中实际得到的最大的文档ID。

示例：

sql_query_post_index = REPLACE INTO counters ( id, val ) \
    VALUES ( 'max_indexed_id', $maxid )

分区查询的间隔时间（throttling），单位是毫秒。可选选项，默认值为0（无间隔时间）。 仅适用于SQL数据源（mysql, pgsql, mssql）。

此选项旨在避免indexer对数据库服务器构成了太大的负担。它会使indexer在每个分区查询的步之后休眠若干毫秒。休眠无条件执行，并在取结果的查询之前执行。

示例：

sql_ranged_throttle = 1000 # sleep for 1 sec before each query step

文档信息查询。 可选选项，默认为空。 仅对 mysql 数据源有效。

仅被命令行搜索所用，用来获取和显示文档信息，目前仅对MySQL有效，且仅用于调试目的。此查询为每个文档ID获取CLI搜索工具要显示的文档信息。 它需要包含$id宏，以此来对应到查询的文档的ID。

示例：

sql_query_info = SELECT * FROM documents WHERE id=$id

调用xmlpipe流提供者的Shell命令。必须选项。仅对xmlpipe 和 xmlpipe2数据源有效。

指定的命令会被运行，其输出被当作XML文档解析。具体格式描述请参考 Section 3.8, “xmlpipe 数据源” or Section 3.9, “xmlpipe2 数据源” 。

示例：

xmlpipe_command = cat /home/sphinx/test.xml

声明xmlpipe数据字段。可声明同一类型的多个不同名称的属性，可选项。仅对xmlpipe2数据源有效。参考 Section 3.9, “xmlpipe2 数据源”.

示例：

xmlpipe_field = subject
xmlpipe_field = content

声明xmlpipe整型属性。可声明同一类型的多个不同名称的属性，可选项。仅对xmlpipe2数据源有效。语法与 sql_attr_uint相同。

示例：

xmlpipe_attr_uint = author

声明xmlpipe布尔型属性。可声明同一类型的多个不同名称的属性，可选项。 仅对xmlpipe2数据源有效。语法与 sql_attr_bool相同。

示例：

xmlpipe_attr_bool = is_deleted # will be packed to 1 bit

声明xmlpipe UNIX时间戳属性。可声明同一类型的多个不同名称的属性，可选项。 仅对xmlpipe2数据源有效。语法与 sql_attr_timestamp相同。

示例：

xmlpipe_attr_timestamp = published

声明xmlpipe字符序数属性。可声明同一类型的多个不同名称的属性，可选项。 仅对xmlpipe2数据源有效。语法与 sql_attr_str2ordinal相同。

示例：

xmlpipe_attr_str2ordinal = author_sort

声明xmlpipe浮点型属性。可声明同一类型的多个不同名称的属性，可选项。 仅对xmlpipe2数据源有效。语法与 sql_attr_float相同。

示例：

xmlpipe_attr_float = lat_radians
xmlpipe_attr_float = long_radians

声明xmlpipe MVA属性。可声明同一类型的多个不同名称的属性，可选项。 仅对xmlpipe2数据源有效。

这个选项为xmlpipe2流声明一个MVA属性标签。该标签的内容会被试图解析成一个整型值的列表（数组），此列表构成一个MVA属性值，这与把MVA属性的数据源设置为“字段”时sql_attr_multi分析SQL列内容的方式类似。

示例：

xmlpipe_attr_multi = taglist

在Sphinx端进行UTF-8验证和过滤，防止XML分析器因为碰上非UTF-8文档而犯疯卡死。可选选项，默认值为0。只适用于xmlpipe2数据源。 仅对xmlpipe2数据源有效。

在某些特定情况下很难甚至不可能保障输入的xmlpipe2文档体都是完美有效一致的UTF-8编码。例如，输入流中可能溜进一些特定国家的单字节 编码文本。Libexpat这个XML分析器非常脆弱，遇到这种情况就会停止工作。UTF-8修复（UTF-8 fixup）功能能让这种情况得到避免。当启动了修复选项的时候，Sphinx会对输入留进行预处理，其后再传给XML分析器，其间非法的UTF-8序列 全部被替换成空格。

示例：

xmlpipe_fixup_utf8 = 1

标志位，代表是否使用MS SQL的windows身份认证。布尔型，可选选项，默认值是0（假）。只适用于mssql数据源。于版本0.9.9-rc1引入。

这个选项指出在连接到MS SQL Server时时候使用现在正登录的windows账户的凭据作来进行身份验证。注意当searchd作为服务运行时，账户的用户名可能与安装这个服务的账户不同。

示例：

mssql_winauth = 1

MS SQL编码类型标志位。布尔型，可选选项，默认值是0（假）。只适用于mssql数据源。于版本0.9.9-rc1引入。

这个选项指出在对MS SQL Server进行查询时，是使用Unicode还是单字节数据。这个标志位必须与charset_type指令同步，也就是说，要索引Unicode数据，则既要设置charset_type选项（设为‘utf-8’），又要设置数据源的mssql_unicode选项（设为1）。多说一句：MS SQL实质上返回UCS-2编码的数据，而不是UTF-8，但Sphinx可以自动处理这个情况。

示例：

mssql_unicode = 1

使用zlib（即gnuzip）来解压（unpack，deflate）的列。多个值，可选选项，默认值是列的空列表。仅适用于SQL数据源（mysql, pgsql, mssql）。于版本0.9.9-rc1引入。

indexer会使用标准zlib算法（称作deflate，gunzip也实现了这个算法）对这个选项指定的那些列进行解压缩。当建立索引的动作发生在数据库所在机器以外的机器时，这个选项会降低数据库的负载，并节约网络带宽。要想使用这个特性，就必须保证在建立时zlib和zlib-devel都是可用的。

示例：

unpack_zlib = col1
unpack_zlib = col2

使用MySQL UNCOMPRESS()算法解压的列。多个值，可选选项，默认值是列的空列表。仅适用于SQL数据源（mysql, pgsql, mssql）。于版本0.9.9-rc1引入。

indexer会使用MySQL COMPRESS()和UNCOMPRESS()使用的修改过的zlib算法对这个选项指定的那些列进行解压缩。 当建立索引的动作发生在数据库所在机器以外的机器时，这个选项会降低数据库的负载，并节约网络带宽。要想使用这个特性，就必须保证在建立时zlib和 zlib-devel都是可用的。

示例：

unpack_mysqlcompress = body_compressed
unpack_mysqlcompress = description_compressed

用于UNCOMPRESS()解压后数据的缓冲区大小。可选选项，默认值是16M。于版本0.9.9-rc1引入。

当使用unpack_mysqlcompress选项时，由于实现方法本质上的限制，不可能减小缓冲区大小方面的需求。因此缓冲区必须预先分配好，解压出的数据也不能超过缓冲区大小。这个选项控制这个缓冲区大小值，既可以用于限制indexer的内存使用，也可以用于在需要的时候使解压非常大的数据变为可能

示例：

unpack_mysqlcompress_maxsize = 1M

索引类型。可选选项，默认值为空（索引为简单本地索引）。可用的值包括空字符串或“distributed”

Sphinx支持两种不同的索引类型：本地——在本机上存储和处理，和远程——不仅涉及本地搜索，而且同时通过网络向远程searchd实例做查询。索引类似选项使您可以选择使用何种索引。索引默认是本地型。指定“distributed”索引类型会运行分布式搜索，参看 Section 4.7, “分布式搜索”.

示例：

type = distributed

向本地索引增加文档源。可以出现多次，必须选项。

为当前索引指定一个从中可以获取文档的文档源。必须至少有一个文档源。可以有多个文档源，任何数据源类型都可接受：即您可以从MySQL服务器中获取一部分数据，从PostgreSQL中获取另一部分，再在文件系统上使用xmlpipe2获取一部分。

然而，对源数据却有一些限制。首先，文档ID必须在所有源的总体上是唯一的。如果这个条件不满足，那可能导致非预期的搜索结果。其次，源的模式必须相同，以便在同一个索引中存储。

数据来源的ID不会被自动存储。因此，为了获知匹配的文档是从哪个数据源中来的，需要手工存储一些额外的信息。通常有两种方法：

示例：

source = srcpart1
source = srcpart2
source = srcpart3

索引文件的路径和文件名（不包括扩展名）。必须选项。

path既包括文件夹也包括文件名，但不包括扩展名。indexer在产生永久和临时索引文件的最终名字时会附加上不同的扩展名。永久数据文件有几个不同的扩展名，都以“.sp”开头，临时文件的扩展名以“.tmp”开头。如果indexer没有成功地自动删除.tmp*文件，手工删除是安全的。

以下是不同索引文件所存储的数据种类，供参考：

示例：

path = /var/data/test1

文档信息(docinfo)的存储模式。可选选项，默认是“extern”已知的值包括'none', 'extern' 和 'inline'.。

此选项确切定义了文档信息在磁盘和RAM中的物理存储方式。“none”意思是根本不存储文档信息（没有任何属性）。通常并不需要显式设置为 “none”因为当没有配置任何属性时Sphinx会自动选择“none”。“inline”代表文档信息与文档ID列表一同存储在在.spd文件中。“extern”代表文档信息与文档ID分开（在外部）存储（在.spa文件中）。

基本上，外部存储的文档信息在查询时必须保持在内存中。这是性能的原因。因此有时候“inline”是唯一的选择。然而这种情况并不多见，文档信息默认是“extern”存储的。深入的探讨和RAM使用的估计请参见Section 3.2, “属性”。

示例：

docinfo = inline

已缓冲数据的内存锁定。可选选项，默认为0（不调用mlock()）

为提高性能，searchd将.spa和.spi文件预取到内存中，并一直在内存中保存它们的拷贝。但如果一段时间内没有对该索引的搜索，则对这份缓冲的拷贝没有内存访问，而操作系统可能会决定将它交换到磁盘上去。对这些“冷却”了的索引的访问会导致其交换回内存并得到一个较大的延迟。

将mlock选项设置为1会使Sphinx使用mlock(2)系统调用将存储上述缓冲了的数据的系统内存锁定，这将避免内存交换（详情参见man 2 mlock）。mlock(2)是特权调用，因此可能需要searchd以root账户运行或通过其他办法赋予足够的权限。如果mlock()失败会发出警告，但索引会继续进行。

示例：

mlock = 1

词形处理器的列表。可选选项，默认为空（不使用任何词形处理器）。

词形处理器可以将待索引的词从各种形态变成基本的规则的形态。例如，英语词干提取器（English stemmer）可以将“dogs”和“dog”都变成“dog”，这使搜索这两个词的结果都相同。

内置的词形处理器包括英语词干提取器，俄语词干提取器（支持UTF-8和Windows-1251编码），Soundex和Metaphone。后面两个会将词替换成特殊的语音编码，这会使发音相近的词表示形式相同。Snowball 项目的libstemmer 库提供的额外词干提取器可以通过在编译期对configure 脚本使用--with-libstemmer选项来启用。内建的英语和俄语词干提取器要比它们在libstemmer中的对应物模块运行更快，但它们的结果可能略有不同，因为内建的版本基于较旧的版本。Metaphone基于Double Metaphone算法实现。

在morphology选项中可使用的内建值包括 “none”，“stem_en”，“stem_ru”，“stem_enru”, “soundex”和“metaphone”。libstemmer提供的额外值格式为“libstemmer_XXX”，XXX指libstemmer 算法的代号。（完整列表参见libstemmer_c/libstemmer/modules.txt）

可以指定多个词干提取器（以逗号分隔）。这些提取器按列出的顺序应用于输入词串，整个处理会在第一个真正修改了原词的词干提取器之后停止。另外，当wordforms 特性启用时，词会现在词形字典中查询，如果词典中有对应的条目，那么词干提取器干脆不会被使用。换个说法，wordforms选项可以用来补充指定词干提取器的例外情况。

示例：

morphology = stem_en, libstemmer_sv

启用词干化的最小词长。可选选项，默认为1（对任何词都进行词干化）。于版本0.9.9-rc1引入。

词干化方法并不完美，有时会产生用户不想要的结果。例如，如果用英语的Porter stemmer词干化算法处理关键词“gps”，得到的结果是“gp”，显然这是不对的。min_stemming_len这个特性允许根据词的长度来决定是否跳过词干化，即不对较短的词进行词干化。注意，词长等于这个选项设置的值的词会被词干化。因此要避免对3个字符长的关键词进行词干化，必须指定这个选项的值为4。要活的更细粒度的控制，请参考wordforms这个特性。

示例：

min_stemming_len = 4

停用词文件列表（空格分隔）。可选选项，默认为空。

停用词是不被索引的词。停用词表一般包括最常用的高频词，因为它们对搜索结果没有多大帮助却消耗很多处理资源。

可以指定多个文件名，用空格分隔。所有文件都会被载入。停用词文件的格式是简单的纯文本。其编码必须与charset_type选项所指定的索引编码相匹配。文件数据会根据charset_type选项的设置进行切分，因此您可以使用与待索引数据相同的分隔符。词干提取器（stemmers）也会在停用词文件的分析中使用。

尽管停用词不会被索引，它们却影响关键词的位置。例如，假设“the”是一个停用词，文档1包含一行“in office”，而文档2包含“in the office”。将“in office”作为确切词组搜索则只会得到文档1，虽然文档2里的the是停用的。

示例：

stopwords = /usr/local/sphinx/data/stopwords.txt
stopwords = stopwords-ru.txt stopwords-en.txt

词形字典。 可选选项，默认为空。

词形字典在输入文档根据charset_table切 碎后使用。本质上，它使您可以将一个词替换成另一个。这通常被用来将不同的词形变成一个单一的标准形式（即将词的各种形态如 “walks”，“walked”，“walking”变为标准形式“walk”）。也可以用来实现取词根的例外情况，因为词形字典中可以找到的词不会经 过词干提取器的处理。

索引和搜索中的输入词都会利用词典做规则化。因此要使词形字典的更改起作用，需要重新索引并重启searchd。

Sphnix的词形支持被设计成可以很好地支持很大的字典。它们轻微地影响索引速度：例如，1M个条目的字典会使索引速度下降1.5倍。搜索速度则 完全不受影响。额外的内存占用大体上等于字典文件的大小，而且字典是被多个索引共享的，即如果一个50MB的词形字典文件被10个不同的索引使用了，那么 额外的searchd内存占用就是大约50MB。

字典文件的格式是简单的纯文本。每行包括一个源词形和一个目标词形，编码应与charset_type选项所指定的完全相同，二者用大于号分隔。文件载入时会经过charset_table选项指定的规则的处理。因此基本上在大小写是否敏感这个问题上它是与待索引的全文数据相同的，即通常是大小写无关的。一下是个文件内容的例子：

walks > walk
walked > walk
walking > walk

我们提供了一个spelldump工具，它可以帮您从ispell 和 MySpell（OpenOffice提供）格式的.dict和.aff字典文件生成Sphinix可接受的格式。

从版本0.9.9-rc1开始，可以将好几个源词对应到同一个目标词上。由于这个过程作用于符号化之后的结果而不是原始文本，空白字符和标记语言都被忽略。

core 2 duo > c2d
e6600 > c2d
core 2duo > c2d

示例：

wordforms = /usr/local/sphinx/data/wordforms.txt

Token特例文件。 可选选项，默认为空。

对于使用Coreseek的中文用户，这一选项无效。Coreseek为Sphinx贡献的中文分词法内置了Token特例化支持，具体参阅Coreseek MMSeg分词法的文档。不过，值得高兴的是，Token特例化的文件格式两者是同样的。

此选项允许将一个或多个Token（Token中，可以包括在正常情况下会被过滤的字符）映射成一个单独的关键词。exceptions选项与wordforms选项很类似，它们都代表某种映射，但有一些重要的不同点。

这些不同点简要总结如下：

输入文件的格式仍然是纯文本，每行一个分词例外，而行的格式如下：

map-from-tokens => map-to-token

示例文件

AT & T => AT&T
AT&T => AT&T
Standarten   Fuehrer => standartenfuhrer
Standarten Fuhrer => standartenfuhrer
MS Windows => ms windows
Microsoft Windows => ms windows
C++ => cplusplus
c++ => cplusplus
C plus plus => cplusplus

这里全部的记号都是大小写敏感的：它们不会按charset_table选项的规则处理。因此，在上述例外文件下，“At&t”会被分成两个关键字“at”和“t”，因为其中的小写字母。而“AT&T”却被精确匹配并产生一个单独的关键字“AT&T”。

需要注意的是，前述映射文件的目标关键词（右侧）a)总是被解释成一个单独的词，而且b)不仅是大小写敏感的，而且是空白符号敏感的！在上述样例中，查询“ms windows”不会匹配包含“MS Windows”的文档。这个查询会被解释成两个词“ms”和“Windows”。而“MS Windows”映射到的是一个单独的 关键字“ms windows”，包括中间的空格。另一方面“standartenfuhrer”会取回带有“Standarten Fuhrer”或者“Standarten Fuehrer”内容的文档（大写字母必须与此处列出的完全相同），或者关键词本身大小写随意的任何版本，例如“staNdarTenfUhreR”。 （然而“standarten fuhrer”不会匹配。这段文本无法与列出的任何一个例外相匹配，因为大小写不同。因此被索引为两个分开的关键字）

映射源部分的空白符（white space）不会被忽略，但空白符的数量无所谓。任何数量的空白符都匹配已索引的文档或者查询中的任意数量的空白符。例如映射源部分（“=>”左 端）的“AT�&�T”可以匹配“AT��&�T”，不管被映射部分或已索引全文数据中实际有几个空格。根据上述例子中的第一条，上述文 本会作为“AT&T”关键字被索引。 对于使用Coreseek的中文用户，这个特性目前尚不被支持。Coreseek将在后续版本支持这个特性。

exceptions选项也允许特殊字符（这是通用charset_table选项规则的例外（exception），此选项因而得名）。假设您一般不想把“+”当作有效的字符，但仍想搜索一些例外情况，比如“C++”。上述例子正好可以做到这点，完全不管哪些字符在表中，哪些字符不在。

Exceptions选项被应用于原始输入文档和索引、搜索时的查询数据。因此要使文件的改动生效，需要重建索引并重启searchd。

示例：

exceptions = /usr/local/sphinx/data/exceptions.txt

最小索引词长度。可选选项，默认为1（索引任何词）

只有长度不小于这个最小索引词长度的词会被索引。例如，如果min_word_len为4，那么“the”这个词不会被索引，但“they”会。

示例：

min_word_len = 4

字符集编码类型。可选选项，默认为“sbcs”。已知的值包括“sbcs”和“utf-8”。 对于使用Coreseek的中文用户，可选的值还可以有“zh_cn.utf-8 ”、“zh_cn.gbk”和“zh_cn.big5”。当设置charset_type值为上面的值时，系统默认您开启了中文分词特性。

不同的编码将它们的内部字符代码映射到特殊字节序列的方法不同。目前两个最常见的方法是单字节编码和UTF-8。它们对应的 charset_type值分别是“sbcs”（代表Single Byte Character Set单字节字符集）和“utf-8”。选定的编码类型会在搜索被使用的任何情况下使用：索引数据时，对索引查询时，产生摘要时，等等。

注意，尽管“utf-8”暗示解码出来的值应按unicode码点数值对待，“sbcs”却对应一系列不同的编码，它们对不同字节值的处理不同，这要在charset_table设置中正确地反应出来。例如，同一个值244（十六进制0xE0）根据使用的是koi-8r还是windows-1251编码而映射到不同的俄语字符。

示例：

charset_type = utf-8

接受的字符表和大小写转换规则。可选选项，默认值与charset_type 选项的值有关。 对于使用Coreseek的中文用户，Coreseek 提供的MMseg分词法内置了可接受的字符表，并且用户不可修改。当启用分词功能时，自动开启。

charset_table频繁应用于Sphinx的分词过程，即从文档文本或查询文本中抽取关键字的过程。它控制哪些字符被当作有效字符接受，哪些相反，还有接受了的字符如何转换（例如大小写信息保留还是去除）。

可以把charset_table想成一个对超过100K个Unicode字符中每一个的映射关系的大表（或者一个256个字符的小表，如果你使用 SBCS）。默认每个字符都对应0，这表示它不在关键字中出现，应被视为分隔符。一旦在此表中被提及，字符就映射到另一个字符（通常是它自身或者自身的小 写版本），同时被当作一个可以出现在关键字中的有效字符。

值的格式是逗号分隔的映射列表。两种最简单的映射分别是声明一个字符为有效和将一个简单字符映射为另一个字符。但用这种格式指定整个表会导致其体积臃肿、无法管理。因此提供了一些语法上的快捷方式，用它们可以一次指定一定范围的字符。详细的列表如下：

编码为0到31之间的控制字符总是被视作分隔符。编码32到127的字符即7位ASCII字符可以原样使用在映射中。为避免配置文件的编码问题，8 位ASCII字符和Unicode字符必须以U+xxx形式指定，“xxx”是码点对应的十六进制数。也可以用这个形式编码7位ASCII编码中的特殊字 符，例如用U+20来编码空格符，U+2E来编码句点，U+2C来编码逗号。

示例：

# 'sbcs' defaults for English and Russian
charset_table = 0..9, A..Z->a..z, _, a..z, \
	U+A8->U+B8, U+B8, U+C0..U+DF->U+E0..U+FF, U+E0..U+FF

# 'utf-8' defaults for English and Russian
charset_table = 0..9, A..Z->a..z, _, a..z, \
	U+410..U+42F->U+430..U+44F, U+430..U+44F

忽略字符表。 可选选项，默认为空。

有些字符，如软断字符(U+00AD)，不是仅仅要当作分隔符，而且应该被完全忽略。例如，如果“-”只是不在charset_table里，那么 “abc-def”会被当作两个关键字“abc”和“def”来索引。相反，如果将“-”加到ignore_char列表中，那么相同的文本会被当作一个 单独的关键字“abcdef”索引。

此选项的语法与 charset_table相同，但只允许声明字符，不允许映射它们。另外，忽略的字符不能出现在charset_table里。

示例：

ignore_chars = U+AD

索引的最小前缀长度。可选选项，默认为0（不索引前缀）。

前缀索引使实现“wordstart*”形式的通配符成为可能（通配符语法的细节请参考 enable_star 选项）。当最小前缀长度被设置为正值，indexer除了关键字本身还会索引所有可能的前缀（即词的开头部分）。太短的前缀（小于允许的最小值）不会被索引。

例如，在min_prefix_len=3设置下索引关键字“example”会导致产生5个索引项“exa”, “exam”, “examp”, “exampl”和该词本身。对这个索引搜索“exam”会得到包含“example”的文档，即使该文档中没有“exam”自身。然而，前缀索引会使索 引体积急剧增大（因为待索引关键字增多了很多），而且索引和搜索的时间皆会恶化。

在前缀索引中没有自动的办法可以提高精确匹配（整个词完全匹配）的评分，但有一些技巧可以实现这个功能。首先，可以建立两个索引，一个带有前缀索引，另一个没有，同时在这两个索引中搜索，然后用 SetIndexWeights() 来设置二者的权重。其次，可以启用星号语法并重写扩展模式的查询：

# in sphinx.conf
enable_star = 1

// in query
$cl->Query ( "( keyword | keyword* ) other keywords" );

示例：

min_prefix_len = 3

索引的最小中缀长度。可选选项，默认为0（不索引中缀）。

中缀索引是实现“start*”, “*end”, and “*middle*”等形式的通配符成为可能（通配符语法的细节请参考 enable_star 选项）。当最小中缀长度设置为正值，indexer除了对关键字本身还会对所有可能的中缀（即子字符串）做索引。太短的中缀（短于允许的最小长度）不会被索引。

例如，在min_infix_len=2设置下索引关键字“test”会导致产生6个索引项 "te", "es", "st", "tes", "est"等中缀和词本身。对此索引搜索“es”会得到包含“test”的文档，即使它并不包含“es”本身。然而，中缀索引会使索引体积急剧增大（因为 待索引关键字增多了很多），而且索引和搜索的时间皆会恶化。

在中缀索引中没有自动的办法可以提高精确匹配（整个词完全匹配）的评分，但可以使用与 prefix indexes 选项中相同的技巧。

示例：

min_infix_len = 3

做前缀索引的字段列表。可选选项，默认为空（所有字段均为前缀索引模式）。

因为前缀索引对索引和搜索性能均有影响，可能需要将它限制在某些特定的全文数据字段：例如，对URL提供前缀索引，但对页面内容不提供。prefix_fields指定哪些字段要提供前缀索引，其他字段均会使用普通模式。值的格式是逗号分隔的字段名字列表。

示例：

prefix_fields = url, domain

做中缀索引的字段列表。可选选项，默认为空（所有字段均为中缀索引模式）。

与 prefix_fields选项类似，但限制的是哪些字段做中缀索引。

示例：

infix_fields = url, domain

允许前缀/中缀索引上的星号语法（或称通配符）。可选选项，默认为0（不使用通配符），这是为了与0.9.7版本的兼容性。已知的值为0和1。

此特性启用搜索前缀或中缀索引时的“星号语法”，或者说通配符语法。仅影响搜索，因此要使改变生效只须重启 searchd，而不需要重新索引。

默认值为0，意思是禁止星号语法，所有关键字都根据索引时的 min_prefix_len 和 min_infix_len settings设置被视为前缀或者中缀。取值1的意思是星号（“*”）可以用在关键字的前面或后面。星号与零个或多个字符匹配。

例如，假设某索引启用了中缀索引，且enable_star值为1。搜索过程按如下工作：

示例：

enable_star = 1

n-gram索引的n-gram长度。可选选项，默认为0（禁用n-gram索引）已知的值是0和1（其他长度尚未实现） 对于使用Coreseek的中文用户，在启用了中文分词的情况下，本节内容可忽略。

n-gram提供对未分词CJK（Chinese, Japanse, Koreasn中日韩）文本的基本支持。CJK搜索的问题在于词与词之前没有清晰的界限。理想中，文本可以通过一个称作分词程序（segmenter）的 特殊程序的过滤，之后分隔符即被加入到适当位置。然而分词过程缓慢而易错，因此通常会转而索引连续的一组N个字符，或称n-gram。

启用此特性，CJK字符流会被当作n-gram索引。例如，如果输入文本为“ABCDEF”（A到F均代表CJK字符） ，而此选项设置的长度为1，那它们会被当作“A B C D E F”而索引。（如果此选项设置的长度是2，那会产生“AB BC CD DE EF”，但目前仅支持1）。只有那些在 ngram_chars 选项表中列出的字符会这样分割，其他不受影响。

注意，如果搜索查询是已分词的，即单独的词之间有分隔符分隔，那么在扩展模式中将这些词放入引号中搜索会得到正确的匹配结果，即使文档没有分词。例如，假设原查询为“BC DEF”，在应用程序端用引号将索引包起来，看起来是“BC” “DEF”（包括引号），这个查询被传给Sphinx并在其内部分割成1-gram，查询变成“B C” “D E F”，仍然包括作为词组查询操作符的引号。该查询会匹配正确的文本，即使文本中没有相应的分隔符。

即使搜索查询没有分词，Sphinx也可以返回较好的结果，这要感谢基于词组的相关度计算：它会使相近的词组匹配（在n-gram中CJK词相当于多个字符的词匹配）排在前面。

示例：

ngram_len = 1

n-gram字符列表。 可选选项，默认为空。 对于使用Coreseek的中文用户，在启用了中文分词的情况下，本节内容可忽略。

与 ngram_len选项联用，此列表定义了从中抽取n-gram的字符序列。其他字符组成的词不受n-gram索引特性的影响。值的格式与charset_table相同。

示例：

ngram_chars = U+3000..U+2FA1F

词组边界符列表。 可选选项，默认为空。

此列表控制哪些字符被视作分隔不同词组的边界，每到一个这样的边界，其后面的词的“位置”值都会被加入一个额外的增量，可以借此用近似搜索符来模拟词组搜索。语法与 charset_table选项相似，但没有字符之间的映射关系，而且这些词组边界符不能重复出现在其他任何设置选项中。

自每个词组边界起，后面的词的“位置”都会被加入一个额外的增量（由 phrase_boundary_step定 义）。这使通过近似搜索符实现词组搜索成为可能：不同词组中的词之间的距离肯定大于phrase_boundary_step，因此相似距离小于 phrase_boundary_step的近似搜索其实是在搜索在一个词组范围内出现了全部给定查询词的情况，相当于词组搜索。

只有词组边界符后面紧跟着一个分隔符时，词组边界才被激活，这是为了避免S.T.A.L.K.E.R 或 URLs 等缩写被错当成若干个连续的词组（因为“.”属于词组边界符）。

示例：

phrase_boundary = ., ?, !, U+2026 # horizontal ellipsis

词组边界上词位置的增量。可选选项，默认为0。

在词组边界上，当前词位置会加上此选项设置的额外增量。详细请参考 phrase_boundary 选项。

示例：

phrase_boundary_step = 100

是否从输入全文数据中去除HTML标记。可选标记，默认为0。已知值包括0（禁用）和1（启用）。

此特性对 xmlpipe 数据源无效（建议升级到 xmlpipe2 ）。这个去除HTML标记的模块应该很好地工作于正确格式化的HTML和XHTML，但就像大多数浏览器一样，对于格式错误的文本（例如带有无法配对的<和>的HTML）可能产生不希望的输出。

只有HTML标签和HTML注释会被删除。要同时删除标签的内容（例如要删除内嵌的脚本），请参考 html_remove_elements 选项。标签名没有限制，即任何看起来像有效的标签开头、结束或者注释的内容都会被删除。

示例：

html_strip = 1

去除HTML标记时要索引的标记语言属性列表。可选选项，默认为空（不索引标记语言属性）。

指定被保留并索引的HTML标记语言属性，即使其他HTML标记被删除。格式是对每个标记列举可以索引的属性，请看下例：

示例：

html_index_attrs = img=alt,title; a=title;

HTML元素列表，不仅这些元素本身会被删除，它们的中间包括的文字内容也会被删除。可选选项，默认为空串（不删除任何元素的内容）。

此特性允许删除元素的内容，即在开始标记和结束标记之间的所有东西。用于删除内嵌的脚本或CSS等。短格式的元素（即<br />）被适当地支持，即，这种标记后面的内容不会被删除。

值为逗号分隔的标签名称列表。标签名大小写无关。

示例：

html_remove_elements = style, script

分布式索引 distributed index中的本地索引声明。可以出现多次， 可选选项，默认为空。

此设置用于声明分布式索引被搜索时要搜索的本地索引。全部本地索引会被依次搜索，仅使用1个CPU或核。要并行处理，可以配置searchd查询它自身（细节参考 Section 9.2.28, “agent” ）。可以为每个分布式索引声明多个本地索引。每个本地索引可以在其他分布式索引中多次引用。

示例：

local = chunk1
local = chunk2

分布式索引（distributed index）中的远程代理和索引声明。可以出现多次，可选选项，默认为空。

此设置用来声明搜索分布式索引时要搜索的远程代理。代理可以看作网络指针，它指定了主机、端口和索引名。在最基本的情况下，代理可以与远程物理主机对应。更严格的来说，这不一定总是正确：可以将多个代理指向同一台远程主机，甚至指向同一个searchd实例（以便利用多个CPU或核）

值的格式如下：

agent = specification:remote-indexes-list
specification = hostname ":" port | path

“hostname”是远程主机名，“port”是远程TCP端口，而“remote-index-list”是一个逗号分隔的远程索引列表。

全部代理会被并行搜索。然而同一个代理的多个索引是依次搜索的。这使您可以根据硬件来优化配置。例如，如果两个远程索引存储在一个相同的硬盘上，最 好是配置一个带有多个按顺序搜索的索引，避免频繁的磁头寻址。如果这些索引存储在不同的硬盘上，那配置两个代理会更有利，因为这可以使工作完全并行。对于 CPU也是如此，虽然在两个进程间切换对性能的影响比较小而且常常被完全忽略。

在有多个CPU和硬盘的机器上，代理可以指向相同的机器以便并行地使用硬件，降低查询延迟。并不需要为此设置多个searchd实例，一个实例与自身通信是合法的。以下是一个示例设置，它是为一台有4个CPU的机器准备的，可以并行地使用4个CPU，各处理一个查询：

index dist
{
	type = distributed
	local = chunk1
	agent = localhost:9312:chunk2
	agent = localhost:9312:chunk3
	agent = localhost:9312:chunk4
}

注意其中一块是本地搜索的，而同一个searchd示例又向本身查询，以便并行地启动其他三个搜索。

示例：

agent = localhost:9312:chunk2 # contact itself
agent = /var/run/searchd.s:chunk2
agent = searchbox2:9312:chunk3,chunk4 # search remote indexes

分布式索引（ distributed index）中声明远程黑洞代理。多个值，可选选项，默认是空。于版本0.9.9-rc1引入。

agent_blackhole 选项使用户可以向远程代理发送“即发即忘”的查询（fire-and-forget queries）。这在调试（或者仅仅是测试）即将投入生产的集群的时候很有用：可以设置一个单独的调试/测试searchd实例，然后从实际生产中使用的主服务器（master，或称聚集者aggregator）实例向这个测试服务器转发查询请求，但不干扰生产系统的工作。主（master）searchd会以正常的方式尝试连接和查询黑洞代理，但是它既不会等待也不会处理黑洞代理的反馈。同时，发生在黑洞代理上的全部网络错误也都被忽略。值的格式与普通的 agent 完全相同。

示例：

agent_blackhole = testbox:9312:testindex1,testindex2

远程代理的连接超时时间，单位为毫秒。可选选项，默认为1000（即1秒）。

连接到远程代理时，searchd最多花这些时间等待connet()调用成功完成。如果达到了超时时间connect()仍没有完成，而 and retries 选项是启用的，那么将开始重试。

示例：

agent_connect_timeout = 300

远程代理查询超时时间，以毫秒为单位。可选选项，默认为3000（即3秒）。

连接后，searchd最多花这这些时间等到远程查询完成。这个超时时间与连接超时时间是完全独立的。因此一个远程代理最多能造成的延迟为agent_connection_timeout与agent_query_timeout之和。如果超时时间已到，查询不会再重试，同时产生警告。

示例：

agent_query_timeout = 10000 # our query can be long, allow up to 10 sec

预先打开全部索引文件还是每次查询时再打开索引。可选选项，默认为0（不预先打开）。

此选项令searchd在启动时（或轮换索引时）预先开打全部索引文件并在运行过程中保持打开。目前，默认是不预先打开这些文件（此行为可能在未来改变）。预先打开的每个索引文件会占用若干（目前是两个）文件描述符。但每次查询可以节约两个open()调用而且不会受高负载情况下索引轮换过程中可能发生的微妙的竞争条件（race condition）的影响。另一方面，当提供很多索引服务（几百到几千）时，必须每次查询时打开索引文件以便节约文件描述符。

这个指令不影响indexer的任何行为，只对searchd有用。

示例：

preopen = 1

指定是将字典文件（.spi）保持在磁盘上还是将它预先缓冲在内存中。可选选项，默认值是0（预先缓冲在内存里）。于版本0.9.9-rc1引入。

字典文件（.spi）既可以驻留在内存中也可以保持在磁盘上。默认情况下是将整个字典缓冲在内存中。这样做提高性能，但可能带来过大的内存压力，尤其是使用了前缀或中缀的时候。启用ondisk_dict为每次查询的每个关键词带来一次磁盘I/O操作，但是会减少内存使用。

这个指令不影响indexer的任何行为，只对searchd有用。

示例：

ondisk_dict = 1

是否启用原地索引倒转（in-place index inversion）。可选选项，默认值是0（使用单独的临时文件）。于版本0.9.9-rc1引入。

inplace_enable 选项极大地减少了建立索引时的磁盘压力，代价是略慢的索引速度（少使用大约两倍的磁盘空间，速度方面能达到原有性能的90-95%）

建立索引的过程有两个主要的阶段。第一个阶段主要是收集、处理文档以及对文档根据关键词进行部分的排序，中间结果被写入到临时文件（.tmp*） 中。第二个阶段则对文档进行完全排序并创建总重的索引文件。因此，重建一个正在应用于生产的索引将导致一个三倍大的磁盘占用峰值：第一倍，中间结果临时文 件，第二，新建的副本，和第三，在一切发生时旧的索引仍然占用一份磁盘空间，以便继续服务。（中间结果的大小与最终索引的大小相当）。对于很大的数据集， 这将是一笔很大的磁盘开销，而inplace_enable 选项用于减少这个开销。一旦启用这个选项，临时文件将被重复利用，最终的数据写回到临时文件中，最后改个名字就可以作为最终结果使用了。然而，这可能导致更多的临时数据块重新分配，因此性能会有一点损失。

这个指令不影响searchd的任何行为，只对indexer有用。

示例：

inplace_enable = 1

微调原地倒转（In-place inversion）行为的选项。控制预先分配的匹配点列表（hitlist）的空隙的大小。可选选项，默认是0。于版本0.9.9-rc1引入。

这个指令不影响searchd的任何行为，只对indexer有用。

示例：

inplace_hit_gap = 1M

微调原地倒转（In-place inversion）行为的选项。控制预先分配的文档信息（docinfo）的空隙的大小。可选选项，默认是0。于版本0.9.9-rc1引入。

这个指令不影响searchd的任何行为，只对indexer有用。

示例：

inplace_docinfo_gap = 1M

微调原地倒转（In-place inversion ）行为的选项。控制重定位缓冲区占用索引时的内存的比例。可选选项，默认是0.1。于版本0.9.9-rc1引入。

这个指令不影响searchd的任何行为，只对indexer有用。

示例：

inplace_reloc_factor = 0.1

微调原地倒转（In-place inversion ）行为的选项。控制原地写缓冲占用索引时的内存的比例。可选选项，默认是0.1。于版本0.9.9-rc1引入。

这个指令不影响searchd的任何行为，只对indexer有用。

示例：

inplace_write_factor = 0.1

是否在索引原关键词的词干化/重映射后的形式的同时也索引原词。可选选项，默认值是0（不索引额外的形式）。于版本0.9.9-rc1引入。

一旦启用，index_exact_words强制indexer除了词干化的版本外，将原始的关键字也加入索引。这样做也使查询语言中的精确匹配搜索符可用。这个选项将对索引大小和索引时间带来延迟。然而搜索的性能不会被影响。

示例：

index_exact_words = 1

在经过过短的词（比 min_word_len短的词）处后增加位置值。 可选选项，允许的值是0或者1，默认是1。于版本0.9.9-rc1引入。

这个指令不影响searchd的任何行为，只对indexer有用。

示例：

overshort_step = 1

在经过 停用词 处后增加位置值可选选项，允许的值是0或者1，默认是1。于版本0.9.9-rc1引入。

这个指令不影响searchd的任何行为，只对indexer有用。

示例：

stopword_step = 1

索引过程内存使用限制。可选选项，默认32M。

这是indexer不会超越的强制内存限制。可以以字节、千字节（以K为后缀）或兆字节（以M为后缀）为单位。参见示例。当过小的值导致I/O缓冲低于8KB时该限制会自动提高，此值的最低限度依赖于待索引数据的大小。如果缓冲低于256KB，会产生警告。

最大可能的限制是2047M。太低的值会影响索引速度，但256M到1024M对绝大多数数据集（如果不是全部）来说应该足够了。这个值设得太高可 能导致SQL服务器连接超时。在文档收集阶段，有时内存缓冲的一部分会被排序，而与数据库的通信会暂停，于是数据库服务器可能超时。这可以通过提高SQL 服务器端的超时时间或降低 mem_limit来解决。 在Coreseek的分发版本中，如果使用python数据源，则在Python部分的处理不会受mem_limit的限制。

示例：

mem_limit = 256M
# mem_limit = 262144K # same, but in KB
# mem_limit = 268435456 # same, but in bytes

每秒最大I/O操作次数，用于限制I/O操作。可选选项，默认为0（无限制）。

与I/O节流有关的选项。它限制了每秒钟最大的I/O操作（读或写）的次数。值0意思是不加限制。

indexer在索引时可能导致突发的密集磁盘I/O，因此需要限制它磁盘活动（给同一台机器上运行的其他程序留出一些资源，比如searchd）。 I/O节流就是用来实现上述功能的。它的工作原理是，在indexer的连续磁盘I/O操作之间强制增加一个保证的延迟。现代SATA硬盘每秒钟可以执行多达70-100以上次的I/O操作（主要受磁头寻道时间的限制）。将索引I/O限制为上述数值的几分之一可以减轻由索引带来的搜索性能下降。

示例：

max_iops = 40

最大允许的I/O操作大小，以字节为单位，用于I/O节流。可选选项，默认为0（不限制）。

与I/O节流有关的选项。它限制indexer文件I/O操作的单次最大大小。值0代表不加限制。超过限制的读写操作会被分成几个小的操作，并被max_iops 计为多次。在本文写作时，全部I/O操作都被限制在256KB以下（默认的内部缓冲大小），因此大于256KB的max_iosize值没有任何作用。

示例：

max_iosize = 1048576

对于XMLLpipe2数据源允许的最大的域大小，以字节为单位。可选选项，默认值为2MB。

示例：

max_xmlpipe2_field = 8M

写缓冲区的大小，单位是字节。可选选项，默认值是1MB。

在建立索引过程中，写缓冲用于写入临时行而最终的索引文件。写缓冲区越大则所需的磁盘写入次数越少。缓冲区使用的内存不计入 mem_limit选项的值。注意对于不同的文件，会分配多个缓冲区（目前最多4个），这会引起内存占用增加。

示例：

write_buffer = 4M

指定searchd监听的IP地址和端口，或UNIX域socket的路径。于版本0.9.9-rc1引入。

一个非正式的listen语法说明如下：

listen = ( address ":" port | port | path ) [ ":" protocol ]

即，用户可以指定IP地址（或主机名）和端口号，或者仅仅是端口号，或者Unix socket的路径。如果仅指定了端口号而没有地址，那么searchd会在所有的网络接口上监听。Unix路径都带有一个前导的斜杠”/”

从版本0.9.9-rc2开始，还可以指定一个协议处理器（protocl handler），或者叫监听器（listener），应用于这个socket上的连接。支持的协议值包括‘sphinx’（Sphinx 0.9.x API协议）和mysql41（版本4.1到至少5.1的MySQL使用的协议）。关于MySQL协议的更多细节可以参考 Section 4.9, “MySQL 协议支持与 SphinxQL” 。

示例：

listen = localhost
listen = localhost:5000
listen = 192.168.0.1:5000
listen = /var/run/sphinx.s
listen = 9312
listen = localhost:9306:mysql41

可以有多个listen指令，searchd 会在所有这些指令纸浆的端口和socket上监听，以备用户连接。如果没有找到listen指令，服务器会在所有的网络接口上用默认端口（9312）监听

在Windows上不支持Unix socket。

要绑定的接口IP地址。可选项，默认为0.0.0.0（即在所有接口上监听）。 不推荐, 建议使用 listen 。

address 设置指定searchd在哪个接口上绑定、监听和接受输入的网络连接。默认值为0.0.0.0，意思是在所有接口上监听。目前不能指定多个接口。

示例：

address = 192.168.0.1

searchd 的TCP端口号。 不推荐, 建议使用 listen 。 必选项，默认为9312。

示例：

port = 9312

日志文件名。可选项，默认为“searchd.log”。全部searchd运行时事件会被记录在这个日志文件中。

示例：

log = /var/log/searchd.log

查询日志文件名。可选项，默认为空（不记录查询日志）。全部搜索查询会被记录在此文件中。其格式在Section 4.8, “ searchd查询日志格式”中描述

示例：

query_log = /var/log/query.log

网络客户端请求的读超时时间，单位是秒。可选项，默认是5秒。 searchd 强制关闭在此时间内未能成功发出查询的客户端连接。

示例：

read_timeout = 1

在使用持久连接时，两次查询之间等待的最长时间（单位是秒）。可选选项，默认是5分钟。

示例：

client_timeout = 3600

子进程的最大数量（或者说，并行执行的搜索的数目）。可选项，默认为0，不限制。

用来控制服务器负载。任何时候不可能有比此设置值更多的搜索同时运行。当达到限制时，新的输入客户端会被用临时失败（SEARCH_RETRY）状态码驳回，同时给出一个声明服务器已到最大连接限制的消息。

示例：

max_children = 10

searchd 进程ID文件名。必选项。

PID文件会在启动时重建（并锁定）。主守护进程运行时它含有该进程的ID，而当守护进程退出时该文件会被删除。这个选项是必须的，因为Sphinx在内部使用它做如下事：检查是否已有一个searchd示例；停止searchd；通知searchd应该轮换索引了。也可以被各种不同的外部自动化脚本所利用。

示例：

pid_file = /var/run/searchd.pid

守护进程在内存中为每个索引所保持并返回给客户端的匹配数目的最大值。可选选项，默认值为1000。

引入此选项是为了控制和限制内存使用，max_matches设置定义了搜索每个索引时有多少匹配项会保存在内存中。每个找到的匹配项都会被处理，但只有它们中最佳的N个会在内存中保持并最终返回给客户端。假设索引中包括2000000个当前查询的匹配项，你几乎总是不需要它们中的全部。 通常您需要扫描它们并根据某种条件（即按相关度排序、或者价格、或者其他什么）选出最好的那些，比如500个，并以在页面上显示20到100项。只跟踪最 好的500个匹配要比保持全部的2000000个匹配项大大地节约内存和CPU，之后可以对这些最佳匹配排序，然后丢弃除了要在页面上要显式的20项之外 的结果。max_matches控制“最佳N个匹配”中的N。

此参数明显影响每个查询消耗的内存和CPU。1000到10000的值通常就可以满足需求，但更高的值要小心使用。粗心地把max_matches增加到1000000意味着searchd被迫为每一个查询分配1M条匹配项的缓冲。这会明显增大查询的内存消耗，有时会明显影响性能。

特别注意！此限制还可在另一个地方指定。max_matches可以通过对应的API调用实时降低，该调用的默认值也是1000。因此要使应用程序获取超过1000个匹配结果，必须修改配置文件，重启searchd，再用SetLimits()调用设置合适的限制。还要注意，API调用设置的限制不能大于.conf文件中的设置，这是为了预防恶意的或错误的请求。

示例：

max_matches = 10000

防止 searchd 轮换在需要预取大量数据的索引时停止响应。可选选项，默认为1（启用无缝（seamless）轮换）。

索引可能包含某些需要预取到内存中的数据。目前.spa, .spi 和 .spm文件会被完全预取到内存中（它们分别包含属性数据，MVA数据和关键字索引）。若无无缝轮换，轮换索引时会尽量使用较小的内存，并如下工作：

然而，如果有大量的属性或字典数据，那么预调数据的步骤可能消耗大量的时间——预调1.5GB的文件可能需要几分钟的时间。

当启用了无缝轮换，轮换按如下工作：

无缝轮换以轮换过程中更大的峰值内存消耗为代价（因为当预调新索引时.spa/.spi/.spm数据的新旧拷贝需要同时保持在内存中）。平均内存耗用不变。

示例：

seamless_rotate = 1

是否在启动是强制重新打开所有索引文件。可选选项，默认为0（不重新打开）。对所有提供服务的索引强制打开 preopen 选项，免得对每个索引手工指定了。

示例：

preopen_indexes = 1

索引轮换成功之后，是否删除以.old为扩展名的索引拷贝。可选选项，默认为1（删除这些索引拷贝）。

示例：

unlink_old = 0

用UpdateAttributes()实时更新文档属性时，所产生的变化首先写入到这些属性在内存中的一份拷贝中（必须将docinfo设置成extern）。其后，一旦searchd正常关闭（通过发送SIGTERM信号），这些变化才写入磁盘。于版本0.9.9-rc1中引入。

从版本0.9.9-rc1开始，可以令searchd每隔一段时间就将变化写回磁盘，防止丢失这些变化。这个间隔时间通过attr_flush_period选项设置，单位是秒。

默认值是0，即关闭隔一段时间就将变化写回磁盘的特性，但是正常关闭时的写回不被关闭。

示例：

attr_flush_period = 900 # persist updates to disk every 15 minutes

对 ondisk_dict 指令的全局的默认值。 可选选项，默认值是0（将字典预先缓冲到内存）。于版本0.9.9-rc1中引入。

这个选项用于为当前使用的这份searchd正在提供服务的所有索引指定ondisk_dict选项的默认值。如果某个索引的这个选项做了显式设定，那么这个设定覆盖上述实例级的默认设置，这种机制提供了细粒度的控制。

示例：

ondisk_dict_default = 1 # keep all dictionaries on disk

网络通讯时允许的最大的包的大小。这个限制既对来自客户端的查询包有效，也对分布式环境下远程代理返回的响应包有效。只用于内部校验，不直接影响内存占用和性能。可选选项，默认值是8M。于版本0.9.9-rc1引入。

示例：

max_packet_size = 32M

用于多值属性MVA更新的存储空间的共享池大小。可选选项，默认大小是1M。于版本0.9.9-rc1引入。

这个设置控制用于存储多值属性MVA更新后的值共享存储池的大小。如果指定大小为0则意味着完全禁用多值属性MVA的更新。一旦达到了这个内存池大 小的限制，尝试更新多值属性MVA将得到错误。但普通的（标量的）属性仍然可以更新。由于内部实现上的技术困难，一旦多值属性MVA有所更新，则索引上发 生的任何更新改变都不能在索引重建前被写入（store，flush）磁盘，尽管这可能在未来实现。同时，多值属性MVA是设计用来在索引重建前迅速反应数据库中的变化，而不是一种永久存储的机制。

示例：

mva_updates_pool = 16M

崩溃日志文件的路径（正式地说叫做前缀）。可选选项，默认值为空（不创建崩溃日志文件）。于版本0.9.9-rc1引入。

这个选项用于调试，有了它就可以捕捉那些个别的令人不快的造成崩溃的查询，而不比影响正在使用的用于生产的服务器实例。一旦启用了这个选项，searchd会拦截造成崩溃的信号，例如SIGSEGV，并将那些不愉快的查询包转储到一个叫做“crash_log_path.PID”的文件中，其中PID是崩溃了的进程的ID。

示例：

crash_log_path = /home/sphinx/log/crashlog

Maximum allowed per-query filter count. Only used for internal sanity checks, does not directly affect RAM use or performance. Optional, default is 256. Introduced in version 0.9.9-rc1. 每次查询允许设置的过滤器的最大个数。只用于内部检查，不直接影响内存使用或性能。可选选项，默认值是256。于版本0.9.9-rc1引入。

示例：

max_filters = 1024

单个过滤器允许的值的最大个数。只用于内部检查，不直接影响内存使用或性能。可选选项，默认值是4096。于版本0.9.9-rc1引入。

示例：

max_filter_values = 16384

TCP监听积压列表长度。可选选项，默认值是5。

在Windows系统上创建的Sphinx目前（版本0.9.9）只能一个接一个地处理请求。同时发生的请求会被操作系统级别的TCP协议栈装入到 一个队列中，无法如对的请求立即失败并收到“连接被拒”错误信息。listen_backlog选项控制这个连接队列的长度。非Windows平台上创建 的Sphinx使用默认值即可。

示例：

listen_backlog = 20

每个关键字的读缓冲区的大小。可选选项，默认值是256K。

对于每个搜索查询中的每个关键词，有两个相关的读缓冲区（一个针对文档列表，一个针对关键词出现位置列表）。本选项允许控制他们的大小，增加每次查询的内存占用，但可能会减少IO时间。

示例：

read_buffer = 1M

无提示时读操作的大小。可选选项，默认值是32K。

当系统处理查询时，对于一些读取操作，系统预先就知道要读取的数据的确切长度，但是有一些却相反。其中对常见的是已匹配位置列表（hitlist） 的长度目前是无法预先取得的。这个选项控制在这些情况下读物读取多少数据。它会影响IO时间，对于比本选项设置值大的列表，IO时间减少，而对于那些较小 的列表则是IO时间增加。内存占用不受影响，因为读缓冲区已经是分配好了的。也因此这个选项的设置值不能超过选项read_buffer的设置值。

示例：

read_unhinted = 32K

核心配置：
	charset_dictpath		= /usr/local/mmseg3/etc/
	charset_type		         = zh_cn.utf-8
	#charset_table                 = .................... #需将原有的该配置注释掉
	ngram_len                        = 0

设置中文分词词典所在的目录；

示例:

#Linux
charset_dictpath		= /usr/local/mmseg3/etc/
#Windows
charset_dictpath		= C:\usr\local\coreseek\etc

设置文档的字符集，可选的值为“zh_cn.utf-8”、“zh_cn.gbk”和“zh_cn.big5”。“zh_cn.gbk”和“zh_cn.big5”需要iconv支持。

示例:

charset_type		=  zh_cn.utf-8

基本配置：
[mmseg] 
merge_number_and_ascii=0; 	;合并英文和数字 abc123/x
number_and_ascii_joint=-; 	;定义可以连接英文和数字的字符
compress_space=1; 		;暂不支持
seperate_number_ascii=0;	;就是将字母和数字打散
其中，分号表示注释

是否合并英文和数字，该选项设置是否将连接在一起的英文字母和数字作为一个整体看待

例如:

merge_number_and_ascii=0; ;abc123将被切分为abc、123
merge_number_and_ascii=1; ;abc123将不被切分

定义可以连接英文和数字的字符

例如:

number_and_ascii_joint=-_; ;abc_123、abc-123都将作为整体

预设配置，暂不支持

是否将字母和数字打散

例如:

seperate_number_ascii=0; ;abc作为整体
seperate_number_ascii=1; ;abc被切分为a、b、c

#Python数据源基本演示程序
#/usr/local/coreseek/etc/pysource/csft_demo/__init__.py
# -*- coding:utf-8 -*-

class MainSource(object):
    def __init__(self, conf):
        self.conf =  conf
        self.data = [
            {'id':1, 'subject':u"标题1", 'date':1270131607},
            {'id':2, 'subject':u'标题2', 'date':1270135548},
        ]
        self.idx = 0
        
    def GetScheme(self):
        return [
            ('id' , {'docid':True, } ),
            ('subject', { 'type':'text'} ),
            ('date', {'type':'integer'} ),
        ]
       
    def GetKillList(self):
        return [3,1]
    
    def GetFieldOrder(self):
        return ('subject')
        
    def Connected(self):
        pass

    def OnBeforeIndex(self):
        print 'before index called'
        pass

    def NextDocument(self):
        if self.idx < len(self.data):
            item = self.data[self.idx]
            self.id = item['id']
            self.subject = item['subject'].encode('utf-8')
            self.date = item['date']
            self.idx += 1
            return True
        else:
            return False
		pass

    def OnAfterIndex(self):
        print 'after index called'
		pass

    def OnIndexFinished(self):
        print 'after index finished'
        pass

if __name__ == "__main__":
    source = MainSource()
    source.Connected()

    source.OnBeforeIndex()
    while source.NextDocument():
        print "id=%d, title=%s" % (source.docid, source.title)

    source.OnAfterIndex()
    source.OnIndexFinished()
    pass
#eof

返回所有需要被索引的字段的属性

例如:

    def GetScheme(self):
        return [
            ('id' , {'docid':True, } ),
            ('subject', { 'type':'text'} ),
            ('date', {'type':'integer'} ),
        ]		
		

在检索字段设置中，必须且仅有一个字段需要设置为docid，对应于SQL数据源中的文档编号。其他字段的属性，可以为integer，对应于sql_attr_uint，或者text，对应于全文检索字段。

处于该列表之中的文档，将不被检索，对应于SQL数据源的sql_query_killlist

例如:

    def GetKillList(self):
        return [3,1]		
		

全文字段被检索的顺序

例如:

    def GetFieldOrder(self):
        return [('subject','content')]
		

一般用于进行数据库的连接等预处理

例如:

    def Connected(self):
        #在此进行数据库连接和处理
        pass		
		

类似sql_query_pre配置选项的作用

例如:

    def OnBeforeIndex(self):
        print 'before index called'
        pass		
		

获取实际的需要参与检索的数据，按条获取，需要获取的字段，作为self自身的属性给出，相当于sql_query的作用，每次读取一条数据

例如:

    def NextDocument(self):
        if self.idx < len(self.data):
            item = self.data[self.idx]
            self.id = item['id']
            self.subject = item['subject'].encode('utf-8')
            self.date = item['date']
            self.idx += 1
            return True
        else:
            return False		
		pass
		

类似sql_query_post配置选项的作用

例如:

    def OnAfterIndex(self):
        print 'after index called'
		pass
		

类似sql_query_post_index配置选项的作用

例如:

    def OnIndexFinished(self):
        print 'after index finished'
        pass