Sphinx

http://sphinxsearch.com/docs/
Admin
Sphinx is a standalone full-text search engine that provides fast and relevant search functionality...
Tokens:188,970
Snippets:2,403
Trust Score:10
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install Searchd as a Windows Service

Source: http://sphinxsearch.com/docs/sphinx2.html

Use `--install` to register searchd as a Windows service. Other parameters like `--config` can be specified on the same command line to be used when the service starts.

```batch
C:\WINDOWS\system32> C:\Sphinx\bin\searchd.exe --install
   --config C:\Sphinx\sphinx.conf

```

```batch
C:\WINDOWS\system32> C:\Sphinx\bin\searchd.exe --install
   --config C:\Sphinx\sphinx.conf --iostats

```

--------------------------------

### Agent Configuration Examples

Source: http://sphinxsearch.com/docs/sphinx2.html

Practical examples showing sharding across multiple servers and the usage of per-agent options.

```text
# config on box2
# sharding an index over 3 servers
agent = box2:9312:chunk2
agent = box3:9312:chunk3

# config on box2
# sharding an index over 3 servers
agent = box1:9312:chunk2
agent = box3:9312:chunk3

# config on box3
# sharding an index over 3 servers
agent = box1:9312:chunk2
agent = box2:9312:chunk3

# per agent options
agent = box1:9312:chunk1[ha_strategy=nodeads]
agent = box2:9312:chunk2[conn=pconn]
agent = test:9312:any[blackhole=1]
```

--------------------------------

### Build and Install MySQL

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Compiles and installs the MySQL server with the Sphinx engine.

```bash
make
make install
```

--------------------------------

### Starting searchd with statistics enabled

Source: http://sphinxsearch.com/docs/sphinx2.html

Commands to start the daemon with I/O or CPU statistics tracking enabled.

```bash
$ searchd --config /home/myuser/sphinx.conf --iostats
```

```bash
$ searchd --config /home/myuser/sphinx.conf --cpustats
```

--------------------------------

### Install searchd service with custom name

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Installs the service using a specific name for identification in the Management Console.

```cmd
C:\WINDOWS\system32> C:\Sphinx\bin\searchd.exe --install
   --config C:\Sphinx\sphinx.conf --servicename SphinxSearch
```

--------------------------------

### SphinxSE Installation (MySQL Storage Engine)

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Instructions for compiling and installing the SphinxSE storage engine into MySQL 5.x.

```APIDOC
## Compiling MySQL 5.0.x with SphinxSE

### Description
Steps to compile MySQL 5.0.x with SphinxSE support.

### Method
N/A (Shell commands)

### Endpoint
N/A

### Parameters
None

### Steps
1. Copy `sphinx.5.0.yy.diff` patch file into MySQL sources directory and run:
   ```bash
   patch -p1 < sphinx.5.0.yy.diff
   ```
2. In MySQL sources directory, run:
   ```bash
   sh BUILD/autorun.sh
   ```
3. Create `sql/sphinx` directory in MySQL sources and copy files from Sphinx `mysqlse` directory:
   ```bash
   cp -R /path/to/sphinx/mysqlse /path/to/mysql-5.0.xx/sql/sphinx
   ```
4. Configure MySQL with SphinxSE support:
   ```bash
   ./configure --with-sphinx-storage-engine
   ```
5. Build and install MySQL:
   ```bash
   make
   make install
   ```
```

```APIDOC
## Compiling MySQL 5.1.x with SphinxSE

### Description
Steps to compile MySQL 5.1.x with SphinxSE support.

### Method
N/A (Shell commands)

### Endpoint
N/A

### Parameters
None

### Steps
1. Create `storage/sphinx` directory in MySQL sources and copy files from Sphinx `mysqlse` directory:
   ```bash
   cp -R /path/to/sphinx/mysqlse /path/to/mysql-5.1.xx/storage/sphinx
   ```
2. In MySQL sources directory, run:
   ```bash
   sh BUILD/autorun.sh
   ```
3. Configure MySQL with SphinxSE support:
   ```bash
   ./configure --with-plugins=sphinx
   ```
4. Build and install MySQL:
   ```bash
   make
   make install
   ```
```

```APIDOC
## Checking SphinxSE Installation

### Description
Verifies if SphinxSE has been successfully compiled into MySQL.

### Method
N/A (SQL Query)

### Endpoint
N/A

### Parameters
None

### Steps
1. Launch the newly built MySQL server.
2. Connect using the MySQL client.
3. Issue the `SHOW ENGINES` query.

### Expected Output
'SPHINX' should be listed with 'YES' in the 'Support' column.

```sql
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)
```
```

