Класс Query

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

Параметры

Возвращает

Исключения

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

Обрабатывает клонирование eager loaders.

Возвращает

Конструктор

Параметры

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

Возвращает

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

Возвращает

Используется для рекурсивного добавления типов столбцов связанных ассоциаций в запрос.

Параметры

Возвращает

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

Возвращает

Устанавливает типы по умолчанию для преобразования полей в предложении SELECT

Возвращает

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

Параметры

Возвращает

Декорирует итератор результатов с помощью подпрограмм MapReduce и форматировщиков

Параметры

Возвращает

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

Параметры

Возвращает

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

Возвращает

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

Возвращает

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

Возвращает

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

Параметры

Возвращает

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

Параметры

Возвращает

Выполняет и возвращает COUNT(*) для запроса.

Возвращает

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

В частности, добавляет предложение FROM, добавляет поля таблицы по умолчанию, если они не указаны, и применяет соединения, необходимые для загрузки связанных данных, определенных с помощью contain

Он также устанавливает типы по умолчанию для столбцов в предложении select

Возвращает

См. также

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

Этот метод возвращает тот же объект запроса для цепочки вызовов.

Параметры

Возвращает

Возвращает массив ключ => значение, представляющий одно поле с псевдонимом, которое может быть передано напрямую в метод select(). Ключ будет содержать псевдоним, а значение — фактическое имя поля.

Если поле уже имеет псевдоним, оно не будет изменено. Если $alias не передан, будет использоваться таблица по умолчанию для этого запроса.

Параметры

Возвращает

Выполняет aliasField() для каждого поля в предоставленном списке и возвращает результат в виде одного массива.

Параметры

Возвращает

Получить результаты для данного запроса.

Вернет либо набор результатов, заданных с помощью setResult(), либо выполнит этот запрос и вернёт объект ResultSetDecorator, готовый для потоковой передачи результатов.

ResultSetDecorator — это итерируемый объект, реализующий методы, найденные в Cake\Collection\Collection.

Возвращает

Исключения

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

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

Параметры

Возвращает

См. также

Подключает любые ранее определенные условия к предоставленному списку, используя оператор AND. {@see \Cake\Database\Query::andWhere()}

Важно отметить, что при вызове этой функции любое ранее заданное множество условий для этого запроса будет рассматриваться как один аргумент для оператора 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)

Параметры

Возвращает

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

Параметры

Возвращает

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

Метод принимает следующие параметры, относящиеся к частям запроса:

• fields: Соответствует методу select
• conditions: Соответствует методу where
• limit: Соответствует методу limit
• order: Соответствует методу order
• offset: Соответствует методу offset
• group: Соответствует методу group
• having: Соответствует методу having
• contain: Соответствует параметрам contain для ленивой загрузки
• join: Соответствует методу join
• page: Соответствует методу page

Все остальные параметры не повлияют на запрос, но будут сохранены как пользовательские параметры, доступные через getOptions(). Кроме того, они автоматически передаются в Model.beforeFind.

Пример:

$query->applyOptions([
  'fields' => ['id', 'name'],
  'conditions' => [
    'created >=' => '2013-01-01'
  ],
  'limit' => 10,
]);

Эквивалентно:

$query
  ->select(['id', 'name'])
  ->where(['created >=' => '2013-01-01'])
  ->limit(10)

Пользовательские параметры можно получить через getOptions():

$query->applyOptions([
  'fields' => ['id', 'name'],
  'custom' => 'value',
]);

Здесь $options будет содержать ['custom' => 'value'] (параметр fields будет применён к запросу вместо хранения, так как это параметр, относящийся к части запроса):

$options = $query->getOptions();

Параметры

Возвращает

См. также

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

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

Параметры

Возвращает

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

Если кэширование запроса включено, при его выполнении будет выполнено следующее:

• Проверить кэш на предмет $key. Если результаты есть, SQL не будет выполняться. Вместо этого будут возвращены кэшированные результаты.
• Когда кэшированные данные устарели/отсутствуют, набор результатов будет кэширован по мере выполнения запроса.

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

// Simple string key + config
$query->cache('my_key', 'db_results');

// Function to generate key.
$query->cache(function ($q) {
  $key = serialize($q->clause('select'));
  $key .= serialize($q->clause('where'));
  return md5($key);
});

