SqlHelper::prepareDeleteLimit() — параметры и описание

Сигнатура

public prepareDeleteLimit(string $tableName, array<string|int, mixed> $primaryFields, string $where, array<string|int, mixed> $order, int $limit) : string

Описание

Формирует строку DML для команды SQL DELETE для заданной таблицы с ограниченным количеством строк.

Параметры

$tableName string

Имя таблицы.

$primaryFields array<string|int, mixed>

Array("column")[] Список столбцов первичного ключа.

$where string

Конструкция SQL where.

$order array<string|int, mixed>

Array("column" => asc|desc)[] Порядок сортировки.

$limit int

Количество удаляемых строк.

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

string

Как применяется в SqlHelper

SqlHelper::prepareDeleteLimit() — метод класса \Bitrix\Main\DB\SqlHelper модуля «Главный модуль».

Метод объекта: сначала нужен экземпляр SqlHelper.

use Bitrix\Main\DB\SqlHelper;

/** @var SqlHelper $object */
$tableName = '';
$primaryFields = [];
$where = '';
$order = [];
$limit = 1;
$result = $object->prepareDeleteLimit($tableName, $primaryFields, $where, $order, $limit);
// $result: string

Другие методы SqlHelper

addDaysToDateTime() Возвращает функцию для добавления временного интервала в днях к $from.
addSecondsToDateTime() Возвращает функцию для добавления временного интервала в секундах к $from.
castToChar() Возвращает выражение CAST для преобразования поля или выражения в строку
convertDateField()
convertDatetimeField()
convertFromDb() Возвращает $value, преобразованный в тип согласно типу $field.
convertFromDbDate()
convertFromDbDateTime()
convertFromDbFloat()
convertFromDbInteger()
convertFromDbString()
convertFromDbText()

prepareDeleteLimit() есть и у других классов модуля «Главный модуль»: MssqlSqlHelper, MysqliSqlHelper, OracleSqlHelper, PgsqlSqlHelper.