--------------------------------

### UPDATE Examples

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Examples of updating single and multiple attributes, including MVA fields.

```sql
mysql> UPDATE myindex SET enabled=0 WHERE id=123;
Query OK, 1 rows affected (0.00 sec)

mysql> UPDATE myindex
  SET bigattr=-100000000000,
    fattr=3465.23,
    mvattr1=(3,6,4),
    mvattr2=()
  WHERE MATCH('hehe') AND enabled=1;
Query OK, 148 rows affected (0.01 sec)
```

--------------------------------

### Start searchd Server

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Basic command to start the searchd server. It accepts various options to control its behavior.

```bash
$ searchd [OPTIONS]

```

--------------------------------

### SHOW TABLES example

Source: http://sphinxsearch.com/docs/sphinx2.html

Lists all active indexes and their types.

```sql
mysql> SHOW TABLES;
+-------+-------------+
| Index | Type        |
+-------+-------------+
| dist1 | distributed |
| rt    | rt          |
| test1 | local       |
| test2 | local       |
+-------+-------------+
4 rows in set (0.00 sec)
```

--------------------------------

### Faceted search working example

Source: http://sphinxsearch.com/docs/sphinx2.html

A complete example showing a query with multiple FACET clauses and the resulting output sets.

```sql
mysql> SELECT *, IN(brand_id,1,2,3,4) AS b FROM facetdemo WHERE MATCH('Product') AND b=1 LIMIT 0,10
FACET brand_name, brand_id BY brand_id ORDER BY brand_id ASC
FACET property ORDER BY COUNT(*) DESC
FACET INTERVAL(price,200,400,600,800) ORDER BY FACET() ASC
FACET categories ORDER BY FACET() ASC;
+------+-------+----------+-------------------+-------------+----------+------------+------+
| id   | price | brand_id | title             | brand_name  | property | categories | b    |
+------+-------+----------+-------------------+-------------+----------+------------+------+
|    1 |   668 |        3 | Product Four Six  | Brand Three | Three    | 11,12,13   |    1 |
|    2 |   101 |        4 | Product Two Eight | Brand Four  | One      | 12,13,14   |    1 |
|    8 |   750 |        3 | Product Ten Eight | Brand Three | Five     | 13         |    1 |
|    9 |    49 |        1 | Product Ten Two   | Brand One   | Three    | 13,14,15   |    1 |
|   13 |   613 |        1 | Product Six Two   | Brand One   | Eight    | 13         |    1 |
|   20 |   985 |        2 | Product Two Six   | Brand Two   | Nine     | 10         |    1 |
|   22 |   501 |        3 | Product Five Two  | Brand Three | Four     | 12,13,14   |    1 |
|   23 |   765 |        1 | Product Six Seven | Brand One   | Nine     | 11,12      |    1 |
|   28 |   992 |        1 | Product Six Eight | Brand One   | Two      | 12,13      |    1 |
|   29 |   259 |        1 | Product Nine Ten  | Brand One   | Five     | 12,13,14   |    1 |
+------+-------+----------+-------------------+-------------+----------+------------+------+
+-------------+----------+----------+
| brand_name  | brand_id | count(*) |
+-------------+----------+----------+
| Brand One   |        1 |     1012 |
| Brand Two   |        2 |     1025 |
| Brand Three |        3 |      994 |
| Brand Four  |        4 |      973 |
+-------------+----------+----------+
+----------+----------+
| property | count(*) |
+----------+----------+
| One      |      427 |
| Five     |      420 |
| Seven    |      420 |
| Two      |      418 |
| Three    |      407 |
| Six      |      401 |
| Nine     |      396 |
| Eight    |      387 |
| Four     |      371 |
| Ten      |      357 |
+----------+----------+
+---------------------------------+----------+
| interval(price,200,400,600,800) | count(*) |
+---------------------------------+----------+
|                               0 |      799 |
|                               1 |      795 |
|                               2 |      757 |
|                               3 |      833 |
|                               4 |      820 |
+---------------------------------+----------+
+------------+----------+
| categories | count(*) |
+------------+----------+
|         10 |      961 |
|         11 |     1653 |
|         12 |     1998 |
|         13 |     2090 |
|         14 |     1058 |
|         15 |      347 |
+------------+----------+
```

--------------------------------

### DESCRIBE example

Source: http://sphinxsearch.com/docs/sphinx2.html

Displays the fields and their types for a specified index.

```sql
mysql> DESC rt;
+---------+---------+
| Field   | Type    |
+---------+---------+
| id      | integer |
| title   | field   |
| content | field   |
| gid     | integer |
+---------+---------+
4 rows in set (0.00 sec)
```