// Using a pre-built cache engine.
$query->cache('my_key', $engine);

// Disable caching
$query->cache(false);

Параметры

Возвращает

Исключения

Группирует результаты в массивы по $size строк каждый.

Параметры

Возвращает

Возвращает любые данные, которые были сохранены в указанной части. Это полезно для изменения любой внутренней части запроса, и оно используется диалектами 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: булево значение
• from: массив таблиц
• join: массив
• set: массив
• where: QueryExpression, вернёт null, если не задано
• group: массив
• having: QueryExpression, вернёт null, если не задано
• order: OrderByExpression, вернёт null, если не задано
• limit: целое число или QueryExpression, null, если не задано
• offset: целое число или QueryExpression, null, если не задано
• union: массив

Параметры

Возвращает

Исключения

Создаёт копию текущего запроса, вызывает beforeFind и сбрасывает некоторые состояния.

Будут очищены следующие состояния:

• autoFields
• limit
• offset
• функции map/reduce
• форматировщики результатов
• order
• содержания

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

Возвращает

Очищает сохранённые ассоциации из текущего запроса.

Возвращает

Очищает внутренний кэш результатов и внутреннее значение счётчика текущего объекта запроса.

Возвращает

Возвращает значения столбца $v по индексу столбца $k, сгруппированные по $g.

Параметры

Возвращает

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

Пример:

// Bring articles' author information
$query->contain('Author');

// Also bring the category and tags associated to each article
$query->contain(['Category', 'Tag']);

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

Пример:

// Eager load the product info, and for each product load other 2 associations
$query->contain(['Product' => ['Manufacturer', 'Distributor']);

// Which is equivalent to calling
$query->contain(['Products.Manufactures', 'Products.Distributors']);

// For an author query, load his region, state and country
$query->contain('Regions.States.Countries');

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

Пример:

$query->contain(['Tags' => function ($q) {
    return $q->where(['Tags.is_popular' => true]);
}]);

$query->contain(['Products.Manufactures' => function ($q) {
    return $q->select(['name'])->where(['Manufactures.active' => true]);
}]);

Каждая ассоциация может определять специальные параметры при ленивой загрузке. Допустимые параметры, которые можно задать для каждой ассоциации:

• foreignKey: Используется для установки другого поля для сопоставления обеих таблиц. Если установлено в false, не будут автоматически генерироваться условия соединения. false может использоваться только для присоединяемых ассоциаций и не может использоваться с ассоциациями hasMany или belongsToMany.
• fields: Массив с полями, которые должны быть извлечены из ассоциации.
• finder: Искатель для использования при загрузке связанных записей. Либо имя искателя как строка, либо массив для определения параметров для передачи искателю.
• queryBuilder: Эквивалентно передаче вызова вместо массива параметров.

Пример:

// Set options for the hasMany articles that will be eagerly loaded for an author
$query->contain([
    'Articles' => [
        'fields' => ['title', 'author_id']
    ]
]);

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

// Retrieve translations for the articles, but only those for the `en` and `es` locales
$query->contain([
    'Articles' => [
        'finder' => [
            'translations' => [
                'locales' => ['en', 'es']
            ]
        ]
    ]
]);

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

// Use a query builder to add conditions to the containment
$query->contain('Authors', function ($q) {
    return $q->where(...); // add conditions
});
// Use special join conditions for multiple containments in the same method call
$query->contain([
    'Authors' => [
        'foreignKey' => false,
        'queryBuilder' => function ($q) {
            return $q->where(...); // Add full filtering conditions
        }
    ],
    'Tags' => function ($q) {
        return $q->where(...); // add conditions
    }
]);

Если вызвано с пустым первым аргументом и $override установлено в true, предыдущий список будет очищен.

Параметры

Возвращает

Возвращает общее количество результатов для запроса.

Возвращает COUNT(*) для запроса. Если запрос не был изменён и подсчёт уже был выполнен, возвращается кэшированное значение.

Возвращает

Возвращает количество уникальных значений для столбца

Параметры

Возвращает

Регистрирует вызываемую функцию, которая будет выполнена при вызове метода count в этом запросе. Возвращаемое значение функции будет установлено как возвращаемое значение метода count.

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

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

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

Параметры

Возвращает

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

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

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

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

Пример

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

Параметры

Возвращает

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

Изменяет тип запроса на 'delete'. Может быть объединён с методом 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);

