Sphinx | Open Source Search Server

News

About

Sphinx 2.0.1-beta reference manual
		Next

Copyright © 2001-2011 Andrew Aksyonoff

Copyright © 2008-2011 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. Required tools
2.3. Installing Sphinx on Linux
2.4. Installing Sphinx on Windows
2.5. Known installation issues
2.6. Quick Sphinx usage tour

3. Indexing

3.1. Data sources
3.2. Attributes
3.3. MVA (multi-valued attributes)
3.4. Indexes
3.5. Restrictions on the source data
3.6. Charsets, case folding, and translation tables
3.7. SQL data sources (MySQL, PostgreSQL)
3.8. xmlpipe data source
3.9. xmlpipe2 data source
3.10. Live index updates
3.11. Delta index updates
3.12. 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. Weighting
5.5. Expressions, functions, and operators
5.6. Sorting modes
5.7. Grouping (clustering) search results
5.8. Distributed searching
5.9. searchd query log formats
5.10. MySQL protocol support and SphinxQL
5.11. Multi-queries
5.12. Collations
5.13. User-defined functions (UDF)

6. Command line tools reference

6.1. indexer command reference
6.2. searchd command reference
6.3. search command reference
6.4. spelldump command reference
6.5. indextool command reference

7. SphinxQL reference

7.1. SELECT syntax
7.2. SHOW META syntax
7.3. SHOW WARNINGS syntax
7.4. SHOW STATUS syntax
7.5. INSERT and REPLACE syntax
7.6. DELETE syntax
7.7. SET syntax
7.8. BEGIN, COMMIT, and ROLLBACK syntax
7.9. CALL SNIPPETS syntax
7.10. CALL KEYWORDS syntax
7.11. SHOW TABLES syntax
7.12. DESCRIBE syntax
7.13. CREATE FUNCTION syntax
7.14. DROP FUNCTION syntax
7.15. SHOW VARIABLES syntax
7.16. SHOW COLLATION syntax
7.17. UPDATE syntax
7.18. Multi-statement queries
7.19. Comment syntax
7.20. List of SphinxQL reserved keywords
7.21. SphinxQL upgrade notes, version 2.0.1-beta

8. API reference

8.1. General API functions
8.2. General query settings
8.3. Full-text search query settings
8.4. Result set filtering settings
8.5. GROUP BY settings
8.6. Querying
8.7. Additional functionality
8.8. Persistent connections

9. MySQL storage engine (SphinxSE)

9.1. SphinxSE overview
9.2. Installing SphinxSE
9.3. Using SphinxSE
9.4. Building snippets (excerpts) via MySQL

10. Reporting bugs

11. sphinx.conf options reference

11.1. Data source configuration options
11.2. Index configuration options
11.3. indexer program configuration options
11.4. searchd program configuration options

A. Sphinx revision history

A.1. Version 2.0.1-beta, 22 apr 2011
A.2. Version 1.10-beta, 19 jul 2010
A.3. Version 0.9.9-release, 02 dec 2009
A.4. Version 0.9.9-rc2, 08 apr 2009
A.5. Version 0.9.9-rc1, 17 nov 2008
A.6. Version 0.9.8.1, 30 oct 2008
A.7. Version 0.9.8, 14 jul 2008
A.8. Version 0.9.7, 02 apr 2007
A.9. Version 0.9.7-rc2, 15 dec 2006
A.10. Version 0.9.7-rc1, 26 oct 2006
A.11. Version 0.9.6, 24 jul 2006
A.12. Version 0.9.6-rc1, 26 jun 2006

List of Examples

3.1. Ranged query usage example
3.2. XMLpipe document stream
3.3. xmlpipe2 document stream
3.4. Fully automated live updates
4.1. RT index declaration
5.1. Boolean query example
5.2. Extended matching mode: query example

		Next
		Chapter 1. Introduction