--------------------------------

### Example: Sharding an Index Over Multiple Servers

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Configuration examples demonstrating how to shard a Sphinx index across multiple remote servers using the 'agent' directive.

```ini
# config on box2
# sharding an index over 3 servers
agent = box2:9312:chunk2
agent = box3:9312:chunk3
```

```ini
# config on box2
# sharding an index over 3 servers
agent = box1:9312:chunk2
agent = box3:9312:chunk3
```

```ini
# config on box3
# sharding an index over 3 servers
agent = box1:9312:chunk2
agent = box2:9312:chunk3
```

--------------------------------

### Configure Sharded Index with Mirrors

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Example configuration for sharding an index across multiple servers with failover mirrors for each chunk. This setup ensures high availability and load distribution.

```ini
# config on box1, box2
agent = box3:9312|box4:9312:chunk2
```

```ini
# config on box3, box4
agent = box1:9312|box2:9312:chunk1
```

--------------------------------

### DELETE Operation Examples

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Examples demonstrating document deletion from an RT index using various filtering conditions.

```sql
mysql> select * from rt;
+------+------+-------------+------+
| id   | gid  | mva1        | mva2 |
+------+------+-------------+------+
|  100 | 1000 | 100,201     | 100  |
|  101 | 1001 | 101,202     | 101  |
|  102 | 1002 | 102,203     | 102  |
|  103 | 1003 | 103,204     | 103  |
|  104 | 1004 | 104,204,205 | 104  |
|  105 | 1005 | 105,206     | 105  |
|  106 | 1006 | 106,207     | 106  |
|  107 | 1007 | 107,208     | 107  |
+------+------+-------------+------+
8 rows in set (0.00 sec)

mysql> delete from rt where match ('dumy') and mva1>206;
Query OK, 2 rows affected (0.00 sec)

mysql> select * from rt;
+------+------+-------------+------+
| id   | gid  | mva1        | mva2 |
+------+------+-------------+------+
|  100 | 1000 | 100,201     | 100  |
|  101 | 1001 | 101,202     | 101  |
|  102 | 1002 | 102,203     | 102  |
|  103 | 1003 | 103,204     | 103  |
|  104 | 1004 | 104,204,205 | 104  |
|  105 | 1005 | 105,206     | 105  |
+------+------+-------------+------+
6 rows in set (0.00 sec)

mysql> delete from rt where id in (100,104,105);
Query OK, 3 rows affected (0.01 sec)

mysql> select * from rt;
+------+------+---------+------+
| id   | gid  | mva1    | mva2 |
+------+------+---------+------+
|  101 | 1001 | 101,202 | 101  |
|  102 | 1002 | 102,203 | 102  |
|  103 | 1003 | 103,204 | 103  |
+------+------+---------+------+
3 rows in set (0.00 sec)

mysql> delete from rt where mva1 in (102,204);
Query OK, 2 rows affected (0.01 sec)

mysql> select * from rt;
+------+------+---------+------+
| id   | gid  | mva1    | mva2 |
+------+------+---------+------+
|  101 | 1001 | 101,202 | 101  |
+------+------+---------+------+
1 row in set (0.00 sec)
```

--------------------------------

### SHOW TABLES LIKE example

Source: http://sphinxsearch.com/docs/sphinx2.html

Lists active indexes that match a given pattern.

```sql
mysql> SHOW TABLES LIKE '%4';
+-------+-------------+
| Index | Type        |
+-------+-------------+
| dist4 | distributed |
+-------+-------------+
1 row in set (0.00 sec)
```

--------------------------------

### ATTACH INDEX Example

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Demonstrates the process of attaching a disk index to an RT index and verifying the schema and data migration.

