Sphinx 0.9.9 reference manual

Table of Contents

1. Introduction

1.1. About

1.2. Sphinx features

1.3. Where to get Sphinx

1.4. License

1.5. Author and contributors

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. Index merging

4. Searching

4.1. Matching modes

4.2. Boolean query syntax

4.3. Extended query syntax

4.4. Weighting

4.5. Sorting modes

4.6. Grouping (clustering) search results

4.7. Distributed searching

4.8. searchd query log format

4.9. MySQL protocol support and SphinxQL

5. Command line tools reference

5.1. indexer command reference

5.2. searchd command reference

5.3. search command reference

5.4. spelldump command reference

5.5. indextool command reference

6. API reference

6.1. General API functions

6.1.1. GetLastError

6.1.2. GetLastWarning

6.1.3. SetServer

6.1.4. SetRetries

6.1.5. SetConnectTimeout

6.1.6. SetArrayResult

6.1.7. IsConnectError

6.2. General query settings

6.2.1. SetLimits

6.2.2. SetMaxQueryTime

6.2.3. SetOverride

6.2.4. SetSelect

6.3. Full-text search query settings

6.3.1. SetMatchMode

6.3.2. SetRankingMode

6.3.3. SetSortMode

6.3.4. SetWeights

6.3.5. SetFieldWeights

6.3.6. SetIndexWeights

6.4. Result set filtering settings

6.4.1. SetIDRange

6.4.2. SetFilter

6.4.3. SetFilterRange

6.4.4. SetFilterFloatRange

6.4.5. SetGeoAnchor

6.5. GROUP BY settings

6.5.1. SetGroupBy

6.5.2. SetGroupDistinct

6.6. Querying

6.6.1. Query

6.6.2. AddQuery

6.6.3. RunQueries

6.6.4. ResetFilters

6.6.5. ResetGroupBy

6.7. Additional functionality

6.7.1. BuildExcerpts

6.7.2. UpdateAttributes

6.7.3. BuildKeywords

6.7.4. EscapeString

6.7.5. Status

6.8. Persistent connections

6.8.1. Open

6.8.2. Close

7. MySQL storage engine (SphinxSE)

7.1. SphinxSE overview

7.2. Installing SphinxSE

7.2.1. Compiling MySQL 5.0.x with SphinxSE

7.2.2. Compiling MySQL 5.1.x with SphinxSE

7.2.3. Checking SphinxSE installation

7.3. Using SphinxSE

7.4. Building snippets (excerpts) via MySQL

8. Reporting bugs

9. sphinx.conf options reference

9.1. Data source configuration options

9.1.1. type