Класс Query

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

Параметры

Возвращает

Исключения

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

Обрабатывает клонирование загружаемых данных.

Возвращает

Конструктор

Параметры

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

Возвращает

Возвращает строковое представление этого запроса (полное 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: boolean
• 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
• containments

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

Возвращает

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

Возвращает

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

Возвращает

Возвращает значения столбца $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.

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

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

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

Параметры

Возвращает

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

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

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

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

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

Возвращает

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

Параметры

Возвращает

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

Параметры

Возвращает

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

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

$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 или даже другие объекты запросов.

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

Параметры

Возвращает

Создаёт ВНУТРЕННЕЕ объединение с переданной таблицей ассоциации, сохраняя соответствие внешних ключей и настраиваемые условия, которые были первоначально заданы для него.

Эта функция добавит записи в граф 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

Можно выполнить left join глубоких ассоциаций, используя нотацию точки

Пример:

// 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, предыдущие мап-редукторы будут удалены и заменены переданными аргументами.

Параметры

Возвращает

См. также

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

Эта функция добавит записи в 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.

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

Параметры

Возвращает

Вызывает

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

Примеры

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

$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()

Параметры

Возвращает

См. также

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

Параметры

Возвращает

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

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

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

Параметры

Возвращает

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

Параметры

Возвращает

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

Параметры

Возвращает

Перезаписывает текущий обработчик значений.

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

Параметры

Возвращает

Случайным образом меняет порядок возвращаемых результатов в памяти.

Возвращает

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

Параметры

Возвращает

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

Параметры

Возвращает

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

Параметры

Возвращает

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

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

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

Параметры

Возвращает

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

Параметры

Возвращает

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

Параметры

Возвращает

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

Параметры

Возвращает

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

Параметры

Возвращает

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

Возвращает

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

Возвращает

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

Обратный вызов получит 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-выражения.

Параметры

Возвращает

Исключения

Добавляет условие 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 с первыми строками запроса и каждым из элементов, затем вторыми строками и так далее.

Параметры

Возвращает