Класс yii\db\cubrid\QueryBuilder
| Наследование | yii\db\cubrid\QueryBuilder » yii\db\QueryBuilder » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/db/cubrid/QueryBuilder.php |
QueryBuilder — это генератор запросов для баз данных CUBRID (версии 9.3.x и выше).
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $db | yii\db\Connection | Подключение к базе данных. | yii\db\QueryBuilder |
| $separator | string | Разделитель между фрагментами SQL-запроса. | yii\db\QueryBuilder |
| $typeMap | array | Сопоставление абстрактных типов столбцов (ключи) с физическими типами столбцов (значения). | yii\db\cubrid\QueryBuilder |
Защищенные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $conditionBuilders | array | Карта условий запроса к методам-строителям. | yii\db\QueryBuilder |
| $likeEscapeCharacter | string|null | Символ, используемый для экранирования специальных символов в условиях LIKE. | yii\db\cubrid\QueryBuilder |
| $likeEscapingReplacements | array | Карта символов к их заменам в условиях LIKE. | yii\db\cubrid\QueryBuilder |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Object |
| __construct() | Конструктор. | yii\db\QueryBuilder |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в null. | yii\base\Object |
| addColumn() | Строит SQL-запрос для добавления нового столбца БД. | yii\db\QueryBuilder |
| addCommentOnColumn() | Строит SQL-команду для добавления комментария к столбцу | yii\db\cubrid\QueryBuilder |
| addCommentOnTable() | Строит SQL-команду для добавления комментария к таблице | yii\db\cubrid\QueryBuilder |
| addForeignKey() | Строит SQL-запрос для добавления внешнего ключа к существующей таблице. | yii\db\QueryBuilder |
| addPrimaryKey() | Строит SQL-запрос для добавления первичного ключа к существующей таблице. | yii\db\QueryBuilder |
| alterColumn() | Строит SQL-запрос для изменения определения столбца. | yii\db\QueryBuilder |
| batchInsert() | Генерирует пакетный INSERT SQL-запрос. | yii\db\QueryBuilder |
| build() | Генерирует SELECT SQL-запрос из объекта yii\db\Query. | yii\db\QueryBuilder |
| buildAndCondition() | Соединяет две или более SQL-выражений оператором AND или OR. | yii\db\QueryBuilder |
| buildBetweenCondition() | Создаёт SQL-выражение с оператором BETWEEN. | yii\db\QueryBuilder |
| buildColumns() | Обрабатывает столбцы и должным образом приводит их в соответствие, если необходимо. | yii\db\QueryBuilder |
| buildCondition() | Парсит условие и генерирует соответствующее SQL-выражение. | yii\db\QueryBuilder |
| buildExistsCondition() | Создаёт SQL-выражение с оператором EXISTS. | yii\db\QueryBuilder |
| buildFrom() | yii\db\QueryBuilder | |
| buildGroupBy() | yii\db\QueryBuilder | |
| buildHashCondition() | Создаёт условие на основе пар «столбец-значение». | yii\db\QueryBuilder |
| buildHaving() | yii\db\QueryBuilder | |
| buildInCondition() | Создаёт SQL-выражение с оператором IN. | yii\db\QueryBuilder |
| buildJoin() | yii\db\QueryBuilder | |
| buildLikeCondition() | Создаёт SQL-выражение с оператором LIKE. | yii\db\QueryBuilder |
| buildLimit() | yii\db\cubrid\QueryBuilder | |
| buildNotCondition() | Инвертирует SQL-выражение с оператором NOT. | yii\db\QueryBuilder |
| buildOrderBy() | yii\db\QueryBuilder | |
| buildOrderByAndLimit() | Строит предложения ORDER BY и LIMIT/OFFSET и добавляет их к заданному SQL. | yii\db\QueryBuilder |
| buildSelect() | yii\db\QueryBuilder | |
| buildSimpleCondition() | Создаёт SQL-выражение, как "column" operator value. | yii\db\QueryBuilder |
| buildUnion() | yii\db\QueryBuilder | |
| buildWhere() | yii\db\QueryBuilder | |
| canGetProperty() | Возвращает значение, указывающее, можно ли читать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| checkIntegrity() | Строит SQL-запрос для включения или отключения проверки целостности. | yii\db\QueryBuilder |
| className() | Возвращает полное квалифицированное имя этого класса. | yii\base\Object |
| createIndex() | Строит SQL-запрос для создания нового индекса. | yii\db\QueryBuilder |
| createTable() | Строит SQL-запрос для создания новой таблицы БД. | yii\db\QueryBuilder |
| delete() | Создаёт DELETE SQL-запрос. | yii\db\QueryBuilder |
| dropColumn() | Строит SQL-запрос для удаления столбца БД. | yii\db\QueryBuilder |
| dropCommentFromColumn() | Строит SQL-команду для удаления комментария из столбца | yii\db\cubrid\QueryBuilder |
| dropCommentFromTable() | Строит SQL-команду для удаления комментария из таблицы | yii\db\cubrid\QueryBuilder |
| dropForeignKey() | Строит SQL-запрос для удаления внешнего ключа. | yii\db\QueryBuilder |
| dropIndex() | Строит SQL-запрос для удаления индекса. | yii\db\QueryBuilder |
| dropPrimaryKey() | Строит SQL-запрос для удаления ограничения первичного ключа из существующей таблицы. | yii\db\QueryBuilder |
| dropTable() | Строит SQL-запрос для удаления таблицы БД. | yii\db\QueryBuilder |
| getColumnType() | Преобразует абстрактный тип столбца в физический тип столбца. | yii\db\QueryBuilder |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определён ли свойство. | yii\base\Object |
| init() | Инициализирует объект. | yii\base\Object |
| insert() | Создаёт SQL-запрос INSERT. | yii\db\QueryBuilder |
| renameColumn() | Создаёт SQL-запрос для переименования столбца. | yii\db\QueryBuilder |
| renameTable() | Создаёт SQL-запрос для переименования таблицы БД. | yii\db\QueryBuilder |
| resetSequence() | Создаёт SQL-запрос для сброса значения последовательности первичного ключа таблицы. | yii\db\cubrid\QueryBuilder |
| selectExists() | Создаёт SQL-запрос SELECT EXISTS(). | yii\db\cubrid\QueryBuilder |
| truncateTable() | Создаёт SQL-запрос для обнуления таблицы БД. | yii\db\QueryBuilder |
| update() | Создаёт SQL-запрос UPDATE. | yii\db\QueryBuilder |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| buildCompositeInCondition() | Создаёт SQL для условия IN | yii\db\QueryBuilder |
| buildSubqueryInCondition() | Создаёт SQL для условия IN | yii\db\QueryBuilder |
| hasLimit() | Проверяет, действует ли заданный лимит. | yii\db\QueryBuilder |
| hasOffset() | Проверяет, действует ли заданный смещение. | yii\db\QueryBuilder |
| prepareInsertSelectSubQuery() | Подготовка подзапроса select и имён полей для INSERT INTO. | yii\db\QueryBuilder |
Константы
| Константа | Значение | Описание | Определено в |
|---|---|---|---|
| PARAM_PREFIX | ':qp' | Префикс для автоматически сгенерированных параметров связи запроса. | yii\db\QueryBuilder |
Подробное описание свойств
$likeEscapeCharacter защищённое свойство
Символ, используемый для экранирования специальных символов в условиях LIKE. По умолчанию он предполагается как \.
protected string|null $likeEscapeCharacter = '!'
$likeEscapingReplacements защищённое свойство
Карта символов и их заменителей в условиях LIKE. По умолчанию настраивается для экранирования %, _ и \ с помощью \.
protected array $likeEscapingReplacements = ['%' => '!%', '_' => '!_', '!' => '!!']
$typeMap общедоступное свойство
Сопоставление абстрактных типов столбцов (ключи) с физическими типами столбцов (значения).
public array $typeMap = [\yii\db\cubrid\Schema::TYPE_PK => 'int NOT NULL AUTO_INCREMENT PRIMARY KEY', \yii\db\cubrid\Schema::TYPE_UPK => 'int UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY', \yii\db\cubrid\Schema::TYPE_BIGPK => 'bigint NOT NULL AUTO_INCREMENT PRIMARY KEY', \yii\db\cubrid\Schema::TYPE_UBIGPK => 'bigint UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY', \yii\db\cubrid\Schema::TYPE_CHAR => 'char(1)', \yii\db\cubrid\Schema::TYPE_STRING => 'varchar(255)', \yii\db\cubrid\Schema::TYPE_TEXT => 'varchar', \yii\db\cubrid\Schema::TYPE_SMALLINT => 'smallint', \yii\db\cubrid\Schema::TYPE_INTEGER => 'int', \yii\db\cubrid\Schema::TYPE_BIGINT => 'bigint', \yii\db\cubrid\Schema::TYPE_FLOAT => 'float(7)', \yii\db\cubrid\Schema::TYPE_DOUBLE => 'double(15)', \yii\db\cubrid\Schema::TYPE_DECIMAL => 'decimal(10,0)', \yii\db\cubrid\Schema::TYPE_DATETIME => 'datetime', \yii\db\cubrid\Schema::TYPE_TIMESTAMP => 'timestamp', \yii\db\cubrid\Schema::TYPE_TIME => 'time', \yii\db\cubrid\Schema::TYPE_DATE => 'date', \yii\db\cubrid\Schema::TYPE_BINARY => 'blob', \yii\db\cubrid\Schema::TYPE_BOOLEAN => 'smallint', \yii\db\cubrid\Schema::TYPE_MONEY => 'decimal(19,4)']
Подробное описание методов
addCommentOnColumn() общедоступный метод (доступен с версии 2.0.8)
Создаёт SQL-команду для добавления комментария к столбцу
| public string addCommentOnColumn ( $table, $column, $comment ) | ||
|---|---|---|
| $table | string |
Имя таблицы, к столбцу которой нужно добавить комментарий. Имя таблицы будет корректно обрамлено кавычками методом. |
| $column | string |
Имя столбца, к которому нужно добавить комментарий. Имя столбца будет корректно обрамлено кавычками методом. |
| $comment | string |
Текст комментария, который нужно добавить. Комментарий будет корректно обрамлён кавычками методом. |
| return | string |
SQL-запрос для добавления комментария к столбцу |
addCommentOnTable() общедоступный метод (доступен с версии 2.0.8)
Создаёт SQL-команду для добавления комментария к таблице
| public string addCommentOnTable ( $table, $comment ) | ||
|---|---|---|
| $table | string |
Имя таблицы, к которой нужно добавить комментарий. Имя таблицы будет корректно обрамлено кавычками методом. |
| $comment | string |
Текст комментария, который нужно добавить. Комментарий будет корректно обрамлён кавычками методом. |
| return | string |
SQL-запрос для добавления комментария к таблице |
buildLimit() общедоступный метод
| public string buildLimit ( $limit, $offset ) | ||
|---|---|---|
| $limit | integer | |
| $offset | integer | |
| return | string |
Оператор LIMIT и OFFSET |
dropCommentFromColumn() общедоступный метод (доступен с версии 2.0.8)
Создаёт SQL-команду для удаления комментария из столбца
| public string dropCommentFromColumn ( $table, $column ) | ||
|---|---|---|
| $table | string |
Имя таблицы, из столбца которой нужно удалить комментарий. Имя таблицы будет корректно обрамлено кавычками методом. |
| $column | string |
Имя столбца, из которого нужно удалить комментарий. Имя столбца будет корректно обрамлено кавычками методом. |
| return | string |
SQL-запрос для удаления комментария из столбца |
dropCommentFromTable() общедоступный метод (доступен с версии 2.0.8)
Создаёт SQL-команду для удаления комментария из таблицы
| public string dropCommentFromTable ( $table ) | ||
|---|---|---|
| $table | string |
Имя таблицы, из которой нужно удалить комментарий. Имя таблицы будет корректно обрамлено кавычками методом. |
| return | string |
SQL-запрос для удаления комментария из таблицы |
resetSequence() общедоступный метод
Создаёт SQL-запрос для сброса значения последовательности первичного ключа таблицы.
Последовательность будет сброшена таким образом, чтобы первичный ключ следующей новой строки, вставленной, имел указанное значение или 1.
| public string resetSequence ( $tableName, $value = null ) | ||
|---|---|---|
| $tableName | string |
Имя таблицы, последовательность первичного ключа которой будет сброшена |
| $value | mixed |
Значение для первичного ключа следующей новой вставленной строки. Если это не задано, первичный ключ следующей новой строки будет иметь значение 1. |
| return | string |
SQL-запрос для сброса последовательности |
| throws | yii\base\InvalidParamException |
если таблица не существует или с таблицей не ассоциирована последовательность. |
selectExists() общедоступный метод (доступен с версии 2.0.8)
Создаёт SQL-запрос SELECT EXISTS().
| public string selectExists ( $rawSql ) | ||
|---|---|---|
| $rawSql | string |
Подзапрос в сыром виде для выбора из. |
| return | string |
SQL-запрос SELECT EXISTS(). |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-db-cubrid-querybuilder.html