```sql
mysql> DESC rt;
+-----------+---------+
| Field     | Type    |
+-----------+---------+
| id        | integer |
| testfield | field   |
| testattr  | uint    |
+-----------+---------+
3 rows in set (0.00 sec)

mysql> SELECT * FROM rt;
Empty set (0.00 sec)

mysql> SELECT * FROM disk WHERE MATCH('test');
+------+--------+----------+------------+
| id   | weight | group_id | date_added |
+------+--------+----------+------------+
|    1 |   1304 |        1 | 1313643256 |
|    2 |   1304 |        1 | 1313643256 |
|    3 |   1304 |        1 | 1313643256 |
|    4 |   1304 |        1 | 1313643256 |
+------+--------+----------+------------+
4 rows in set (0.00 sec)

mysql> ATTACH INDEX disk TO RTINDEX rt;
Query OK, 0 rows affected (0.00 sec)

mysql> DESC rt;
+------------+-----------+
| Field      | Type      |
+------------+-----------+
| id         | integer   |
| title      | field     |
| content    | field     |
| group_id   | uint      |
| date_added | timestamp |
+------------+-----------+
5 rows in set (0.00 sec)

mysql> SELECT * FROM rt WHERE MATCH('test');
+------+--------+----------+------------+
| id   | weight | group_id | date_added |
+------+--------+----------+------------+
|    1 |   1304 |        1 | 1313643256 |
|    2 |   1304 |        1 | 1313643256 |
|    3 |   1304 |        1 | 1313643256 |
|    4 |   1304 |        1 | 1313643256 |
+------+--------+----------+------------+
4 rows in set (0.00 sec)

mysql> SELECT * FROM disk WHERE MATCH('test');
ERROR 1064 (42000): no enabled local indexes to search
```

--------------------------------

### Common Subtree Optimization Example

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Example of a query batch where 'barack obama' is identified as a common subtree.

```text
barack obama president
barack obama john mccain
barack obama speech
```

--------------------------------

### Install Sphinx Searchd as a Windows Service

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Use this command to install the Sphinx search daemon as a Windows service. Ensure the paths to searchd and the configuration file are correct for your system.

```bash
C:\Sphinx\bin> C:\Sphinx\bin\searchd --install --config C:\Sphinx\sphinx.conf.in --servicename SphinxSearch
```

--------------------------------

### Configure Sort Options

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Examples of applying sorting modes within the query string.

```sql
... WHERE query='test;sort=attr_asc:group_id';
... WHERE query='test;sort=extended:@weight desc, group_id asc';
```

--------------------------------

### Setting Server Variables

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Examples of modifying per-session and global server variables.

```sql
mysql> SET autocommit=0;
Query OK, 0 rows affected (0.00 sec)

mysql> SET GLOBAL query_log_format=sphinxql;
Query OK, 0 rows affected (0.00 sec)
```

--------------------------------

### Install searchd as a Windows service

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Registers the searchd executable as a Windows service with specific configuration parameters.

```cmd
C:\WINDOWS\system32> C:\Sphinx\bin\searchd.exe --install
   --config C:\Sphinx\sphinx.conf
```

```cmd
C:\WINDOWS\system32> C:\Sphinx\bin\searchd.exe --install
   --config C:\Sphinx\sphinx.conf --iostats
```

--------------------------------

### spelldump Example: With Case Conversion File

Source: http://sphinxsearch.com/docs/sphinx2.html

Example of using spelldump with the -c option to specify a file for case conversion details.

```bash
spelldump -c [file] <dictionary> <affix> [result] [locale-name]
```

--------------------------------

### Verify SphinxSE Installation

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Queries the MySQL server to confirm the Sphinx engine is supported.

```sql
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)
```

--------------------------------

### Phrase Search Operator Example

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Search for the exact phrase 'hello world'.

```sphinxql
"hello world"
```

--------------------------------

### Multi-statement query output example

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Expected output format when running the multi-statement PHP script.

```text
$ php test_multi.php
id=1
id=2
id=3
id=4
------
id=3
id=4
id=1
id=2
```

--------------------------------

### SET TRANSACTION Usage

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Example of executing the SET TRANSACTION statement.

```sql
mysql> SET TRANSACTION ISOLATION LEVEL READ UNCOMMITTED;
Query OK, 0 rows affected (0.00 sec)
```

--------------------------------

### Assign Sources to Index

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Example of assigning multiple sources to an index configuration.

```sphinx
source = srcpart1
source = srcpart2
source = srcpart3
```

--------------------------------

### Example: Agent Declaration with Per-Agent Options

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Illustrates the use of per-agent options such as ha_strategy, conn, and blackhole in the 'agent' directive.

```ini
# per agent options
agent = box1:9312:chunk1[ha_strategy=nodeads]
agent = box2:9312:chunk2[conn=pconn]
agent = test:9312:any[blackhole=1]
```

--------------------------------

### All-Field Search Operator Example

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Search for 'hello' in all available fields.

```sphinxql
@* hello
```

--------------------------------

### Start a Transaction

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Initiates a new transaction, committing any existing pending changes.

```sql
START TRANSACTION | BEGIN
```

--------------------------------

### Plain Log Format Examples

Source: http://sphinxsearch.com/docs/sphinx2.html

Standard query log entries generated by searchd.

```text
[Fri Jun 29 21:17:58 2007] 0.004 sec 0.004 sec [all/0/rel 35254 (0,20)] [lj] test
[Fri Jun 29 21:20:34 2007] 0.024 sec 0.024 sec [all/0/rel 19886 (0,20) @channel_id] [lj] test
```

