Разбить текст на запросы Connection::parseSqlBatch

Модуль: main — подключать отдельно не нужно

Метод Connection::parseSqlBatch разбивает текст с несколькими SQL-запросами на отдельные запросы. Метод не выполняет запросы и не обращается к базе данных.

Сигнатура метода в классе Bitrix\Main\DB\Connection:

public function parseSqlBatch($sqlBatch)

Параметры

Обязательные параметры обозначены *

Параметр Тип Описание
sqlBatch* string Задает текст с несколькими запросами

Тип в таблице описывает назначение аргумента. Сигнатура PHP не объявляет его.

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

Метод возвращает массив строк string[] — тексты запросов без разделителя и пробелов по краям. Пустые запросы в массив не попадают.

Метод разбивает текст по таким правилам.

  • Разделитель запросов — точка с запятой для MySQL и PostgreSQL. Метод берет его из SqlHelper::getQueryDelimiter.
  • Метод считает разделитель концом запроса, только если за ним идет пробел, табуляция или перевод строки. Последний запрос может заканчиваться концом текста.
  • Разделитель внутри строки в одинарных, двойных или обратных кавычках не делит запрос.
  • Текст от # или — до конца строки метод удаляет как комментарий. Правило работает для переводов строк \n и \r\n. Если строки после комментария разделены только символом \r, метод не находит конец комментария и не завершает работу.
  • Блок между $$ и $$ метод не делит. Так записывают тело функции PostgreSQL.
  • Переводы строк \r\n внутри запроса метод заменяет на \n.

Примеры

Пример. Код разбивает текст с комментарием и строкой, внутри которой есть точка с запятой:

<?php
use Bitrix\Main\Application;

require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';

$batch = "— seed data
INSERT INTO demo_api_units (CODE) VALUES ('kg; g');
INSERT INTO demo_api_units (CODE) VALUES ('m');";

print_r(Application::getConnection()->parseSqlBatch($batch));

Код выведет массив из двух запросов. Метод удалил комментарий, а точка с запятой внутри 'kg; g' запрос не разделила.

Смотрите также