Sphinx 2.3.2-beta reference manual
==================================
Free open-source SQL full-text search engine
============================================
Copyright (c) 2001-2016 Andrew Aksyonoff
Copyright (c) 2008-2016 Sphinx Technologies Inc, http://sphinxsearch.com
----------------------------------------------------------------------------
Table of Contents
1. Introduction
1.1. About
1.2. Sphinx features
1.3. Where to get Sphinx
1.4. License
1.5. Credits
1.6. History
2. Installation
2.1. Supported systems
2.2. Compiling Sphinx from source
2.2.1. Required tools
2.2.2. Compiling on Linux
2.2.3. Known compilation issues
2.3. Installing Sphinx packages on Debian and Ubuntu
2.4. Installing Sphinx packages on RedHat and CentOS
2.5. Installing Sphinx on Windows
2.6. Sphinx deprecations and changes in default configuration
2.7. Quick Sphinx usage tour
3. Indexing
3.1. Data sources
3.2. Full-text fields
3.3. Attributes
3.4. MVA (multi-valued attributes)
3.5. Indexes
3.6. Restrictions on the source data
3.7. Charsets, case folding, translation tables, and replacement rules
3.8. SQL data sources (MySQL, PostgreSQL)
3.9. xmlpipe2 data source
3.10. tsvpipe\csvpipe (Tab\Comma Separated Values) data source
3.11. Live index updates
3.12. Delta index updates
3.13. Index merging
4. Real-time indexes
4.1. RT indexes overview
4.2. Known caveats with RT indexes
4.3. RT index internals
4.4. Binary logging
5. Searching
5.1. Matching modes
5.2. Boolean query syntax
5.3. Extended query syntax
5.4. Search results ranking
5.4.1. Ranking overview
5.4.2. Available built-in rankers
5.4.3. Expression based ranker (SPH_RANK_EXPR)
5.4.4. Quick summary of the ranking factors
5.4.5. Document-level ranking factors
5.4.6. Field-level ranking factors
5.4.7. Ranking factor aggregation functions
5.4.8. Formula expressions for all the built-in rankers
5.5. Expressions, functions, and operators
5.5.1. Operators
5.5.2. Numeric functions
5.5.3. Date and time functions
5.5.4. Type conversion functions
5.5.5. Comparison functions
5.5.6. Miscellaneous functions
5.6. Sorting modes
5.7. Grouping (clustering) search results
5.8. Distributed searching
5.9. searchd query log formats
5.9.1. Plain log format
5.9.2. SphinxQL log format
5.10. MySQL protocol support and SphinxQL
5.11. HTTP protocol
5.12. Multi-queries
5.13. Collations
5.14. Query cache
6. Extending Sphinx
6.1. Sphinx UDFs (User Defined Functions)
6.2. Sphinx plugins
6.3. Ranker plugins
7. Command line tools reference
7.1. indexer command reference
7.2. searchd command reference
7.3. spelldump command reference
7.4. indextool command reference
7.5. wordbreaker command reference
8. SphinxQL reference
8.1. SELECT syntax
8.2. SELECT @@system_variable syntax
8.3. SHOW META syntax
8.4. SHOW WARNINGS syntax
8.5. SHOW STATUS syntax
8.6. INSERT and REPLACE syntax
8.7. REPLACE syntax
8.8. DELETE syntax
8.9. SET syntax
8.10. SET TRANSACTION syntax
8.11. BEGIN, COMMIT, and ROLLBACK syntax
8.12. BEGIN syntax
8.13. ROLLBACK syntax
8.14. CALL SNIPPETS syntax
8.15. CALL KEYWORDS syntax
8.16. CALL QSUGGEST syntax
8.17. SHOW TABLES syntax
8.18. DESCRIBE syntax
8.19. CREATE FUNCTION syntax
8.20. DROP FUNCTION syntax
8.21. SHOW VARIABLES syntax
8.22. SHOW COLLATION syntax
8.23. SHOW CHARACTER SET syntax
8.24. UPDATE syntax
8.25. ALTER syntax
8.26. ATTACH INDEX syntax
8.27. FLUSH RTINDEX syntax
8.28. FLUSH RAMCHUNK syntax
8.29. FLUSH ATTRIBUTES syntax
8.30. FLUSH HOSTNAMES syntax
8.31. TRUNCATE RTINDEX syntax
8.32. SHOW AGENT STATUS
8.33. SHOW PROFILE syntax
8.34. SHOW INDEX STATUS syntax
8.35. SHOW INDEX SETTINGS syntax
8.36. OPTIMIZE INDEX syntax
8.37. SHOW PLAN syntax
8.38. SHOW DATABASES syntax
8.39. CREATE PLUGIN syntax
8.40. DROP PLUGIN syntax
8.41. SHOW PLUGINS syntax
8.42. RELOAD PLUGINS syntax
8.43. SHOW THREADS syntax
8.44. RELOAD INDEX syntax
8.45. Multi-statement queries
8.46. Comment syntax
8.47. List of SphinxQL reserved keywords
8.48. SphinxQL upgrade notes, version 2.0.1-beta
9. API reference
9.1. General API functions
9.1.1. GetLastError
9.1.2. GetLastWarning
9.1.3. SetServer
9.1.4. SetRetries
9.1.5. SetConnectTimeout
9.1.6. SetArrayResult
9.1.7. IsConnectError
9.2. General query settings
9.2.1. SetLimits
9.2.2. SetMaxQueryTime
9.2.3. SetOverride
9.2.4. SetSelect
9.3. Full-text search query settings
9.3.1. SetMatchMode
9.3.2. SetRankingMode
9.3.3. SetSortMode
9.3.4. SetWeights
9.3.5. SetFieldWeights
9.3.6. SetIndexWeights
9.4. Result set filtering settings
9.4.1. SetIDRange
9.4.2. SetFilter
9.4.3. SetFilterRange
9.4.4. SetFilterFloatRange
9.4.5. SetGeoAnchor
9.4.6. SetFilterString
9.5. GROUP BY settings
9.5.1. SetGroupBy
9.5.2. SetGroupDistinct
9.6. Querying
9.6.1. Query
9.6.2. AddQuery
9.6.3. RunQueries
9.6.4. ResetFilters
9.6.5. ResetGroupBy
9.7. Additional functionality
9.7.1. BuildExcerpts
9.7.2. UpdateAttributes
9.7.3. BuildKeywords
9.7.4. EscapeString
9.7.5. Status
9.7.6. FlushAttributes
9.8. Persistent connections
9.8.1. Open
9.8.2. Close
10. MySQL storage engine (SphinxSE)
10.1. SphinxSE overview
10.2. Installing SphinxSE
10.2.1. Compiling MySQL 5.0.x with SphinxSE
10.2.2. Compiling MySQL 5.1.x with SphinxSE
10.2.3. Checking SphinxSE installation
10.3. Using SphinxSE
10.4. Building snippets (excerpts) via MySQL
11. Reporting bugs
12. sphinx.conf options reference
12.1. Data source configuration options
12.1.1. type
12.1.2. sql_host
12.1.3. sql_port
12.1.4. sql_user
12.1.5. sql_pass
12.1.6. sql_db
12.1.7. sql_sock
12.1.8. mysql_connect_flags
12.1.9. mysql_ssl_cert, mysql_ssl_key, mysql_ssl_ca
12.1.10. odbc_dsn
12.1.11. sql_query_pre
12.1.12. sql_query
12.1.13. sql_joined_field
12.1.14. sql_query_range
12.1.15. sql_range_step
12.1.16. sql_query_killlist
12.1.17. sql_attr_uint
12.1.18. sql_attr_bool
12.1.19. sql_attr_bigint
12.1.20. sql_attr_timestamp
12.1.21. sql_attr_float
12.1.22. sql_attr_multi
12.1.23. sql_attr_string
12.1.24. sql_attr_json
12.1.25. sql_column_buffers
12.1.26. sql_field_string
12.1.27. sql_file_field
12.1.28. sql_query_post
12.1.29. sql_query_post_index
12.1.30. sql_ranged_throttle
12.1.31. xmlpipe_command
12.1.32. xmlpipe_field
12.1.33. xmlpipe_field_string
12.1.34. xmlpipe_attr_uint
12.1.35. xmlpipe_attr_bigint
12.1.36. xmlpipe_attr_bool
12.1.37. xmlpipe_attr_timestamp
12.1.38. xmlpipe_attr_float
12.1.39. xmlpipe_attr_multi
12.1.40. xmlpipe_attr_multi_64
12.1.41. xmlpipe_attr_string
12.1.42. xmlpipe_attr_json
12.1.43. xmlpipe_fixup_utf8
12.1.44. mssql_winauth
12.1.45. unpack_zlib
12.1.46. unpack_mysqlcompress
12.1.47. unpack_mysqlcompress_maxsize
12.1.48. csvpipe_delimiter
12.2. Index configuration options
12.2.1. type
12.2.2. source
12.2.3. path
12.2.4. docinfo
12.2.5. mlock
12.2.6. morphology
12.2.7. dict
12.2.8. index_sp
12.2.9. index_zones
12.2.10. min_stemming_len
12.2.11. stopwords
12.2.12. wordforms
12.2.13. embedded_limit
12.2.14. exceptions
12.2.15. min_word_len
12.2.16. charset_table
12.2.17. ign