Query Builder for SphinxQL

+ +

About

+ +

This is a PHP Query Builder created ad-hoc to work with SphinxQL, an SQL dialect to use with the Sphinx search engine. +It maps every function listed in the SphinxQL reference and is generally faster than the Sphinx API, beside having more functions.

+ +

This Query Builder has no dependencies except PHP 5.3, \MySQLi and of course a working Sphinx server. FuelPHP is not necessary but we've added a bootstrap for using it as a Package. It is styled after FuelPHP's Query Builder.

+ +

This package is BETA QUALITY. Don't rely on it in production unless you tested it massively in development.

+ +

Code Quality

+ +

Most of the methods in the package are unit tested. Methods that haven't been tested are single queries like flushRtIndex, but as they are independent they are supposed to work.

+ +

We test on Travis-CI with the SVN build of Sphinx:

+ +

Usage

+ +

The examples will omit the namespace.

+ +

use Foolz\Sphinxql\Sphinxql as Sphinxql;
+
+// if you don't use the Sphinxql default connection, use this function to change the host and port
+Sphinxql::addConnection('superspecial', 'yourhost.com', 9231);
+Sphinxql::setConnection('superspecial');
+
+$query = Sphinxql::select('column_one', 'column_two')
+    ->from('index_delta', 'index_main', 'index_ancient')
+    ->match('comment', 'my opinion is better')
+    ->where('banned', '=', 1);
+
+$result = $query->execute();
+

+ +

General

+ +

The static connection manager lets you handle multiple connections.

+ +

There's the default connection, that connects to 127.0.0.1:9306 as per SphinxQL defaults.

+ +

