Free open-source SQL full-text search engine


Table of Contents

1. Introduction
About
Sphinx features
Where to get Sphinx
License
Credits
History
2. Installation
Supported systems
Compiling Sphinx from source
Installing Sphinx packages on Debian and Ubuntu
Installing Sphinx packages on RedHat and CentOS
Installing Sphinx on Windows
Sphinx deprecations and changes in default configuration
Quick Sphinx usage tour
3. Indexing
Data sources
Full-text fields
Attributes
MVA (multi-valued attributes)
Indexes
Restrictions on the source data
Charsets, case folding, translation tables, and replacement rules
SQL data sources (MySQL, PostgreSQL)
xmlpipe2 data source
tsvpipe\csvpipe (Tab\Comma Separated Values) data source
Live index updates
Delta index updates
Index merging
4. Real-time indexes
RT indexes overview
Known caveats with RT indexes
RT index internals
Binary logging
5. Searching
Matching modes
Boolean query syntax
Extended query syntax
Search results ranking
Expressions, functions, and operators
Sorting modes
Grouping (clustering) search results
Distributed searching
searchd query log formats
MySQL protocol support and SphinxQL
Multi-queries
Collations
6. Extending Sphinx
Sphinx UDFs (User Defined Functions)
Sphinx plugins
Ranker plugins
7. Command line tools reference
indexer command reference
searchd command reference
spelldump command reference
indextool command reference
wordbreaker command reference
8. SphinxQL reference
SELECT syntax
SELECT @@system_variable syntax
SHOW META syntax
SHOW WARNINGS syntax
SHOW STATUS syntax
INSERT and REPLACE syntax
REPLACE syntax
DELETE syntax
SET syntax
SET TRANSACTION syntax
BEGIN, COMMIT, and ROLLBACK syntax
BEGIN syntax
ROLLBACK syntax
CALL SNIPPETS syntax
CALL KEYWORDS syntax
SHOW TABLES syntax
DESCRIBE syntax
CREATE FUNCTION syntax
DROP FUNCTION syntax
SHOW VARIABLES syntax
SHOW COLLATION syntax
SHOW CHARACTER SET syntax
UPDATE syntax
ALTER syntax
ATTACH INDEX syntax
FLUSH RTINDEX syntax
FLUSH RAMCHUNK syntax
TRUNCATE RTINDEX syntax
SHOW AGENT STATUS
SHOW PROFILE syntax
SHOW INDEX STATUS syntax
SHOW INDEX SETTINGS syntax
OPTIMIZE INDEX syntax
SHOW PLAN syntax
SHOW DATABASES syntax
CREATE PLUGIN syntax
DROP PLUGIN syntax
SHOW PLUGINS syntax
SHOW THREADS syntax
Multi-statement queries
Comment syntax
List of SphinxQL reserved keywords
SphinxQL upgrade notes, version 2.0.1-beta
9. API reference
General API functions
General query settings
Full-text search query settings
Result set filtering settings
GROUP BY settings
Querying
Additional functionality
Persistent connections
10. MySQL storage engine (SphinxSE)
SphinxSE overview
Installing SphinxSE
Using SphinxSE
Building snippets (excerpts) via MySQL
11. Reporting bugs
12. sphinx.conf options reference
Data source configuration options
Index configuration options
indexer program configuration options
searchd program configuration options
Common section configuration options
A. Sphinx revision history
Version 2.2.11-release, 19 jul 2016
Version 2.2.10-release, 07 sep 2015
Version 2.2.9-release, 16 apr 2015
Version 2.2.8-release, 09 mar 2015
Version 2.2.7-release, 20 jan 2015
Version 2.2.6-release, 13 nov 2014
Version 2.2.5-release, 06 oct 2014
Version 2.2.4-release, 11 sep 2014
Version 2.2.3-beta, 13 may 2014
Version 2.2.2-beta, 11 feb 2014
Version 2.2.1-beta, 13 nov 2013
Version 2.1.9-release, 03 jul 2014
Version 2.1.8-release, 28 apr 2014
Version 2.1.7-release, 30 mar 2014
Version 2.1.6-release, 24 feb 2014
Version 2.1.5-release, 22 jan 2014
Version 2.1.4-release, 18 dec 2013
Version 2.1.3-release, 12 nov 2013
Version 2.1.2-release, 10 oct 2013
Version 2.1.1-beta, 20 feb 2013
Version 2.0.11-dev, xx xxx xxxx
Version 2.0.10-release, 22 jan 2014
Version 2.0.9-release, 26 aug 2013
Version 2.0.8-release, 26 apr 2013
Version 2.0.7-release, 26 mar 2013
Version 2.0.6-release, 22 oct 2012
Version 2.0.5-release, 28 jul 2012
Version 2.0.4-release, 02 mar 2012
Version 2.0.3-release, 23 dec 2011
Version 2.0.2-beta, 15 nov 2011
Version 2.0.1-beta, 22 apr 2011
Version 1.10-beta, 19 jul 2010
Version 0.9.9-release, 02 dec 2009
Version 0.9.9-rc2, 08 apr 2009
Version 0.9.9-rc1, 17 nov 2008
Version 0.9.8.1, 30 oct 2008
Version 0.9.8, 14 jul 2008
Version 0.9.7, 02 apr 2007
Version 0.9.7-rc2, 15 dec 2006
Version 0.9.7-rc1, 26 oct 2006
Version 0.9.6, 24 jul 2006
Version 0.9.6-rc1, 26 jun 2006

List of Tables

5.1.