```text
[query-date] real-time wall-time [match-mode/filters-count/sort-mode
    total-matches (offset,limit) @groupby-attr] [index-name] query
```

```text
[Fri Jun 29 21:17:58 2007] 0.004 sec [all/0/rel 35254 (0,20)] [lj]
   [ios=6 kb=111.1 ms=0.5] test
```

--------------------------------

### Proximity Search Operator Example

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Search for 'hello world' within a proximity of 10 words.

```sphinxql
"hello world"~10
```

--------------------------------

### Keyword expansion example

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Illustrates how keywords are internally expanded when infixing, stemming, and exact word matching are enabled.

```text
running -> ( running | *running* | =running )

```

--------------------------------

### CALL QSUGGEST example with options

Source: http://sphinxsearch.com/docs/sphinx2.html

Demonstrates the CALL QSUGGEST statement with various options like limit, max_edits, result_stats, delta_len, result_line, max_matches, and reject.

```sql
mysql> CALL QSUGGEST('automaticlly ','forum', 5 as limit, 4 as max_edits,1 as result_stats,3 as delta_len,0 as result_line,25 as max_matches,4 as reject );
+---------------+----------+------+
| suggest       | distance | docs |
+---------------+----------+------+
| automatically | 1        | 282  |
| automaticly   | 1        | 6    |
| automaticaly  | 1        | 3    |
| automagically | 2        | 14   |
| automtically  | 2        | 1    |
+---------------+----------+------+
5 rows in set (0.00 sec)
```

--------------------------------

### SetGroupDistinct Usage Example

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Example of configuring grouping and distinct value counting using the Sphinx API.

```php
$cl->SetGroupBy ( "category", SPH_GROUPBY_ATTR, "@count desc" );
$cl->SetGroupDistinct ( "vendor" );
```

--------------------------------

### Batching Queries with AddQuery

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Demonstrates how to queue multiple queries with different settings. Settings applied before AddQuery persist for subsequent calls unless modified.

```php
$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 ();
```

--------------------------------

### List Loaded Plugins with SHOW PLUGINS

Source: http://sphinxsearch.com/docs/sphinx2.html

Displays all loaded plugins and UDFs, including their type, library, current users, and extra information.

```sql
SHOW PLUGINS;

```

--------------------------------

### Set Select Clause Examples

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Examples of using SetSelect to define fields and calculated attributes in Sphinx Search queries.

```php
$cl->SetSelect ( "*, @weight+(user_karma+ln(pageviews))*0.1 AS myweight" );
```

```php
$cl->SetSelect ( "exp_years, salary_gbp*{$gbp_usd_rate} AS salary_usd,
   IF(age>40,1,0) AS over40" );
```

```php
$cl->SetSelect ( "*, AVG(price) AS avgprice" );
```

--------------------------------

### spelldump Example: Basic English Dictionary

Source: http://sphinxsearch.com/docs/sphinx2.html

Example of using spelldump to extract an English dictionary. Requires the dictionary and affix files.

```bash
spelldump en.dict en.aff
```

--------------------------------

### Create a Plugin with CREATE PLUGIN

Source: http://sphinxsearch.com/docs/sphinx2.html

Loads a specified plugin from a library. Known plugin types include ranker, index_token_filter, and query_token_filter.

```sql
CREATE PLUGIN myranker TYPE 'ranker' SONAME 'myplugins.so';

```

--------------------------------

### Example of a Cryptic Crash Backtrace

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

This is an example of a cryptic crash backtrace that lacks function names, making it difficult for developers to debug.

```text
/opt/piler/bin/indexer[0x4c4919]
/opt/piler/bin/indexer[0x405cf0]
/lib/x86_64-linux-gnu/libpthread.so.0(+0xfcb0)[0x7fc659cb6cb0]
/opt/piler/bin/indexer[0x4237fd]
/opt/piler/bin/indexer[0x491de6]
/opt/piler/bin/indexer[0x451704]
/opt/piler/bin/indexer[0x40861a]
/opt/piler/bin/indexer[0x40442c]
/lib/x86_64-linux-gnu/libc.so.6(__libc_start_main+0xed)[0x7fc6588aa76d]
/opt/piler/bin/indexer[0x405b89]

```

--------------------------------

### Example of a Detailed Crash Backtrace

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

This is an example of a useful crash backtrace that includes mangled function names, aiding developers in debugging.

