Класс 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-представление этого запроса и выполняет его с использованием объекта подключение. Возвращает объект результирующего запроса.

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

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

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

Возвращает

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

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

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

Параметры

Возвращает

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

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

По умолчанию эта функция добавит любой переданный аргумент в список таблиц для выбора, если только второй аргумент не установлен в 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 модификаторов, которые будут использоваться в 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->expr(); // Returns an empty expression object
$expression = $query->expr('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 отвечает за генерацию заглушек запроса и временную привязку значений к этим заглушкам, чтобы они могли быть правильно переданы объекту statement.

Параметры

Возвращает

Возвращает 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')

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

$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);
});

Параметры

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