Параметры

Возвращает

Передаёт каждый результат запроса в вызываемый объект

Параметры

Возвращает

Устанавливает экземпляр запроса как запрос с ленивой загрузкой. Если аргумент не передан, возвращается текущее значение конфигурированного запроса _eagerLoaded.

Параметры

Возвращает

Устанавливает, следует ли ORM автоматически добавлять поля.

По умолчанию вызов select() отключит автополя. Вы можете повторно включить автополя с помощью этого метода.

Параметры

Возвращает

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

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

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

Параметры

Возвращает

Переключает гидратацию сущностей.

Если установлено значение false, для запроса будут возвращены результаты массива.

Параметры

Возвращает

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

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

Возвращает

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

Примеры:

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

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

Параметры

Возвращает

Возвращает true, если все результаты проходят проверку вызываемого объекта

Параметры

Возвращает

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

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

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

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

Возвращает

Возвращает новый объект 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

Параметры

Возвращает

Извлекает один столбец из каждой строки

Параметры

Возвращает

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

Параметры

Возвращает

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

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

$repository->find('all')->find('recent');

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

Параметры

Возвращает

Возвращает первый результат выполнения этого запроса. Если запрос еще не выполнен, он установит условие ограничения до 1 для повышения производительности.

Пример:

$singleUser = $query->select(['id', 'username'])->first();

Возвращает

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

Возвращает

Исключения

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

Если второй аргумент установлен в true, он удалит предыдущие форматировщики и заменит их переданным первым аргументом.

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

Функции обратного вызова форматирования будут получать два аргумента: первый — объект, реализующий \Cake\Collection\CollectionInterface, который можно перебирать и изменять по своему усмотрению. Второй — экземпляр запроса, к которому применяется функция обратного вызова форматирования.

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

Примеры:

Возвращает все результаты из таблицы, индексированные по id:

$query->select(['id', 'name'])->formatResults(function ($results) {
    return $results->indexBy('id');
});

Добавляет новый столбец в ResultSet:

$query->select(['name', 'birth_date'])->formatResults(function ($results) {
    return $results->map(function ($row) {
        $row['age'] = $row['birth_date']->diff(new DateTime)->y;

return $row;
    });
});

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

$query->formatResults(function ($results, $query) {
    return $results->map(function ($row) use ($query) {
        $data = [
            'bar' => 'baz',
        ];

if ($query->isHydrationEnabled()) {
            $row['foo'] = new Foo($data)
        } else {
            $row['foo'] = $data;
        }

return $row;
    });
});

Сохранение доступа к целевому экземпляру запроса ассоциации соединенных ассоциаций, унаследованным аргументом запроса вызова содержит:

// Assuming a `Articles belongsTo Authors` association that uses the join strategy

$articlesQuery->contain('Authors', function ($authorsQuery) {
    return $authorsQuery->formatResults(function ($results, $query) use ($authorsQuery) {
        // Here `$authorsQuery` will always be the instance
        // where the callback was attached to.

// The instance passed to the callback in the second
        // argument (`$query`), will be the one where the
        // callback is actually being applied to, in this
        // example that would be `$articlesQuery`.

// ...

return $results;
    });
});

Параметры

Возвращает

Исключения

Добавляет одну или несколько таблиц, которые будут использоваться в предложении 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(), что делает его похожим на результат набора, а не сам запрос.

Возвращает

Возвращает список ранее зарегистрированных процедур map reduce.

Возвращает

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

Пример:

$query->applyOptions(['doABarrelRoll' => true, 'fields' => ['id', 'name']);
 $query->getOptions(); // Returns ['doABarrelRoll' => true]

Возвращает

См. также

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

Возвращает

Возвращает список ранее зарегистрированных процедур форматирования.

Возвращает

Получает класс 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(), пожалуйста, обратитесь к описанию того метода для получения дополнительных деталей.

Параметры

Возвращает

Создаёт внутреннее соединение (INNER JOIN) с указанной таблицей ассоциации, сохраняя соответствие внешних ключей и настроенные условия, первоначально установленные для неё.

Эта функция добавит записи в contain граф.

Пример:

// Bring only articles that were tagged with 'cake'
$query->innerJoinWith('Tags', function ($q) {
    return $q->where(['name' => 'cake']);
});

Это создаст следующий SQL:

SELECT Articles.*
FROM articles Articles
INNER JOIN tags Tags ON Tags.name = 'cake'
INNER JOIN articles_tags ArticlesTags ON ArticlesTags.tag_id = Tags.id
  AND ArticlesTags.articles_id = Articles.id

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

Параметры

Возвращает

См. также

Создаёт запрос на вставку.

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

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

Параметры

Возвращает

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

Параметры

Возвращает

Получает, будет ли ORM автоматически добавлять поля.

По умолчанию вызов select() отключит авто-поля. Вы можете снова включить авто-поля с помощью enableAutoFields().

Возвращает

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

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

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

Возвращает

Возвращает текущее значение запроса _eagerLoaded.

Возвращает

Возвращает true, если в этом запросе не найдено результатов.

Возвращает

Возвращает текущий режим гидратации.

Возвращает

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

При включённом значении поля в результатах, возвращаемых этим запросом, будут преобразовываться в соответствующие типы данных 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

Параметры

Возвращает

См. также

Выполняет запрос и преобразует результат в JSON.

Часть интерфейса JsonSerializable.

Возвращает

Возвращает последнюю строку результата запроса.

Возвращает

Добавляет одиночное условие 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() для получения дополнительных сведений о условиях и типах.

Параметры

Возвращает

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

Эта функция добавит записи в граф contain.

Пример:

// Get the count of articles per user
$usersQuery
    ->select(['total_articles' => $query->func()->count('Articles.id')])
    ->leftJoinWith('Articles')
    ->group(['Users.id'])
    ->enableAutoFields();

Вы также можете настроить условия, переданные в LEFT JOIN:

// Get the count of articles per user with at least 5 votes
$usersQuery
    ->select(['total_articles' => $query->func()->count('Articles.id')])
    ->leftJoinWith('Articles', function ($q) {
        return $q->where(['Articles.votes >=' => 5]);
    })
    ->group(['Users.id'])
    ->enableAutoFields();

Это создаст следующий SQL:

SELECT COUNT(Articles.id) AS total_articles, Users.*
FROM users Users
LEFT JOIN articles Articles ON Articles.user_id = Users.id AND Articles.votes >= 5
GROUP BY USers.id

Возможна левая связь с глубокими ассоциациями с использованием нотации точки

Пример:

// Total comments in articles by 'markstory'
$query
    ->select(['total_comments' => $query->func()->count('Comments.id')])
    ->leftJoinWith('Comments.Users', function ($q) {
        return $q->where(['username' => 'markstory']);
    })
   ->group(['Users.id']);

Обратите внимание, что запрос, переданный в замыкание, будет принимать только вызовы select, where, andWhere и orWhere. Если вам нужно добавить более сложные условия, вы можете сделать это непосредственно в основном запросе.

Параметры

Возвращает

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

Примеры

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

Параметры

Возвращает

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

Параметры

Возвращает

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

Процедура MapReduce будет выполняться только при выполнении запроса и попытке извлечения первого результата.

Если третий аргумент установлен в true, он удалит предыдущие функции map и reduce и заменит их переданными аргументами.

Параметры

Возвращает

См. также

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

Эта функция добавит записи в граф contain.

Пример:

// Bring only articles that were tagged with 'cake'
$query->matching('Tags', function ($q) {
    return $q->where(['name' => 'cake']);
});

Возможно фильтровать по глубоким ассоциациям с использованием нотации точки:

Пример:

// Bring only articles that were commented by 'markstory'
$query->matching('Comments.Users', function ($q) {
    return $q->where(['username' => 'markstory']);
});

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

Пример:

// Bring unique articles that were commented by 'markstory'
$query->distinct(['Articles.id'])
    ->matching('Comments.Users', function ($q) {
        return $q->where(['username' => 'markstory']);
    });

Обратите внимание, что запрос, переданный в замыкание, будет принимать только вызовы select, where, andWhere и orWhere. Если вам нужно добавить более сложные условия, вы можете сделать это непосредственно в главном запросе.

Параметры

Возвращает

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

Параметры

Возвращает

Возвращает минимальное значение для одного столбца во всех результатах.

Параметры

Возвращает

Добавляет один или несколько модификаторов 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

Параметры

Возвращает

Создаёт древовидную структуру путём вложенности значений столбца $p в тот, который имеет то же значение для $k, используя $n в качестве ключа вложенности.

Параметры

Возвращает

Возвращает новый объект 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

Параметры

Возвращает

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

Эта функция добавит записи в граф contain.

Пример:

// Bring only articles that were not tagged with 'cake'
$query->notMatching('Tags', function ($q) {
    return $q->where(['name' => 'cake']);
});

Возможно фильтровать по глубоким ассоциациям с использованием нотации точки:

Пример:

// Bring only articles that weren't commented by 'markstory'
$query->notMatching('Comments.Users', function ($q) {
    return $q->where(['username' => 'markstory']);
});

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

Пример:

// Bring unique articles that were commented by 'markstory'
$query->distinct(['Articles.id'])
    ->notMatching('Comments.Users', function ($q) {
        return $q->where(['username' => 'markstory']);
    });

Обратите внимание, что запрос, переданный в замыкание, будет принимать только вызовы select, where, andWhere и orWhere. Если вам нужно добавить более сложные условия, вы можете сделать это непосредственно в главном запросе.

Параметры

Возвращает

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

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

Примеры

$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']);

Превратится в:

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

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

Параметры

Возвращает

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

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

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

Параметры

Возвращает

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

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

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

Параметры

Возвращает

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

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

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

Параметры

Возвращает

Исключения

Складывает все результаты в одно значение с помощью вызываемой функции.

Параметры

Возвращает

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

Параметры

Возвращает

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

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

Параметры

Возвращает

Устанавливает объект Table по умолчанию, который будет использоваться этим запросом и сформирует условие FROM.

Параметры

Возвращает

Добавляет одно условие 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() для выбора полей по умолчанию из таблицы.

Если вы передаёте экземпляр класса Cake\ORM\Table или Cake\ORM\Association, все поля в схеме таблицы или ассоциации будут добавлены в условие select.

Параметры

Возвращает

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

Parameters

Returns

Throws

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

Examples

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

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

Parameters

Returns

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

Parameters

Returns

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

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

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

Parameters

Returns

See Also

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

Parameters

Returns

Установить результирующий набор для запроса.

Установка результирующего набора запроса сделает execute() не выполняющим никаких действий. Вместо выполнения SQL-запроса и извлечения результатов будет возвращен ResultSet, предоставленный этому методу.

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

Parameters

Returns

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

Parameters

Returns

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

Parameters

Returns

Перезаписать текущий связыватель значений

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

Parameters

Returns

В памяти случайным образом упорядочивает возвращаемые результаты

Returns

Пропускает некоторые строки с начала результата запроса.

Parameters

Returns

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

Parameters

Returns

Сортирует запрос с помощью обратного вызова

Parameters

Returns

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

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

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

Parameters

Returns

Возвращает каждую строку, пока вызываемый объект не вернет true.

Parameters

Returns

Возвращает новый запрос, в котором отключено автоматическое присвоение псевдонимов полей.

Parameters

Returns

Возвращает сумму всех значений для одного столбца

Parameters

Returns

Ограничение и смещение для результатов запроса в оперативной памяти.

Параметры

Возвращает

Возвращает массив ключ-значение с результатами этого запроса.

Возвращает

Возвращает массив с индексами результатов этого запроса.

Возвращает

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

Обратный вызов получит 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']);

Параметры

Возвращает

Вызвать событие beforeFind для объекта репозитория запроса.

Будет вызван не более одного раза и только для запросов выбора.

Возвращает

Возвращает тип этого запроса (выбор, вставка, обновление, удаление)

Возвращает

Добавляет завершённый запрос для использования в сочетании с оператором 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

Параметры

Возвращает

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

Это изменяет тип запроса на 'update'. Может быть объединён с методами 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() с третьим параметром, установленным в 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);
});

Параметры

Возвращает

Возвращает первый результат как из запроса, так и из $c в массиве, затем второй результат и так далее.

Параметры

Возвращает

Возвращает каждый из результатов, полученных при вызове $c с первой строкой запроса и каждым из элементов, затем второй строкой и так далее.

Параметры

Возвращает