```text
./indexer(_Z12sphBacktraceib+0x2d6)[0x5d337e]
./indexer(_Z7sigsegvi+0xbc)[0x4ce26a]
/lib64/libpthread.so.0[0x3f75a0dd40]
/lib64/libc.so.6(fwrite+0x34)[0x3f74e5f564]
./indexer(_ZN27CSphCharsetDefinitionParser5ParseEPKcR10CSphVectorI14CSphRemapRange16CSphVe
ctorPolicyIS3_EE+0x5b)[0x51701b]
./indexer(_ZN13ISphTokenizer14SetCaseFoldingEPKcR10CSphString+0x62)[0x517e4c]
./indexer(_ZN17CSphTokenizerBase14SetCaseFoldingEPKcR10CSphString+0xbd)[0x518283]
./indexer(_ZN18CSphTokenizer_SBCSILb0EEC1Ev+0x3f)[0x5b312b]
./indexer(_Z22sphCreateSBCSTokenizerv+0x20)[0x51835c]
./indexer(_ZN13ISphTokenizer6CreateERK21CSphTokenizerSettingsPK17CSphEmbeddedFilesR10CSphS
tring+0x47)[0x5183d7]
./indexer(_Z7DoIndexRK17CSphConfigSectionPKcRK17SmallStringHash_TIS_EbP8_IO_FILE+0x494)[0x
4d31c8]
./indexer(main+0x1a17)[0x4d6719]
/lib64/libc.so.6(__libc_start_main+0xf4)[0x3f74e1d8a4]
./indexer(__gxx_personality_v0+0x231)[0x4cd779]

```

--------------------------------

### spelldump Example: Russian Dictionary with Specific Encoding

Source: http://sphinxsearch.com/docs/sphinx2.html

Example of using spelldump for a Russian dictionary, specifying an output file and a specific encoding for the output.

```bash
spelldump ru.dict ru.aff ru.txt .1251
```

--------------------------------

### spelldump Example: Russian Dictionary with Output and Locale

Source: http://sphinxsearch.com/docs/sphinx2.html

Example of using spelldump for a Russian dictionary, specifying an output file and locale for character encoding.

```bash
spelldump ru.dict ru.aff ru.txt ru_RU.CP1251
```

--------------------------------

### Execute QSUGGEST query

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Retrieves dictionary suggestions for a given word on indexes with infixing enabled and dict=keywords.

```sql
CALL QSUGGEST(word, index [,options])
```

```sql
mysql> CALL QSUGGEST('automaticlly ','forum', 5 as limit, 4 as max_edits,1 as result_stats,3 as delta_len,0 as result_line,25 as max_matches,4 as reject );
+---------------+----------+------+
| suggest       | distance | docs |
+---------------+----------+------+
| automatically | 1        | 282  |
| automaticly   | 1        | 6    |
| automaticaly  | 1        | 3    |
| automagically | 2        | 14   |
| automtically  | 2        | 1    |
+---------------+----------+------+
5 rows in set (0.00 sec)
```

--------------------------------

### Working example of FACET clause

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

This example demonstrates a practical application of the FACET clause with multiple facet definitions, including interval-based faceting and ordering by count.

```sql
mysql> SELECT *, IN(brand_id,1,2,3,4) AS b FROM facetdemo WHERE MATCH('Product') AND b=1 LIMIT 0,10
FACET brand_name, brand_id BY brand_id ORDER BY brand_id ASC
FACET property ORDER BY COUNT(*) DESC
FACET INTERVAL(price,200,400,600,800) ORDER BY FACET() ASC
FACET categories ORDER BY FACET() ASC;
```

--------------------------------

### Using Aggregate Functions and GROUP BY

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Demonstrates the use of aggregate functions like AVG() and COUNT(DISTINCT), along with GROUPBY() to retrieve group keys. Supports plain attributes or expressions as arguments.

```sql
SELECT *, AVG(price) AS avgprice, COUNT(DISTINCT storeid), GROUPBY()
FROM products
WHERE MATCH('ipod')
GROUP BY vendorid

```

--------------------------------

### TSV Data Format Example

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Example of data in a TSV file. The first column is the document ID, followed by fields and attributes mirroring the schema declaration.

```text
1	Led Zeppelin	35,23,16
2	Deep Purple	35,92
3	Frank Zappa	35,23,16,92,33,24
```

--------------------------------

### List Available Databases with SHOW DATABASES

Source: http://sphinxsearch.com/docs/sphinx2.html

SHOW DATABASES is a dummy statement to support MySQL compatibility. It currently performs no action.

```sql
SHOW DATABASES

```

--------------------------------

### Extended Matching Mode Query Example

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