+
Sphinxql::silenceConnectionWarning($enable = true)
+ +
Use it when you have warning display enabled in PHP, but you don't want to see errors when MySQLi fails connecting to the server. Custom errors are in place. (This is actually the so-evil @ silencing. Use it if you know what are you doing.)
+ +
Disabled by default.
+
+
Sphinxql::addConnection($name = 'default', $host = '127.0.0.1', $port = 9306)
+ +
Use it to add connection to the array of available connections.
+
+
Sphinxql::setConnection($name)
+ +
Set the connection to be used for the next operations. Remember that the class always starts with default set.
+
+
Sphinxql::getConnectionInfo($name = null)
+ +
Get info (host, port) on the connection. When name is not specified it gives info on the currently selected connection.
+
+
Sphinxql::connect()
+ +
Throws \Foolz\Sphinxql\SphinxqlConnectionException
+ +
Enstablish the connection to the server.
+
+
Sphinxql::getConnection()
+ +
Throws \Foolz\Sphinxql\SphinxqlConnectionException
+ +
Returns the \MySQLi object of the currently selected connection, an exception if not available.
+
+
Sphinxql::query($query)
+ +
Runs the query. Returns an array of results on SELECT, or an array with the number of affected rows (Sphinx doesn't support last-insert-id, so this values for INSERT too).
+

Getting around escaping

+ +

Often you need to run SQL functions, but those would get escaped as other values or identifiers. You can ignore the escaping by wrapping the query in a SphinxqlExpression.

+ +

+
Sphinxql::expr($string)
+ +
Disables escaping for the string.
+

Executing and Compiling

+ +

+
$sq->execute()
+ +
Compiles the query, executes it, and returns the array of results.
+
+
$sq->compile()
+ +
Compiles the query.
+
+
$sq->getCompiled()
+ +
Returns the last compiled query.
+
+
$sq->getCompiled()
+ +
Returns the last result.
+

Select

+ +

+
$sq = Sphinxql::select($column1, $column2, $column3)->from($index1, $index2, $index3)
+ +
Starts a SELECT. $columns1 can be an array. If no column is specified it defaults to *. $index1 can be an array.
+

The options for the select follow.

+ +

Where

+ +

$sq->where($column, $operator, $value)

+ +

Classic WHERE, works with Sphinx filters and fulltext.

+ +

$sq->where('column', 'value');
+// WHERE `column` = 'value'
+
+$sq->where('column', '=', 'value');
+// WHERE `column` = 'value'
+
+$sq->where('column', '>=', 'value')
+// WHERE `column` >= 'value'
+
+$sq->where('column', 'IN', array('value1', 'value2', 'value3'));
+// WHERE `column` IN ('value1', 'value2', 'value3')
+
+$sq->where('column', 'BETWEEN', array('value1', 'value2'))
+// WHERE `column` BETWEEN 'value1' AND 'value2'
+// WHERE `example` BETWEEN 10 AND 100
+

+ +

While implemented in the package, OR and parenthesis are not yet implemented in SphinxQL.

Match

+ +

+
$sq->match($column, $value, $half = false)
+ +
Search in full-text fields. Can be used multiple times in the same query.
+ +
```
$sq->match('title', 'Otoshimono')
+    ->match('character', 'Nymph');
+
```
+ +
The characters are fully escaped. You will need to use Sphinxql::expr($value) to use your own options.
+ +
The $half, if turned to true, will allow the following characters: -, |, ". You will have to wrap the query in a try if you use this feature and expose it to public interfaces, because character order might throw a query error.
+ +
```
try
+{
+    $result Sphinxql::select()
+        ->from('rt')
+        ->match('title', 'Sora no || Otoshimono')
+        ->execute();
+}
+catch (\Foolz\Sphinxql\SphinxqlDatabaseException $e)
+{
+    // it will get here because two `|` one after the other aren't allowed
+}
+
```
+

Grouping, ordering etc.

+ +

+
$sq->groupBy($column)
+ +
GROUP BY $column
+
+
$sq->withinGroupOrderBy($column, $direction = null)
+ +
WITHIN GROUP ORDER BY $column [$direction]
+ +
Direction can be omitted with null, or be asc or desc case insensitive.
+
+
$sq->orderBy($column, $direction = null)
+ +
ORDER BY $column [$direction]
+ +
Direction can be omitted with null, or be asc or desc case insensitive.
+
+
$sq->offset($offset)
+ +
LIMIT $offset, 9999999999999
+ +
Set the offset. The LIMIT is set to a high number because SphinxQL doesn't support the OFFSET keyword.
+
+
$sq->limit($limit)
+ +
LIMIT $limit
+
+
$sq->limit($offset, $limit)
+ +
LIMIT $offset, $limit
+
+
$sq->option($name, $value)
+ +
OPTION $name = $value
+ +
Set a SphinxQL option like max_matches or reverse_scan for this query only.
+

Insert and Replace

+ +

Will return an array with an INT as first member, the number of rows inserted/replaced.

+ +

+
$sq = Sphinxql::insert()->into($index)
+ +
Begins an INSERT.
+
+
$sq = Sphinxql::replace()->into($index)
+ +
Begins an REPLACE.
+
+
$sq->set($associative_array)
+ +
Inserts the associative array, where the keys are the columns and the respective values are the column values.
+
+
$sq->value($column1, $value1)->value($column2, $value2)->value($column3, $value3)
+ +
Sets columns one by one
+
+
$sq->columns($column1, $column2, $column3)->values($value1, $value2, $value3)->values($value11, $value22, $value33)
+ +
Allows inserting multiple arrays of values in the specified columns.
+ +
$column1 and $value1 can be arrays.
+

Update

+ +

Will return an array with an INT as first member, the number of rows updated.

+ +

+
$sq = Sphinxql::update($index)
+ +
Begins an UPDATE.
+
+
$sq->value($column1, $value1)->value($column2, $value2)
+ +
Updates the selected columns with the respective value.
+
+
$sq->set($associative_array)
+ +
Inserts the associative array, where the keys are the columns and the respective values are the column values.
+

The WHERE part of the query works just as for SELECT.

+ +

Delete

+ +

Will return an array with an INT as first member, the number of rows deleted.

+ +

+
$sq = Sphinxql::delete()->from($column)
+ +
Begins a DELETE.
+

The WHERE part of the query works just as for SELECT.

+ +

Transactions

+ +

+
Sphinxql::transactionBegin()
+ +
Begins a transaction.
+
+
Sphinxql::transactionCommit()
+ +
Commits a transaction.
+
+
Sphinxql::transactionRollback()
+ +
Rollbacks a transaction.
+

Escaping

+ +

+
$sq->escape($value)
+ +
Returns the escaped value, processed with \MySQLi::real_escape_string.
+
+
$sq->quoteIdentifier($identifier)
+ +
Adds oblique quotes to identifiers. To run this on array elements use $sq->quoteIdentifierArr($arr).
+
+
$sq->quote($value)
+ +
Adds quotes to values and escapes. To run this on array elements use $sq->quoteArr($arr).
+
+
$sq->escapeMatch($value)
+ +
Escapes the string for use in a MATCH.
+
+
$sq->halfEscapeMatch($value)
+ +
Escapes the string for use in a MATCH. Allows -, |, ". Read about this on the $sq->match() explanation.
+

Show

+ +

Sphinxql::meta() => 'SHOW META'
+Sphinxql::warnings() => 'SHOW WARNINGS'
+Sphinxql::status() => 'SHOW STATUS'
+Sphinxql::tables() => 'SHOW TABLES'
+Sphinxql::variables() => 'SHOW VARIABLES'
+Sphinxql::variablesSession() => 'SHOW SESSION VARIABLES'
+Sphinxql::variablesGlobal() => 'SHOW GLOBAL VARIABLES'
+

+ +

Set variable

+ +

+
Sphinxql::setVariable($name, $value, $global = false)
+ +
Set a server variable.
+

+ +

There's several more functions to complete the SphinxQL library:

+ +

Sphinxql::callSnippets($data, $index, $extra = array())
Sphinxql::callKeywords($text, $index, $hits = null)
Sphinxql::describe($index)
Sphinxql::createFunction($udf_name, $returns, $soname)
Sphinxql::dropFunction($udf_name)
Sphinxql::attachIndex($disk_index, $rt_index)
Sphinxql::flushRtIndex($index)

Query Builder for SphinxQL

+Query Builder for SphinxQL

About

+About

This is a PHP Query Builder created ad-hoc to work with SphinxQL, an SQL dialect to use with the Sphinx search engine. -It maps every function listed in the SphinxQL reference and is generally faster than the Sphinx API, beside having more functions.

This is a SphinxQL Query Builder used to work with SphinxQL, a SQL dialect used with the Sphinx search engine. It maps most of the functions listed in the SphinxQL reference and is generally faster than the available Sphinx API.

This Query Builder has no dependencies besides PHP 5.3, \MySQLi extension, and Sphinx.

This package is BETA QUALITY. Don't rely on it in production unless you tested it massively in development.

This package is BETA QUALITY. It is recommended that you do extensive testing in development before using it in a production environment.

Code Quality

+Missing methods?

Most of the methods in the package are unit tested. Methods that haven't been tested are single queries like flushRtIndex, but as they are independent they are supposed to work.

SphinxQL evolves very fast.

We test on Travis-CI with the SVN build of Sphinx:

Most of the new functions are static one liners like SHOW PLUGINS. We'll avoid trying to keep up with these methods, as they are easy to just call directly. You're free to submit pull requests to support these methods.

If any feature is unreachable through this library, open a new issue or send a pull request.

Usage

+Code Quality

The examples will omit the namespace.

The majority of the methods in the package have been unit tested. The only methods that have not been tested are single queries such as flushRtIndex, but these are independent and should work fine.

use Foolz\Sphinxql\Sphinxql as Sphinxql;
+We have tested our package locally and remotely with Travis-CI:
 
-// if you don't use the Sphinxql default connection, use this function to change the host and port
-Sphinxql::addConnection('superspecial', 'yourhost.com', 9231);
-Sphinxql::setConnection('superspecial');
+
 
-$query = Sphinxql::select('column_one', 'column_two')
-    ->from('index_delta', 'index_main', 'index_ancient')
-    ->match('comment', 'my opinion is better')
-    ->where('banned', '=', 1);
+
+How to Contribute
 
-$result = $query->execute();
-

+Pull Requests

General

Fork the SphinxQL Query Builder repository
Create a new branch for each feature or improvement
Submit a pull request from each branch to the dev branch

It is very important to separate new features or improvements into separate feature branches, and to send a pull +request for each branch. This allows me to review and pull in new features or improvements individually.

The static connection manager lets you handle multiple connections.

+Style Guide

There's the default connection, that connects to 127.0.0.1:9306 as per SphinxQL defaults.

All pull requests must adhere to the PSR-2 standard.

+ +

+Unit Testing

+ +

All pull requests must be accompanied by passing unit tests and complete code coverage. The SphinxQL Query Builder uses +phpunit for testing.

+ +

Learn about PHPUnit

+ +

+Installation

+ +

This is a Composer package. You can install this package with the following command: php composer.phar install

+ +

+Usage

+ +

The following examples will omit the namespace.

+ +

<?php
+use Foolz\SphinxQL\SphinxQL;
+use Foolz\SphinxQL\Connection;
+
+// create a SphinxQL Connection object to use with SphinxQL
+$conn = new Connection();
+$conn->setConnectionParams('domain.tld', 9306);
+
+$query = SphinxQL::create($conn)->select('column_one', 'colume_two')
+    ->from('index_delta', 'index_main', 'index_ancient')
+    ->match('comment', 'my opinion is superior to yours')
+    ->where('banned', '=', 1);
+
+$result = $query->execute();
+

+ +

+Connection

-
Sphinxql::silenceConnectionWarning($enable = true)
+
$conn = new Connection()
+ +
Create a new Connection instance to be used with the following methods or SphinxQL class.
+
+
$conn->silenceConnectionWarning($enable = true)
+ +
Suppresses any warnings and errors displayed by the \MySQLi extension upon connection failure. +This is disabled by default.
+
+
$conn->setConnectionParams($host = '127.0.0.1', $port = 9306)
-
Use it when you have warning display enabled in PHP, but you don't want to see errors when MySQLi fails connecting to the server. Custom errors are in place. (This is actually the so-evil @ silencing. Use it if you know what are you doing.)
+
Sets the connection parameters used to establish a connection to the server.
+
+
$conn->query($query)
-
Disabled by default.
+
Performs the query on the server. Returns an array of results for SELECT, or an int with the number of rows affected.

More methods are available in the Connection class, but usually not necessary as these are handled automatically.

+ +

+SphinxQL

+ +

+
SphinxQL::create($conn)
+ +
Creates a SphinxQL instance used for generating queries.
+

+Bypass Query Escaping

+ +

Often, you would need to call and run SQL functions that shouldn't be escaped in the query. You can bypass the query escape by wrapping the query in an \Expression.

+ +

-
Sphinxql::addConnection($name = 'default', $host = '127.0.0.1', $port = 9306)
+
SphinxQL::expr($string)
-
Use it to add connection to the array of available connections.
+
Returns the string without being escaped.

+Query Escaping

+ +

There are cases when an input must be escaped in the SQL statement. The following functions are used to handle any escaping required for the query.

+ +

-
Sphinxql::setConnection($name)
+
$sq->escape($value)
-
Set the connection to be used for the next operations. Remember that the class always starts with default set.
+
Returns the escaped value. This is processed with the \MySQLi::real_escape_string() function.
-
Sphinxql::getConnectionInfo($name = null)
+
$sq->quoteIdentifier($identifier)
-
Get info (host, port) on the connection. When name is not specified it gives info on the currently selected connection.
+
Adds backtick quotes to the identifier. For array elements, use $sq->quoteIdentifierArray($arr).
-
Sphinxql::connect()
+
$sq->quote($value)
-
Throws \Foolz\Sphinxql\SphinxqlConnectionException
+
Adds quotes to the value and escapes it. For array elements, use $sq->quoteArr($arr).
+
+
$sq->escapeMatch($value)
-
Enstablish the connection to the server.
+
Escapes the string to be used in MATCH.
-
Sphinxql::getConnection()
+
$sq->halfEscapeMatch($value)
-
Throws \Foolz\Sphinxql\SphinxqlConnectionException
+
Escapes the string to be used in MATCH. The following characters are allowed: -, |, and ".
-
Returns the \MySQLi object of the currently selected connection, an exception if not available.
+
Refer to $sq->match() for more information.

+SET VARIABLE

+ +

-
Sphinxql::query($query)
+
SphinxQL::create($conn)->setVariable($name, $value, $global = false)
-
Runs the query. Returns an array of results on SELECT, or an array with the number of affected rows (Sphinx doesn't support last-insert-id, so this values for INSERT too).
+
Sets a variable server-side.

Getting around escaping

+SHOW

Often you need to run SQL functions, but those would get escaped as other values or identifiers. You can ignore the escaping by wrapping the query in a SphinxqlExpression.

SphinxQL::create($conn)->meta() => 'SHOW META'
SphinxQL::create($conn)->warnings() => 'SHOW WARNINGS'
SphinxQL::create($conn)->status() => 'SHOW STATUS'
SphinxQL::create($conn)->tables() => 'SHOW TABLES'
SphinxQL::create($conn)->variables() => 'SHOW VARIABLES'
SphinxQL::create($conn)->variablesSession() => 'SHOW SESSION VARIABLES'
SphinxQL::create($conn)->variablesGlobal() => 'SHOW GLOBAL VARIABLES'

+SELECT

-
Sphinxql::expr($string)
+
$sq = SphinxQL::create($conn)->select($column1, $column2, ...)->from($index1, $index2, ...)
-
Disables escaping for the string.
+
Begins a SELECT query statement. If no column is specified, the statement defaults to using *. Both $column1 and $index1 can be arrays.

Executing and Compiling

+INSERT, REPLACE

+ +

This will return an INT with the number of rows affected.

-
$sq->execute()
+
$sq = SphinxQL::create($conn)->insert()->into($index)
-
Compiles the query, executes it, and returns the array of results.
+
Begins an INSERT.
-
$sq->compile()
+
$sq = SphinxQL::create($conn)->replace()->into($index)
-
Compiles the query.
+
Begins an REPLACE.
-
$sq->getCompiled()
+
$sq->set($associative_array)
-
Returns the last compiled query.
+
Inserts an associative array, with the keys as the columns and values as the value for the respective column.
-
$sq->getResult()
+
$sq->value($column1, $value1)->value($column2, $value2)->value($column3, $value3)
-
Returns the last result.
+
Sets the value of each column individually.
+
+
$sq->columns($column1, $column2, $column3)->values($value1, $value2, $value3)->values($value11, $value22, $value33)
+ +
Allows the insertion of multiple arrays of values in the specified columns.
+ +
Both $column1 and $index1 can be arrays.

Select

+UPDATE

+ +

This will return an INT with the number of rows affected.

-
$sq = Sphinxql::select($column1, $column2, $column3)->from($index1, $index2, $index3)
+
$sq = SphinxQL::create($conn)->update($index)
+ +
Begins an UPDATE.
+
+
$sq->value($column1, $value1)->value($column2, $value2)
-
Starts a SELECT. $columns1 can be an array. If no column is specified it defaults to *. $index1 can be an array.
+
Updates the selected columns with the respective value.

The options for the select follow.

$sq->set($associative_array)

+ +

Inserts the associative array, where the keys are the columns and the respective values are the column values.

+DELETE

+ +

Will return an array with an INT as first member, the number of rows deleted.

Where

+
$sq = SphinxQL::create($conn)->delete()->from($column)
+ +
Begins a DELETE.
+

+WHERE

$sq->where($column, $operator, $value)

$sq->where($column, $operator, $value)

Classic WHERE, works with Sphinx filters and fulltext.

Standard WHERE, extended to work with Sphinx filters and full-text.

$sq->where('column', 'value');
-// WHERE `column` = 'value'
+<?php
+// WHERE `column` = 'value'
+$sq->where('column', 'value');
 
-$sq->where('column', '=', 'value');
-// WHERE `column` = 'value'
+// WHERE `column` = 'value'
+$sq->where('column', '=', 'value');
 
-$sq->where('column', '>=', 'value')
-// WHERE `column` >= 'value'
+// WHERE `column` >= 'value'
+$sq->where('column', '>=', 'value')
 
-$sq->where('column', 'IN', array('value1', 'value2', 'value3'));
-// WHERE `column` IN ('value1', 'value2', 'value3')
+// WHERE `column` IN ('value1', 'value2', 'value3')
+$sq->where('column', 'IN', array('value1', 'value2', 'value3'));
 
-$sq->where('column', 'BETWEEN', array('value1', 'value2'))
-// WHERE `column` BETWEEN 'value1' AND 'value2'
-// WHERE `example` BETWEEN 10 AND 100
-
+// WHERE `column` BETWEEN 'value1' AND 'value2'
+// WHERE `example` BETWEEN 10 AND 100
+$sq->where('column', 'BETWEEN', array('value1', 'value2'))
+

While implemented in the package, OR and parenthesis are not yet implemented in SphinxQL.

It should be noted that OR and parenthesis are not supported and implemented in the SphinxQL dialect yet.

Match

+MATCH

$sq->match($column, $value, $half = false)
-
Search in full-text fields. Can be used multiple times in the same query.
+
Search in full-text fields. Can be used multiple times in the same query. Column can be an array. Value can be an Expression to bypass escaping (and use your own custom solution).
-
```
$sq->match('title', 'Otoshimono')
-    ->match('character', 'Nymph');
-
```
+
```
<?php
+$sq->match('title', 'Otoshimono')
+    ->match('character', 'Nymph')
+    ->match(array('hates', 'despises'), 'Oregano');
+
```
-
The characters are fully escaped. You will need to use Sphinxql::expr($value) to use your own options.
+
By default, all inputs are fully escaped. The usage of SphinxQL::expr($value) is required to bypass the statement escapes.
-
The $half, if turned to true, will allow the following characters: -, |, ". You will have to wrap the query in a try if you use this feature and expose it to public interfaces, because character order might throw a query error.
+
The $half argument, if set to true, will not escape and allow the usage of the following characters: -, |, ". If you plan to use this feature and expose it to public interfaces, it is recommended that you wrap the query in a try catch block as the character order may throw a query error.
-
```
try
-{
-    $result Sphinxql::select()
-        ->from('rt')
-        ->match('title', 'Sora no || Otoshimono')
-        ->execute();
-}
-catch (\Foolz\Sphinxql\SphinxqlDatabaseException $e)
-{
-    // it will get here because two `|` one after the other aren't allowed
-}
-
```
+
```
<?php
+try
+{
+    $result = SphinxQL::create($conn)->select()
+        ->from('rt')
+        ->match('title', 'Sora no || Otoshimono', true)
+        ->match('loves', SphinxQL:expr(custom_escaping_fn('(you | me)')));
+        ->execute();
+}
+catch (\Foolz\SphinxQL\DatabaseException $e)
+{
+    // an error is thrown because two `|` one after the other aren't allowed
+}
+
```

Grouping, ordering etc.

+GROUP, WITHIN GROUP, ORDER, OFFSET, LIMIT, OPTION

@@ -227,21 +363,21 @@
Where

WITHIN GROUP ORDER BY $column [$direction]
-
Direction can be omitted with null, or be asc or desc case insensitive.
+
Direction can be omitted with null, or be ASC or DESC case insensitive.
$sq->orderBy($column, $direction = null)

ORDER BY $column [$direction]
-
Direction can be omitted with null, or be asc or desc case insensitive.
+
Direction can be omitted with null, or be ASC or DESC case insensitive.
$sq->offset($offset)

LIMIT $offset, 9999999999999
-
Set the offset. The LIMIT is set to a high number because SphinxQL doesn't support the OFFSET keyword.
+
Set the offset. Since SphinxQL doesn't support the OFFSET keyword, LIMIT has been set at an extremely high number.
$sq->limit($limit)
@@ -258,158 +394,90 @@
Where

OPTION $name = $value
-
Set a SphinxQL option like max_matches or reverse_scan for this query only.
-

Insert and Replace

- -

Will return an array with an INT as first member, the number of rows inserted/replaced.

- -

-
$sq = Sphinxql::insert()->into($index)
- -
Begins an INSERT.
-
-
$sq = Sphinxql::replace()->into($index)
- -
Begins an REPLACE.
-
-
$sq->set($associative_array)
- -
Inserts the associative array, where the keys are the columns and the respective values are the column values.
-
-
$sq->value($column1, $value1)->value($column2, $value2)->value($column3, $value3)
- -
Sets columns one by one
-
-
$sq->columns($column1, $column2, $column3)->values($value1, $value2, $value3)->values($value11, $value22, $value33)
- -
Allows inserting multiple arrays of values in the specified columns.
- -
$column1 and $value1 can be arrays.
-

Update

- -

Will return an array with an INT as first member, the number of rows updated.

- -

-
$sq = Sphinxql::update($index)
- -
Begins an UPDATE.
-
-
$sq->value($column1, $value1)->value($column2, $value2)
- -
Updates the selected columns with the respective value.
-
-
$sq->set($associative_array)
- -
Inserts the associative array, where the keys are the columns and the respective values are the column values.
-

The WHERE part of the query works just as for SELECT.

- -

Delete

- -

Will return an array with an INT as first member, the number of rows deleted.

- -

-
$sq = Sphinxql::delete()->from($column)
- -
Begins a DELETE.
+
Set a SphinxQL option such as max_matches or reverse_scan for the query.

The WHERE part of the query works just as for SELECT.

- -

Transactions

+TRANSACTION

-
Sphinxql::transactionBegin()
+
SphinxQL::create($conn)->transactionBegin()

Begins a transaction.
-
Sphinxql::transactionCommit()
+
SphinxQL::create($conn)->transactionCommit()

Commits a transaction.
-
Sphinxql::transactionRollback()
+
SphinxQL::create($conn)->transactionRollback()

Rollbacks a transaction.

Escaping

+Executing and Compiling

-
$sq->escape($value)
+
$sq->execute()
-
Returns the escaped value, processed with \MySQLi::real_escape_string.
+
Compiles, executes, and returns an array of results of a query.
-
$sq->quoteIdentifier($identifier)
+
$sq->executeBatch()
-
Adds oblique quotes to identifiers. To run this on array elements use $sq->quoteIdentifierArr($arr).
+
Compiles, executes, and returns an array of results for a multi-query.
-
$sq->quote($value)
+
$sq->compile()
-
Adds quotes to values and escapes. To run this on array elements use $sq->quoteArr($arr).
+
Compiles the query.
-
$sq->escapeMatch($value)
+
$sq->getCompiled()
-
Escapes the string for use in a MATCH.
+
Returns the last query compiled.
-
$sq->halfEscapeMatch($value)
+
$sq->getResult()
-
Escapes the string for use in a MATCH. Allows -, |, ". Read about this on the $sq->match() explanation.
+
Returns the last result.

Show

- -

Sphinxql::meta() => 'SHOW META'
-Sphinxql::warnings() => 'SHOW WARNINGS'
-Sphinxql::status() => 'SHOW STATUS'
-Sphinxql::tables() => 'SHOW TABLES'
-Sphinxql::variables() => 'SHOW VARIABLES'
-Sphinxql::variablesSession() => 'SHOW SESSION VARIABLES'
-Sphinxql::variablesGlobal() => 'SHOW GLOBAL VARIABLES'
-

- -

Set variable

+Multi-Query

-
Sphinxql::setVariable($name, $value, $global = false)
+
$sq->enqueue()
+ +
Queues the query.
+
+
$sq->executeBatch()
-
Set a server variable.
+
Returns an array of the results of all the queued queries.

+More

There's several more functions to complete the SphinxQL library:

Sphinxql::callSnippets($data, $index, $extra = array())
Sphinxql::callKeywords($text, $index, $hits = null)
Sphinxql::describe($index)
Sphinxql::createFunction($udf_name, $returns, $soname)
Sphinxql::dropFunction($udf_name)
Sphinxql::attachIndex($disk_index, $rt_index)
Sphinxql::flushRtIndex($index)
SphinxQL::create($conn)->callSnippets($data, $index, $extra = array())
SphinxQL::create($conn)->callKeywords($text, $index, $hits = null)
SphinxQL::create($conn)->describe($index)
SphinxQL::create($conn)->createFunction($udf_name, $returns, $soname)
SphinxQL::create($conn)->dropFunction($udf_name)
SphinxQL::create($conn)->attachIndex($disk_index, $rt_index)
SphinxQL::create($conn)->flushRtIndex($index)

Query Builder for SphinxQL

About

Code Quality

Usage

General

Getting around escaping

Executing and Compiling

Select

Where

Match

Grouping, ordering etc.

Insert and Replace

Update

Delete

Transactions

Escaping

Show

Set variable

More

Code Quality

Usage

General

SphinxQL Query Builder for PHP

SphinxQL Query Builder for PHP

Query Builder for SphinxQL

+Query Builder for SphinxQL

About

+About

Code Quality

+Missing methods?

Usage

+Code Quality

+How to Contribute

+Pull Requests

General

+Style Guide

+Unit Testing

+Installation

+Usage

+Connection

+SphinxQL

+Bypass Query Escaping

+Query Escaping

+SET VARIABLE

Getting around escaping

+SHOW

+SELECT

Executing and Compiling

+INSERT, REPLACE

Select

+UPDATE

+DELETE

Where

+WHERE

Match

+MATCH

Grouping, ordering etc.

+GROUP, WITHIN GROUP, ORDER, OFFSET, LIMIT, OPTION

Where

Where

Insert and Replace

Update

Delete

Transactions

+TRANSACTION

Escaping

+Executing and Compiling

Show

Set variable

+Multi-Query

More

+More

$result = $query->execute(); -

-Connection

+Connection

-SphinxQL

+SphinxQL

Refer to $sq->match() for more information.

-SET VARIABLE

-SHOW

Refer to `$sq->match()` for more information.

-
$sq->enqueue()
+
$sq->enqueue(SphinxQL $next = null)
-
Queues the query.
+
Queues the query. If a $next is provided, $next is appended and returned, otherwise a new SphinxQL object is returned.

$sq->executeBatch()

Returns an array of the results of all the queued queries.

-