Класс yii\sphinx\Schema

public yii\sphinx\Connection $db = null

public string[] getIndexNames ( $refresh = false )

public yii\sphinx\IndexSchema[] getIndexSchemas ( $refresh = false )

public array getIndexTypes ( $refresh = false )

public yii\sphinx\QueryBuilder getQueryBuilder ( )

public array $typeMap = ['field' => self::TYPE_STRING, 'string' => self::TYPE_STRING, 'ordinal' => self::TYPE_STRING, 'integer' => self::TYPE_INTEGER, 'int' => self::TYPE_INTEGER, 'uint' => self::TYPE_INTEGER, 'bigint' => self::TYPE_BIGINT, 'timestamp' => self::TYPE_TIMESTAMP, 'bool' => self::TYPE_BOOLEAN, 'float' => self::TYPE_FLOAT, 'mva' => self::TYPE_INTEGER]

applyDefaultColumns() защищённый метод (доступен с версии 2.0.6)

Настраивает стандартные столбцы для данного индекса.

Этот метод следует использовать в случае, если невозможно определить фактические столбцы, например, в некоторых распределённых индексах.

protected void applyDefaultColumns ( $index )
$index	yii\sphinx\IndexSchema	Метаданные индекса

convertException() публичный метод

Преобразует исключение DB в более конкретное, если возможно.

public yii\db\Exception convertException ( Exception $e, $rawSql )
$e	Exception
$rawSql	string	SQL, вызвавший исключение

createQueryBuilder() публичный метод

Создаёт генератор запросов для Sphinx.

public yii\sphinx\QueryBuilder createQueryBuilder ( )
return	yii\sphinx\QueryBuilder	Экземпляр генератора запросов

findColumns() защищённый метод

Сбор метаданных столбцов индекса.

protected boolean findColumns ( $index )
$index	yii\sphinx\IndexSchema	Метаданные индекса
return	boolean	Существует ли индекс в базе данных
throws	Exception	если запрос к базе данных завершается ошибкой

findIndexes() защищённый метод

Возвращает все имена индексов в Sphinx.

protected array findIndexes ( )
return	array	Все имена индексов в Sphinx.

getCacheKey() защищённый метод

Возвращает ключ кэша для указанного имени индекса.

protected mixed getCacheKey ( $name )
$name	string	Имя индекса
return	mixed	Ключ кэша

getCacheTag() защищённый метод

Возвращает имя тега кэша.

Это позволяет методу refresh() аннулировать все кэшированные схемы индексов.

protected string getCacheTag ( )
return	string	Имя тега кэша

getColumnPhpType() защищённый метод

Извлекает тип PHP из абстрактного типа DB.

protected string getColumnPhpType ( $column )
$column	yii\sphinx\ColumnSchema	Информация о схеме столбца
return	string	Имя типа PHP

getIndexNames() публичный метод

Возвращает все имена индексов в Sphinx.

public string[] getIndexNames ( $refresh = false )
$refresh	boolean	Перезагружать ли последние доступные имена индексов. Если false, возвращаются ранее полученные (если доступны).
return	string[]	Все имена индексов в Sphinx.

getIndexSchema() публичный метод

Получает метаданные для указанного индекса.

public yii\sphinx\IndexSchema|null getIndexSchema ( $name, $refresh = false )
$name	string	Имя индекса. Имя индекса может содержать имя схемы, если таковое имеется. Не заключайте имя индекса в кавычки.
$refresh	boolean	Перезагружать ли схему индекса, даже если она найдена в кэше.
return	yii\sphinx\IndexSchema|null	Метаданные индекса. null - если указанный индекс не существует.

getIndexSchemas() публичный метод

Возвращает метаданные для всех индексов в базе данных.

public yii\sphinx\IndexSchema[] getIndexSchemas ( $refresh = false )
$refresh	boolean	Перезагружать ли последние доступные схемы индексов. Если false, могут быть возвращены данные из кэша, если они доступны.
return	yii\sphinx\IndexSchema[]	Метаданные для всех индексов в Sphinx. Каждый элемент массива — экземпляр yii\sphinx\IndexSchema или его дочернего класса.

getIndexTypes() публичный метод

Возвращает все типы индексов в Sphinx.