A comprehensive example query demonstrating multiple extended syntax operators including phrase search, field search with proximity, field-specific terms, negation, and all-field search.

```sphinxql
"hello world" @title "example program"~5 @body python -(php|perl) @* code
```

--------------------------------

### Populate Test Data

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Import sample SQL data into the MySQL test database.

```bash
$ mysql -u test < /usr/local/sphinx/etc/example.sql
```

--------------------------------

### Execute Multi-query in PHP

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Demonstrates using AddQuery and RunQueries to execute the same search with different sorting modes in one batch.

```php
require ( "sphinxapi.php" );
$cl = new SphinxClient ();
$cl->SetMatchMode ( SPH_MATCH_EXTENDED );

$cl->SetSortMode ( SPH_SORT_RELEVANCE );
$cl->AddQuery ( "the", "lj" );
$cl->SetSortMode ( SPH_SORT_EXTENDED, "published desc" );
$cl->AddQuery ( "the", "lj" );
$cl->SetSortMode ( SPH_SORT_EXTENDED, "published asc" );
$cl->AddQuery ( "the", "lj" );
$res = $cl->RunQueries();
```

--------------------------------

### Execute SUGGEST query

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Similar to QSUGGEST, but processes only the first word if a bag of words is provided.

```sql
CALL SUGGEST(word, index [,options])
```

--------------------------------

### Configure index pre-opening

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Enables pre-opening of index files on startup to save per-query open calls.

```text
preopen = 1
```

--------------------------------

### SHOW PLUGINS

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Displays all currently loaded plugins and UDFs.

```APIDOC
## SHOW PLUGINS

### Description
Displays all loaded plugins and UDFs, including their type, library, current user count, and extra information.

### Method
SQL

### Endpoint
SHOW PLUGINS

### Response
#### Success Response (200)
- **Type** (string) - Plugin type (udf, ranker, index_token_filter, query_token_filter)
- **Name** (string) - Name of the plugin
- **Library** (string) - Library file name
- **Users** (integer) - Number of threads currently using the plugin
- **Extra** (string) - Additional plugin-specific information
```

--------------------------------

### Query Sphinx via MySQL CLI

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Example of connecting to the Sphinx searchd daemon using the standard MySQL command-line client.

```bash
$ mysql -P 9306
Welcome to the MySQL monitor.  Commands end with ; or \g.
Your MySQL connection id is 1
Server version: 0.9.9-dev (r1734)

Type 'help;' or '\h' for help. Type '\c' to clear the buffer.

mysql> SELECT * FROM test1 WHERE MATCH('test')
    -> ORDER BY group_id ASC OPTION ranker=bm25;
+------+--------+----------+------------+
| id   | weight | group_id | date_added |
+------+--------+----------+------------+
|    4 |   1442 |        2 | 1231721236 |
|    2 |   2421 |      123 | 1231721236 |
|    1 |   2421 |      456 | 1231721236 |
+------+--------+----------+------------+
3 rows in set (0.00 sec)
```

--------------------------------

### Example of spelldump output

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

The format of the generated wordforms file produced by spelldump.

```text
zone > zone
zoned > zoned
zoning > zoning
```

--------------------------------

### Show Loaded Plugins

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Displays all currently loaded plugins and UDFs with their usage statistics.

```sql
SHOW PLUGINS
```

```sql
mysql> SHOW PLUGINS;
+------+----------+----------------+-------+-------+
| Type | Name     | Library        | Users | Extra |
+------+----------+----------------+-------+-------+
| udf  | sequence | udfexample.dll | 0     | INT   |
+------+----------+----------------+-------+-------+
1 row in set (0.00 sec)
```

--------------------------------

### Combine Boolean operators

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Example of a complex boolean query using OR, NOT, and grouping.

```text
( cat -dog ) | ( cat -mouse)
```

--------------------------------

### CALL QSUGGEST statement syntax

Source: http://sphinxsearch.com/docs/sphinx2.html

Enumerates suggestions for a given word from the dictionary. Works on indexes with infixing enabled and dict=keywords. Returns suggested keywords, Levenshtein distance, and document statistics.

```sql
CALL QSUGGEST(word, index [,options])
```

--------------------------------

### Run MySQL Autorun

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Initializes the build environment in the MySQL source directory.

```bash
sh BUILD/autorun.sh
```

--------------------------------

### Invoke UDF in SphinxQL

Source: http://sphinxsearch.com/docs/sphinx2.html

Examples of using custom UDFs within SQL-like queries.

```sql
SELECT id, attr1, myudf(attr2, attr3+attr4) ...
```

```sql
SELECT id, MYCUSTOMFUNC(groupid, authorname), ... FROM myindex
```

