Класс Query

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

Parameters

Returns

Throws

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

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

Returns

Конструктор

Parameters

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

Returns

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

Returns

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

Parameters

Returns

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

Returns

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

Returns

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

Parameters

Returns

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

Parameters

Returns

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

Parameters

Returns

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

Returns

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

Returns

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

Returns

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

Parameters

Returns

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

Parameters

Returns

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

Returns

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

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

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

Returns

See Also

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

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

Parameters

Returns

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

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

Parameters

Returns

Выполняет 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
• включения

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

Возвращает

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

Возвращает

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

Возвращает

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

Параметры

Возвращает

Передаёт каждый из результатов запроса вызываемой функции.

Параметры

Возвращает

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

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

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

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

Возвращает

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

Параметры

Возвращает

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

Параметры

Возвращает

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

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

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

Параметры

Возвращает

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

Эта функция добавит записи в граф 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 для выполнения над результатами базы данных. Как вызываемый объект map, так и вызываемый объект caller должны быть вызываемыми объектами.

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

Если третий аргумент установлен в true, предыдущие map-reducers будут удалены и заменены переданными аргументами.

Параметры

Возвращает

См. также

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

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

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

Параметры

Возвращает

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

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

Параметры

Возвращает

См. также

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

Параметры

Возвращает

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

Установка набора результатов запроса сделает 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.

Параметры

Возвращает

Исключения

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

Параметры

Возвращает