Класс Query

Обрабатывает очистку итератора и клонирование всех выражений и связывателей значений.

Возвращает

Конструктор.

Параметры

Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.

Возвращает

Возвращает строковое представление этого запроса (полное SQL-утверждение).

Возвращает

Вспомогательная функция, используемая для построения условий путем объединения объектов QueryExpression.

Параметры

Возвращает

Вспомогательная функция, используемая для обертывания исходного утверждения из драйвера любыми зарегистрированными обратными вызовами.

Параметры

Возвращает

Помечает запрос как изменённый, удаляя любую предварительно обработанную информацию из кэширования в памяти.

Возвращает

Метод обхода частей запроса, используемый traverseExpressions()

Параметры

Возвращает

Возвращает массив, который можно передать методу join, описывающий одну строку объединения

Параметры

Возвращает

Соединяет ранее определённый набор условий с предоставленным списком с помощью оператора AND в предложении HAVING. Этот метод работает точно так же, как метод andWhere(). Обратитесь к его документации, чтобы понять, как использовать каждый параметр.

Поля HAVING не подходят для использования с пользовательскими данными, поскольку они не проходят проверку на безопасность в конструкторе запроса.

Параметры

Возвращает

См. также

Соединяет ранее определённый набор условий с предоставленным списком с помощью оператора AND. Эта функция принимает список условий в том же формате, что и метод where, следовательно, вы можете использовать массивы, объекты выражений, функции обратного вызова или строки.

Важно заметить, что при вызове этой функции любой ранее определённый набор условий для этого запроса будет обрабатываться как один аргумент для оператора AND. Эта функция будет обрабатывать не только недавно определённое условие, но и все условия в целом.

При использовании массива для определения условий создание ограничений из каждой записи массива будет использовать ту же логику, что и с функцией where(). Это означает, что каждая запись массива будет объединена с другой с помощью оператора AND, если вы не вложите условия в массив с помощью другого оператора.

Примеры:

$query->where(['title' => 'Hello World')->andWhere(['author_id' => 1]);

Создаст:

WHERE title = 'Hello World' AND author_id = 1

$query
  ->where(['OR' => ['published' => false, 'published is NULL']])
  ->andWhere(['author_id' => 1, 'comments_count >' => 10])

Создаёт:

WHERE (published = 0 OR published IS NULL) AND author_id = 1 AND comments_count > 10

$query
  ->where(['title' => 'Foo'])
  ->andWhere(function ($exp, $query) {
    return $exp
      ->or(['author_id' => 1])
      ->add(['author_id' => 2]);
  });

Генерирует следующие условия:

WHERE (title = 'Foo') AND (author_id = 1 OR author_id = 2)

Параметры

Возвращает

См. также

Связывает заполнитель запроса со значением и типом.

$query->bind(':id', 1, 'integer');

Параметры

Возвращает

Возвращает данные, которые хранились в указанном предложении. Это полезно для изменения любой внутренней части запроса, и оно используется диалектами SQL для преобразования запроса соответственно перед его выполнением. Действительные предложения, которые можно получить, это: delete, update, set, insert, values, select, distinct, from, join, set, where, group, having, order, limit, offset и union.

Возвращаемое значение для каждой из этих частей может отличаться. Некоторые предложения используют QueryExpression для внутреннего хранения своего состояния, некоторые используют массивы, а другие могут использовать булевы значения или целые числа. Это сводка типов возвращаемых значений для каждого предложения.

• update: строка Имя таблицы для обновления
• set: QueryExpression
• insert: массив, вернёт массив, содержащий таблицу + столбцы.
• values: ValuesExpression
• select: массив, вернёт пустой массив, если нет полей
• distinct: boolean
• from: массив таблиц
• join: массив
• set: массив
• where: QueryExpression, возвращает null, если не задано
• group: массив
• having: QueryExpression, возвращает null, если не задано
• order: OrderByExpression, возвращает null, если не задано
• limit: целое число или QueryExpression, null, если не задано
• offset: целое число или QueryExpression, null, если не задано
• union: массив

Параметры

Возвращает

Вызывает

Регистрирует обратный вызов, который будет выполняться для каждого результата, извлечённого из набора результатов. Функция обратного вызова получит в качестве первого параметра массив с исходными данными из базы данных для каждой строки, которая извлекается, и должна вернуть строку с возможными изменениями.

Обратные вызовы будут выполняться лениво. Если для базы данных извлекается только 3 строки, то он будет вызван 3 раза, даже если в курсоре может быть больше строк.

Обратные вызовы стекируются в порядке их регистрации. Если вы хотите сбросить стек, вызовите эту функцию со вторым параметром, установленным в true.

Если вы хотите удалить все декораторы из стека, установите первый параметр в null, а второй — в true.

Пример

$query->decorateResults(function ($row) {
  $row['order_total'] = $row['subtotal'] + ($row['subtotal'] * $row['tax']);
   return $row;
});

Параметры

Возвращаемое значение

Создаёт запрос на удаление.

Можно комбинировать с методами from(), where() и другими для создания запросов на удаление со специфическими условиями.

Параметры

Возвращаемое значение

Отключает буферизацию результатов.

Отключение буферизации уменьшит потребление памяти, так как извлечённые результаты не запоминаются для последующих итераций.

Возвращаемое значение

Отключает преобразование результатов.

При отключении поля будут возвращаться так, как они получены от драйвера базы данных (в большинстве сред это означает, что они возвращаются в виде строк), что может улучшить производительность с большими наборами данных.

Возвращаемое значение

Добавляет условие DISTINCT в запрос для удаления дубликатов из набора результатов. Это условие может использоваться только для запросов SELECT.

Если вы хотите отфильтровать дубликаты на основе строк, которые разделяют определённое поле или набор полей, вы можете передать массив полей для фильтрации. Имейте в виду, что этот параметр может не поддерживаться во всех системах баз данных.

Примеры:

// Filters products with the same name and city
$query->select(['name', 'city'])->from('products')->distinct();

// Filters products in the same city
$query->distinct(['city']);
$query->distinct('city');

// Filter products with the same name
$query->distinct(['name'], true);
$query->distinct('name', true);

Параметры

Возвращаемое значение

Включает/выключает буферизацию результатов.

При включении результаты, возвращаемые этим запросом, будут буферизованы. Это позволяет вам многократно итерировать набор результатов или кешировать и итерировать его.

При отключении это уменьшит потребление памяти, так как извлечённые результаты не запоминаются для последующих итераций.

Параметры

Возвращаемое значение

Включает преобразование результатов.

При включении поля в результатах, возвращаемых этим запросом, будут преобразовываться в соответствующий тип данных PHP.

Возвращаемое значение

Строка или выражение, которое будет добавлено к сгенерированному запросу.

Примеры:

$query->select('id')->where(['author_id' => 1])->epilog('FOR UPDATE');
$query
 ->insert('articles', ['title'])
 ->values(['author_id' => 1])
 ->epilog('RETURNING id');

Содержимое epilog — это сырой SQL и не подходит для использования с предоставленными пользователем данными.

Параметры

Возвращаемое значение

Компилирует SQL-представление этого запроса и выполняет его с помощью объекта подключения, настроенного в объекте. Возвращает объект полученного оператора.

Выполнение запроса внутренне выполняет несколько шагов. На первом шаге подключение преобразует этот объект, чтобы он соответствовал его конкретному диалекту. Это может привести к генерации другого объекта запроса, который будет фактически выполнен. Сразу после этого литеральные значения передаются подключению, чтобы они были привязаны к запросу безопасным способом. Наконец, полученный оператор украшается пользовательскими объектами, чтобы выполнять обратные вызовы для каждой полученной строки при необходимости.

Полученный оператор итерируемый, поэтому он может использоваться в любом цикле, как вы это делаете с массивом.

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

Возвращаемое значение

Добавляет одну или несколько таблиц, которые будут использоваться в предложении FROM для этого запроса. Таблицы могут передаваться как массив строк, массив объектов выражений, одно выражение или одна строка.

Если передаётся массив, ключи будут использоваться для алиасов таблиц, используя значение в качестве реального поля для алиасирования. Можно алиасить строки, объекты ExpressionInterface или даже другие объекты Query.

По умолчанию эта функция добавляет любой переданный аргумент в список таблиц, которые должны быть выбраны, если только второй аргумент не установлен в true.

Этот метод может использоваться для запросов SELECT, UPDATE и DELETE.

Примеры:

$query->from(['p' => 'posts']); // Produces FROM posts p
$query->from('authors'); // Appends authors: FROM posts p, authors
$query->from(['products'], true); // Resets the list: FROM products
$query->from(['sub' => $countQuery]); // FROM (SELECT ...) sub

Параметры

Возвращаемое значение

Возвращает экземпляр объекта-строителя функций, который можно использовать для генерации произвольных SQL-функций.

Пример:

$query->func()->count('*');
$query->func()->dateDiff(['2012-01-05', '2012-01-02'])

Возвращаемое значение

Получает экземпляр подключения, используемого для выполнения и преобразования этого запроса.

Возвращаемое значение

Получает типы по умолчанию для текущей карты типов.

Возвращаемое значение

Выполняет этот запрос и возвращает итератор результатов. Эта функция необходима для реализации интерфейса IteratorAggregate и позволяет итерировать запрос без ручного вызова execute(), тем самым заставив его выглядеть как набор результатов, а не сам запрос.

Возвращаемое значение

Получает класс TypeMap, где хранятся типы для каждого поля в предложении SELECT.

Возвращаемое значение

Возвращает существующую карту типов.

Возвращаемое значение

Возвращает текущий используемый экземпляр ValueBinder.

ValueBinder отвечает за генерацию заполнительных значений запросов и временное связывание значений с этими заполнителями, чтобы они могли быть правильно переданы объекту оператора.

Возвращаемое значение

Добавляет одно или несколько полей для использования в условии GROUP BY для этого запроса. Поля могут быть переданы в виде массива строк, массива объектов выражений, одного выражения или одной строки.

По умолчанию эта функция добавляет любой переданный аргумент в список группируемых полей, если второй аргумент не установлен в значение true.

Примеры:

// Produces GROUP BY id, title
$query->group(['id', 'title']);

// Produces GROUP BY title
$query->group('title');

Поля группировки не подходят для использования с данными, предоставленными пользователем, так как они не очищаются билдером запросов.

Параметры

Возвращает

Добавляет условие или набор условий, которые будут использоваться в HAVING-условии для этого запроса. Этот метод работает точно так же, как метод where(). Обратитесь к его документации, чтобы узнать, как использовать каждый параметр.

Поля Having не подходят для использования с данными, предоставленными пользователем, так как они не очищаются билдером запросов.

Параметры

Возвращает

См. также

Создает выражение, которое ссылается на идентификатор. Идентификаторы используются для ссылки на имена полей и позволяют компилятору SQL применять кавычки или экранировать идентификатор.

Значение используется как есть, и вам может потребоваться использовать псевдонимы или включить ссылку на таблицу в идентификатор. Не используйте этот метод для вставки SQL-методов или логических выражений.

Пример

$query->newExpr()->lte('count', $query->identifier('total'));

Параметры

Возвращает

Добавляет одно INNER JOIN-условие в запрос.

Это сокращенный метод для построения соединений через join().

Аргументы этого метода идентичны сокращенному методу leftJoin(), обратитесь к описанию этого метода для получения дополнительной информации.

Параметры

Возвращает

Создает запрос INSERT.

Обратите внимание, что вызов этого метода сбросит любые данные, ранее заданные с помощью Query::values().

Параметры

Возвращает

Исключения

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

Параметры

Возвращает

Возвращает, включены ли буферизованные результаты/выключены.

При включенном значении результаты, возвращаемые этим запросом, будут буферизованы. Это позволяет многократно итерировать результат набора или кэшировать и итерировать его.

При отключении это позволит использовать меньше памяти, так как полученные результаты не будут запоминаться для будущих итераций.

Возвращает

Возвращает, включено ли приведение типов результатов/выключено.

При включении поля в результатах, возвращаемых этим запросом, будут приведены к соответствующему типу данных PHP.

При отключении поля будут возвращены в виде полученных от драйвера базы данных (в большинстве сред это означает, что они возвращаются как строки), что может повысить производительность с большими наборами данных.

Возвращает

Добавляет одну или несколько таблиц для использования в качестве условий JOIN в этом запросе. Таблицы могут быть переданы в виде массива строк, массива, описывающего части соединения, массива с несколькими описаниями соединений или одной строкой.

По умолчанию эта функция добавляет любой переданный аргумент в список таблиц, которые должны быть объединены, если третий аргумент не установлен в значение true.

Если тип соединения не указан, по умолчанию используется INNER JOIN: $query->join(['authors']) даст INNER JOIN authors ON 1 = 1.

Также можно использовать псевдонимы для объединений, используя ключ массива: $query->join(['a' => 'authors']) даст INNER JOIN authors a ON 1 = 1.

Соединение можно полностью описать и использовать псевдоним с помощью записи массива:

$query->join([
    'a' => [
        'table' => 'authors',
        'type' => 'LEFT',
        'conditions' => 'a.id = b.author_id'
    ]
]);
// Produces LEFT JOIN authors a ON a.id = b.author_id

Вы даже можете указать несколько соединений в массиве, включая полное описание:

$query->join([
    'a' => [
        'table' => 'authors',
        'type' => 'LEFT',
        'conditions' => 'a.id = b.author_id'
    ],
    'p' => [
        'table' => 'publishers',
        'type' => 'INNER',
        'conditions' => 'p.id = b.publisher_id AND p.name = "Cake Software Foundation"'
    ]
]);
// LEFT JOIN authors a ON a.id = b.author_id
// INNER JOIN publishers p ON p.id = b.publisher_id AND p.name = "Cake Software Foundation"

Использование условий и типов

Условия могут быть выражены, как показано в примерах выше, используя строку для сравнения столбцов или строку с уже приведенными к кавычкам буквами. Кроме того, можно использовать условия, выраженные в массивах или объектах выражений.

При использовании массивов для выражения условий часто желательно преобразовать буквальные значения в правильное представление базы данных. Это достигается с помощью второго параметра этой функции.

$query->join(['a' => [
    'table' => 'articles',
    'conditions' => [
        'a.posted >=' => new DateTime('-3 days'),
        'a.published' => true,
        'a.author_id = authors.id'
    ]
]], ['a.posted' => 'datetime', 'a.published' => 'boolean'])

Переопределение соединений

При создании псевдонимизированных соединений с помощью записи массива вы можете переопределять предыдущие определения соединений, используя тот же псевдоним в последующих вызовах этой функции, или вы можете заменить все ранее определенные соединения другим списком, если третий параметр для этой функции установлен в значение true.

$query->join(['alias' => 'table']); // joins table with as alias
$query->join(['alias' => 'another_table']); // joins another_table with as alias
$query->join(['something' => 'different_table'], [], true); // resets joins list

Параметры

Возвращает

См. также

Добавляет одно LEFT JOIN-условие в запрос.

Это сокращенный метод для построения соединений через join().

Имя таблицы может быть передано как строка или как массив в случае необходимости использования псевдонима:

// LEFT JOIN authors ON authors.id = posts.author_id
$query->leftJoin('authors', 'authors.id = posts.author_id');

// LEFT JOIN authors a ON a.id = posts.author_id
$query->leftJoin(['a' => 'authors'], 'a.id = posts.author_id');

Условия могут быть переданы как строки, массивы или объекты выражений. При использовании массивов можно комбинировать их с параметром $types, чтобы определить, как преобразовать значения:

$query->leftJoin(['a' => 'articles'], [
     'a.posted >=' => new DateTime('-3 days'),
     'a.published' => true,
     'a.author_id = authors.id'
], ['a.posted' => 'datetime', 'a.published' => 'boolean']);

См. join() для получения дополнительной информации об условиях и типах.

Параметры

Возвращает

Устанавливает количество записей, которое должно быть получено из базы данных, принимает целое число или объект выражения, который вычисляется в целое число. В некоторых базах данных эта операция может не поддерживаться или потребовать преобразования запроса для ограничения размера набора результатов.

Примеры

$query->limit(10) // generates LIMIT 10
$query->limit($query->newExpr()->add(['1 + 1'])); // LIMIT (1 + 1)

Параметры

Возвращает

Добавляет один или несколько модификаторов, которые будут использованы в SELECT.

По умолчанию эта функция добавляет любой переданный аргумент в список применяемых модификаторов, если второй аргумент не установлен в значение true.

Пример:

// Ignore cache query in MySQL
$query->select(['name', 'city'])->from('products')->modifier('SQL_NO_CACHE');
// It will produce the SQL: SELECT SQL_NO_CACHE name, city FROM products

// Or with multiple modifiers
$query->select(['name', 'city'])->from('products')->modifier(['HIGH_PRIORITY', 'SQL_NO_CACHE']);
// It will produce the SQL: SELECT HIGH_PRIORITY SQL_NO_CACHE name, city FROM products

Параметры

Возвращаемое значение

Возвращает новый объект QueryExpression. Эта функция полезна при построении сложных запросов с использованием интерфейса fluent. Также вы можете переопределить эту функцию в подклассах, чтобы использовать специализированный класс QueryExpression, если это необходимо.

Вы можете необязательно передать строку с сырым SQL-запросом или массив выражений в любом формате, принимаемом \Cake\Database\Expression\QueryExpression:

$expression = $query->newExpr(); // Returns an empty expression object
$expression = $query->newExpr('Table.column = Table2.column'); // Return a raw SQL expression

Параметры

Возвращаемое значение

Устанавливает количество записей, которые следует пропустить из исходного набора результатов. Это часто используется для постраничной обработки больших результатов. Принимает целое число или объект выражения, вычисляемый в целое число.

В некоторых базах данных эта операция может быть не поддерживается или потребует преобразования запроса для ограничения размера набора результатов.

Примеры

$query->offset(10) // generates OFFSET 10
$query->offset($query->newExpr()->add(['1 + 1'])); // OFFSET (1 + 1)

Параметры

Возвращаемое значение

Добавляет одно или несколько полей, которые будут использованы в инструкции ORDER для этого запроса. Поля могут быть переданы как массив строк, массив объектов выражений, одно выражение или одна строка.

Если передается массив, ключи будут использоваться в качестве самих полей, а значения будут представлять порядок, в котором эти поля должны быть упорядочены. При вызове несколько раз с одинаковыми полями в качестве ключей последнее определение порядка будет преобладать над другими.

По умолчанию эта функция добавляет любой переданный аргумент в список полей, которые должны быть выбраны, если второй аргумент не установлен в значение true.

Примеры:

$query->order(['title' => 'DESC', 'author_id' => 'ASC']);

Производит:

ORDER BY title DESC, author_id ASC

$query
    ->order(['title' => $query->newExpr('DESC NULLS FIRST')])
    ->order('author_id');

Будет генерировать:

ORDER BY title DESC NULLS FIRST, author_id

$expression = $query->newExpr()->add(['id % 2 = 0']);
$query->order($expression)->order(['title' => 'ASC']);

и

$query->order(function ($exp, $query) {
    return [$exp->add(['id % 2 = 0']), 'title' => 'ASC'];
});

Оба станут:

ORDER BY (id %2 = 0), title ASC

Поля/направления сортировки не проверяются генератором запросов. При передаче данных, введенных пользователем, в order(), следует использовать разрешенный список полей/направлений.

Если вам нужно задать сложные выражения как условия сортировки, вы должны использовать orderAsc() или orderDesc().

Параметры

Возвращаемое значение

Добавить условие ORDER BY с направлением ASC.

Этот метод позволяет задавать сложные выражения как условия сортировки в отличие от order().

Поля сортировки не подходят для использования с данными, введенными пользователем, так как они не проверяются генератором запросов.

Параметры

Возвращаемое значение

Добавить условие ORDER BY с направлением DESC.

Этот метод позволяет задавать сложные выражения как условия сортировки в отличие от order().

Поля сортировки не подходят для использования с данными, введенными пользователем, так как они не проверяются генератором запросов.

Параметры

Возвращаемое значение

Устанавливает страницу результатов, которую вы хотите.

Этот метод предоставляет более удобный интерфейс для установки limit + offset в наборе записей, которые вы хотите получить как результаты. Если пусто, limit будет по умолчанию равен существующему значению limit, а если и оно пустое, то 25 будет использоваться.

Номера страниц должны начинаться с 1.

Параметры

Возвращаемое значение

Исключения

Удаляет объединение, если оно было определено.

Полезно при переопределении объединений или при необходимости изменения порядка условий объединения.

Параметры

Возвращаемое значение

Добавляет одно условие RIGHT JOIN в запрос.

Это сокращенный метод для построения объединений с помощью join().

Аргументы этого метода идентичны сокращенным leftJoin(), пожалуйста, обратитесь к описанию этих методов для получения дополнительной информации.

Параметры

Возвращаемое значение

Выполняет SQL этого запроса и немедленно закрывает оператор перед возвращением количества строк, измененных в результате.

Этот метод может быть использован с запросами UPDATE и DELETE, но не рекомендуется для запросов SELECT и не используется для подсчета записей.

Пример

$rowCount = $query->update('articles')
                ->set(['published'=>true])
                ->where(['published'=>false])
                ->rowCountAndClose();

Вышеприведенный пример изменит столбец published на true для всех записей с false и вернет количество обновленных записей.

Возвращаемое значение

Добавляет новые поля, которые должны быть возвращены оператором SELECT при выполнении этого запроса. Поля могут быть переданы как массив строк, массив объектов выражений, одно выражение или одна строка.

Если передается массив, ключи будут использованы для псевдонимизации полей, используя значение как реальное поле для псевдонимизации. Можно псевдонимизировать строки, объекты Expression или даже другие объекты Query.

Если передается вызываемая функция, возвращаемый массив функции будет использоваться как список полей.

По умолчанию эта функция добавляет любой переданный аргумент в список полей, которые должны быть выбраны, если второй аргумент не установлен в значение true.

Примеры:

$query->select(['id', 'title']); // Produces SELECT id, title
$query->select(['author' => 'author_id']); // Appends author: SELECT id, title, author_id as author
$query->select('id', true); // Resets the list: SELECT id
$query->select(['total' => $countQuery]); // SELECT id, (SELECT ...) AS total
$query->select(function ($query) {
    return ['article_id', 'total' => $query->count('*')];
})

По умолчанию поля не выбираются. Если у вас есть экземпляр Cake\ORM\Query и вы пытаетесь добавить поля, вы также должны вызвать Cake\ORM\Query::enableAutoFields() для выбора стандартных полей из таблицы.

Параметры

Возвращаемое значение

Установить одно или несколько полей для обновления.

Примеры

Передача строки:

$query->update('articles')->set('title', 'The Title');

Передача массива:

$query->update('articles')->set(['title' => 'The Title'], ['title' => 'string']);

Передача вызываемого объекта:

$query->update('articles')->set(function ($exp) {
  return $exp->eq('title', 'The title', 'string');
});

Параметры

Возвращает

Устанавливает экземпляр соединения, который будет использоваться для выполнения и преобразования данного запроса.

Параметры

Возвращает

Переопределяет сопоставления типов по умолчанию для полей в реализующем объекте.

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

Чтобы добавить тип по умолчанию без переопределения существующих, используйте getTypeMap()->addDefaults()

Параметры

Возвращает

См. также

Устанавливает класс TypeMap, в котором хранятся типы для каждого поля в запросе select.

Параметры

Возвращает

Создает новый TypeMap, если $typeMap — массив, иначе меняет его на указанный.

Параметры

Возвращает

Переопределяет текущий связующий элемент значений.

ValueBinder отвечает за создание плейсхолдеров запроса и временное связывание значений с этими плейсхолдерами, чтобы они могли быть корректно переданы объекту оператора.

Параметры

Возвращает

Возвращает SQL-представление этого объекта.

Эта функция скомпилирует данный запрос, чтобы сделать его совместимым с диалектом SQL, используемым соединением. Этот процесс может добавить, удалить или изменить любую часть запроса или внутреннее выражение, чтобы сделать его исполняемым на целевой платформе.

Полученный запрос может содержать плейсхолдеры, которые будут заменены фактическими значениями при выполнении запроса, поэтому его лучше всего использовать с подготовленными операторами.

Параметры

Возвращает

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

Обратный вызов получит 2 параметра: первое — значение части запроса, по которой происходит итерация, а второе — имя этой части.

Пример

$query->select(['title'])->from('articles')->traverse(function ($value, $clause) {
    if ($clause === 'select') {
        var_dump($value);
    }
});

Параметры

Возвращает

Эта функция работает аналогично функции traverse(), с той разницей, что она выполняет полный обход всего дерева выражений. Это выполнит предоставленную функцию обратного вызова для каждого объекта ExpressionInterface, хранящегося внутри этого запроса на любом уровне вложения в любой части запроса.

Обратный вызов получит в качестве первого параметра текущее посещаемое выражение.

Параметры

Возвращает

Пройдёт по указанным частям.

Функции обхода могут агрегировать результаты, используя переменные в замыкании или переменные экземпляра. Этот метод может использоваться для обхода подмножества частей запроса для отображения SQL-запроса.

Обратный вызов получит 2 параметра: первое — значение части запроса, по которой происходит итерация, а второе — имя этой части.

Пример

$query->select(['title'])->from('articles')->traverse(function ($value, $clause) {
    if ($clause === 'select') {
        var_dump($value);
    }
}, ['select', 'from']);

Параметры

Возвращает

Возвращает тип этого запроса (select, insert, update, delete)

Возвращает

Добавляет полный запрос для использования совместно с оператором UNION с этим запросом. Это используется для объединения набора результатов этого запроса с набором результатов переданного запроса. Вы можете добавить столько запросов, сколько необходимо, вызывая этот метод несколько раз с различными запросами.

По умолчанию оператор UNION удалит повторяющиеся строки. Если вы хотите включить каждую строку из всех запросов, используйте unionAll().

Примеры

$union = (new Query($conn))->select(['id', 'title'])->from(['a' => 'articles']);
$query->select(['id', 'name'])->from(['d' => 'things'])->union($union);

Создаст:

SELECT id, name FROM things d UNION SELECT id, title FROM articles a

Параметры

Возвращает

Добавляет полный запрос для использования совместно с оператором UNION ALL с этим запросом. Это используется для объединения набора результатов этого запроса с набором результатов переданного запроса. Вы можете добавить столько запросов, сколько необходимо, вызывая этот метод несколько раз с различными запросами.

В отличие от UNION, UNION ALL не удалит повторяющиеся строки.

$union = (new Query($conn))->select(['id', 'title'])->from(['a' => 'articles']);
$query->select(['id', 'name'])->from(['d' => 'things'])->unionAll($union);

Создаст:

SELECT id, name FROM things d UNION ALL SELECT id, title FROM articles a

Параметры

Возвращает

Создать запрос обновления.

Может быть использован совместно с методами set() и where() для создания запросов обновления.

Параметры

Возвращает

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

Многократные вставки могут выполняться, вызывая values() более одного раза или предоставляя массив наборов значений. Кроме того, $data может быть экземпляром Query для вставки данных из другого запроса SELECT.

Параметры

Возвращает

Исключения

Добавляет условие или набор условий, используемых в предложении WHERE для данного запроса. Условия могут быть выражены как массив полей в качестве ключей с операторами сравнения в нём; значения для массива будут использоваться для сравнения поля с таким литералом. Наконец, условия могут быть выражены как одна строка или массив строк.

При использовании массивов каждая запись будет соединена со всем остальными условиями с помощью оператора AND. Последовательные вызовы этой функции также будут соединять новые заданные условия с помощью оператора AND. Кроме того, значения могут быть выражены с помощью объектов выражений, которые могут включать другие объекты запросов.

Любые созданные с помощью этого метода условия могут быть использованы с любыми запросами типа SELECT, UPDATE и DELETE.

Условия с использованием операторов:

$query->where([
    'posted >=' => new DateTime('3 days ago'),
    'title LIKE' => 'Hello W%',
    'author_id' => 1,
], ['posted' => 'datetime']);

Предыдущий пример производит:

WHERE posted >= 2012-01-27 AND title LIKE 'Hello W%' AND author_id = 1

Второй параметр используется для указания ожидаемого типа каждого переданного ключа. Допустимые типы могут быть взяты из сопоставленной с классом Database\Type.

Вложенные условия с союзы:

$query->where([
    'author_id !=' => 1,
    'OR' => ['published' => true, 'posted <' => new DateTime('now')],
    'NOT' => ['title' => 'Hello']
], ['published' => boolean, 'posted' => 'datetime']

Предыдущий пример производит:

WHERE author_id = 1 AND (published = 1 OR posted < '2012-02-01') AND NOT (title = 'Hello')

Вы можете вкладывать условия с помощью союзов, сколько захотите. Иногда вам может потребоваться определить 2 различных варианта для одного и того же ключа, в этом случае вы можете обернуть каждое условие в новый массив:

$query->where(['OR' => [['published' => false], ['published' => true]])

Что приведет к:

WHERE (published = false) OR (published = true)

Помните, что каждый раз, когда вы вызываете where() с третьим параметром, установленным в false (по умолчанию), он будет присоединять переданные условия к предыдущему хранимому списку, используя оператор AND. Кроме того, использование одного и того же ключа массива дважды в последовательных вызовах этого метода не переопределит предыдущее значение.

Использование объектов выражений:

$exp = $query->newExpr()->add(['id !=' => 100, 'author_id' != 1])->tieWith('OR');
$query->where(['published' => true], ['published' => 'boolean'])->where($exp);

Предыдущий пример производит:

WHERE (id != 100 OR author_id != 1) AND published = 1

Другие объекты запросов могут быть использованы в качестве условий для любого поля.

Добавление условий в несколько шагов:

Вы можете использовать вызываемые функции для построения сложных выражений; функции принимают в качестве первого аргумента новый объект QueryExpression, а в качестве второго — этот экземпляр запроса. Функции должны возвращать объект выражения, который будет добавлен в список условий для запроса с помощью оператора AND.

$query
  ->where(['title !=' => 'Hello World'])
  ->where(function ($exp, $query) {
    $or = $exp->or(['id' => 1]);
    $and = $exp->and(['id >' => 2, 'id <' => 10]);
   return $or->add($and);
  });

• Предыдущий пример производит:

WHERE title != 'Hello World' AND (id = 1 OR (id > 2 AND id < 10))

Условия в виде строк:

$query->where(['articles.author_id = authors.id', 'modified IS NULL']);

Предыдущий пример производит:

WHERE articles.author_id = authors.id AND modified IS NULL

Обратите внимание, что при использовании нотации массива или объектов выражений все *значения* будут корректно процитированы и автоматически преобразованы в соответствующий тип данных базы данных, тем самым защищая ваше приложение от SQL-инъекций. Однако ключи не обрабатываются как небезопасный ввод и должны быть проверены/очищены.

Если вы используете строковые условия, убедитесь, что ваши значения правильно процитированы. Самый безопасный способ — никогда не использовать строковые условия.

Параметры

Возвращает

См. также

Добавляет условие IN или набор условий, используемых в предложении WHERE для этого запроса.

Этот метод допускает пустые вводы в отличие от where(), если вы установите 'allowEmpty' в true. Будьте осторожны при использовании без надлежащей проверки.

Параметры:

• types - Ассоциативный массив имён типов, используемых для привязки значений к запросу
• allowEmpty - Разрешить пустой массив.

Параметры

Возвращает

Добавляет условие NOT IN или набор условий, используемых в предложении WHERE для этого запроса.

Этот метод допускает пустые вводы в отличие от where(), если вы установите 'allowEmpty' в true. Будьте осторожны при использовании без надлежащей проверки.

Параметры

Возвращает

Добавляет условие NOT IN или набор условий, используемых в предложении WHERE для этого запроса. Это также позволяет полю быть null с условием IS NULL, так как значение null приведет к тому, что условие NOT IN всегда будет ложным.

Этот метод допускает пустые вводы в отличие от where(), если вы установите 'allowEmpty' в true. Будьте осторожны при использовании без надлежащей проверки.

Параметры

Возвращает

Метод удобства, добавляющий условие NOT NULL в запрос.

Параметры

Возвращает

Метод удобства, добавляющий условие IS NULL в запрос.

Параметры

Возвращает

Добавляет именованное выражение окна.

Вы несете ответственность за добавление окон в том порядке, в котором этого требует ваша база данных.

Параметры

Возвращает

Добавляет новое выражение общего вида (CTE) в запрос.

Примеры:

Выражения общего вида можно передать либо в виде предварительно созданных объектов выражений:

$cte = new \Cake\Database\Expression\CommonTableExpression(
    'cte',
    $connection
        ->newQuery()
        ->select('*')
        ->from('articles')
);

$query->with($cte);

или вернуть из замыкания, которое получит новый объект выражения общего вида в качестве первого аргумента и новый пустой объект запроса в качестве второго аргумента:

$query->with(function (
    \Cake\Database\Expression\CommonTableExpression $cte,
    \Cake\Database\Query $query
 ) {
    $cteQuery = $query
        ->select('*')
        ->from('articles');

return $cte
        ->name('cte')
        ->query($cteQuery);
});

Параметры

Возвращает