--------------------------------

### Run Indexer

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Execute the indexer to process all configured data sources.

```bash
$ cd /usr/local/sphinx/etc
 $ /usr/local/sphinx/bin/indexer --all
```

--------------------------------

### Configure rlp_context

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Sets the path to the RLP context configuration file, which is mandatory when using RLP.

```text
rlp_context = /home/myuser/RLP/rlp-context.xml
```

--------------------------------

### Zone Limit Operator Example

Source: http://sphinxsearch.com/docs/sphinx2.html

Restricts matching to specific zones within a document.

```text
<th>Table 1. Local awareness of Hello Kitty brand.</th>
.. some table data goes here ..
<th>Table 2. World-wide brand awareness.</th>
```

--------------------------------

### CREATE FUNCTION Syntax

Source: http://sphinxsearch.com/docs/sphinx2.html

Installs a user-defined function (UDF) with the given name and type from the given library file. The library file must reside in a trusted plugin_dir directory.

```APIDOC
## CREATE FUNCTION Syntax

### Description
Installs a user-defined function (UDF) with the given name and type from the given library file. The library file must reside in a trusted plugin_dir directory.

### Method
CREATE FUNCTION

### Endpoint
N/A (SQL Statement)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```sql
CREATE FUNCTION avgmva RETURNS INTEGER SONAME 'udfexample.dll';
```

### Response
#### Success Response (0 rows affected)
- **Query OK**: Indicates the function was successfully created.

#### Response Example
```
Query OK, 0 rows affected (0.03 sec)
```
```

--------------------------------

### Specify Search Indexes

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Examples of defining which indexes to search within the query string.

```sql
... WHERE query='test;index=test1;';
... WHERE query='test;index=test1,test2,test3;';
```

--------------------------------

### SELECT @@system_variable

Source: http://sphinxsearch.com/docs/sphinx2.html

Placeholder query for compatibility with frameworks and connectors.

```APIDOC
## SELECT @@system_variable

### Description
A placeholder query that reports success to maintain compatibility with external frameworks.

### Request Example
SELECT @@system_variable LIMIT 0, 10
```

--------------------------------

### ALTER TABLE Operations

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Examples of describing an index and performing add/drop column operations.

```sql
mysql> desc plain;
+------------+-----------+
| Field      | Type      |
+------------+-----------+
| id         | bigint    |
| text       | field     |
| group_id   | uint      |
| date_added | timestamp |
+------------+-----------+
4 rows in set (0.01 sec)

mysql> alter table plain add column test integer;
Query OK, 0 rows affected (0.04 sec)

mysql> desc plain;
+------------+-----------+
| Field      | Type      |
+------------+-----------+
| id         | bigint    |
| text       | field     |
| group_id   | uint      |
| date_added | timestamp |
| test       | uint      |
+------------+-----------+
5 rows in set (0.00 sec)

mysql> alter table plain drop column group_id;
Query OK, 0 rows affected (0.01 sec)

mysql> desc plain;
+------------+-----------+
| Field      | Type      |
+------------+-----------+
| id         | bigint    |
| text       | field     |
| date_added | timestamp |
| test       | uint      |
+------------+-----------+
4 rows in set (0.00 sec)
```

--------------------------------

### Load and Use a Plugin in Sphinx

Source: http://sphinxsearch.com/docs/manual-2.3.2.html

Commands to register a plugin with the search daemon and invoke it within a SQL query.

```sql
mysql> CREATE PLUGIN myrank TYPE 'ranker' SONAME 'myrank.dll';
Query OK, 0 rows affected (0.00 sec)

mysql> SELECT id, weight() FROM test1 WHERE MATCH('test')
    -> OPTION ranker=myrank('');
+------+----------+
| id   | weight() |
+------+----------+
|    1 |      123 |
|    2 |      123 |
+------+----------+
2 rows in set (0.01 sec)
```

--------------------------------

### SphinxSE MySQL Integration

Source: http://sphinxsearch.com/docs/sphinx2.html

Overview and installation procedures for the SphinxSE storage engine for MySQL 5.x.

```APIDOC
## SphinxSE Overview

### Description
SphinxSE is a MySQL storage engine that acts as a built-in client for the `searchd` daemon. It enables MySQL to execute search queries and retrieve results without storing data itself.

## Checking SphinxSE Installation

### Description
Verify that the SphinxSE engine is correctly compiled and enabled in the MySQL server.

### Query
SHOW ENGINES;

### Success Response
- **Engine** (string) - Should list 'SPHINX'
- **Support** (string) - Should contain 'YES'
```
Tokens:
Raw