public array getIndexTypes ( $refresh = false )
$refresh	boolean	Перезагружать ли последние доступные типы индексов. Если false, возвращаются ранее полученные типы (если доступны).
return	array	Все типы индексов в Sphinx в формате: имя индекса => тип индекса.

getPdoType() публичный метод

Определяет тип PDO для данного значения данных PHP.

См. также http://www.php.net/manual/en/pdo.constants.php.

public integer getPdoType ( $data )
$data	mixed	Данные, для которых необходимо определить тип PDO
return	integer	Тип PDO

getQueryBuilder() публичный метод

public yii\sphinx\QueryBuilder getQueryBuilder ( )
return	yii\sphinx\QueryBuilder	Генератор запросов для этого подключения.

getRawIndexName() публичный метод

Возвращает фактическое имя данного имени индекса.

Этот метод удалит фигурные скобки из данного имени индекса и заменит символ процента '%' префиксом индекса yii\sphinx\Connection::indexPrefix.

public string getRawIndexName ( $name )
$name	string	Имя индекса для преобразования
return	string	Действительное имя данного имени индекса

initIndexesInfo() защищённый метод

Инициализирует информацию об имени и типе всех индексов в Sphinx.

protected void initIndexesInfo ( )

isReadQuery() публичный метод

Возвращает значение, указывающее, предназначен ли SQL-запрос для чтения.

public boolean isReadQuery ( $sql )
$sql	string	Запрос SQL
return	boolean	Является ли SQL-запрос запросом для чтения.

loadColumnSchema() protected method

Загружает информацию о столбце в объект yii\sphinx\ColumnSchema.

protected yii\sphinx\ColumnSchema loadColumnSchema ( $info )
$info	array	Информация о столбце
return	yii\sphinx\ColumnSchema	Объект схемы столбца

loadIndexSchema() protected method

Загружает метаданные для указанного индекса.

protected yii\sphinx\IndexSchema|null loadIndexSchema ( $name )
$name	string	Имя индекса
return	yii\sphinx\IndexSchema|null	Метаданные индекса, зависящие от драйвера. null - если индекс не существует.

quoteColumnName() public method

Выделяет имя столбца для использования в запросе.

Если имя столбца содержит префикс, префикс также будет правильно выделен. Если имя столбца уже выделено или содержит '(', '[[' или '{{', этот метод ничего не сделает.

См. также quoteSimpleColumnName().

public string quoteColumnName ( $name )
$name	string	Имя столбца
return	string	Правильно выделенное имя столбца

quoteIndexName() public method

Выделяет имя индекса для использования в запросе.

Если имя индекса содержит префикс схемы, префикс также будет правильно выделен. Если имя индекса уже выделено или содержит '(' или '{{', этот метод ничего не сделает.

См. также \yii\sphinx\quoteSimpleTableName.

public string quoteIndexName ( $name )
$name	string	Имя индекса
return	string	Правильно выделенное имя индекса

quoteSimpleColumnName() public method

Выделяет имя столбца для использования в запросе.

Простое имя столбца не имеет префикса.

public string quoteSimpleColumnName ( $name )
$name	string	Имя столбца
return	string	Правильно выделенное имя столбца

quoteSimpleIndexName() public method

Выделяет имя индекса для использования в запросе.

Простое имя индекса не имеет префикса схемы.

public string quoteSimpleIndexName ( $name )
$name	string	Имя индекса
return	string	Правильно выделенное имя индекса

quoteValue() public method

Выделяет строковое значение для использования в запросе.

Обратите внимание, что если параметр не является строкой, он возвращается без изменений.

См. также http://www.php.net/manual/en/function.PDO-quote.php.

public string quoteValue ( $str )
$str	string	Строка для выделения
return	string	Правильно выделенная строка

refresh() public method

Обновляет схему.

Этот метод очищает все кэшированные схемы индексов, чтобы их можно было позже пересоздать, отражая изменения схемы Sphinx.

public void refresh ( )

resolveIndexNames() protected method

Разрешает имя индекса.

protected void resolveIndexNames ( $index, $name )
$index	yii\sphinx\IndexSchema	Объект метаданных индекса
$name	string	Имя индекса

resolveIndexType() protected method

Разрешает тип индекса.

protected void resolveIndexType ( $index )
$index	yii\sphinx\IndexSchema	Объект метаданных индекса