Создать таблицу Connection::createTable

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

Метод Connection::createTable создает таблицу по описанию полей ORM. Метод строит запрос CREATE TABLE IF NOT EXISTS, поэтому существующую таблицу он не меняет и ошибку не выбрасывает.

Чтобы создать таблицу ORM-класса по его описанию, используйте $entity->createDbTable() объекта Entity этого класса.

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

abstract public function createTable($tableName, $fields, $primary = [], $autoincrement = []);

Параметры

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

Параметр Тип Описание
tableName* string Задает имя новой таблицы
fields* ScalarField[] Задает колонки в виде ключ => объект поля. Имя колонки метод берет из getColumnName объекта. Колонку, у которой isNullable() возвращает false, метод создает с NOT NULL
primary string[] Задает ключи массива fields, из которых метод строит первичный ключ. Каждый ключ должен быть в fields, иначе PHP выбросит ошибку \Error. По умолчанию — пустой массив
autoincrement string[] Задает ключи массива fields для автоинкрементных колонок. По умолчанию — пустой массив

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

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

Метод ничего не возвращает. Тип колонки зависит от реализации.

Реализация Тип колонок и автоинкремента
MysqliConnection Тип по объекту поля, для автоинкремента добавляет AUTO_INCREMENT. Если в настройках соединения задан ключ engine, добавляет Engine=<значение>
PgsqlConnection Тип по объекту поля. Для автоинкремента — INT, SMALLINT или BIGINT с GENERATED BY DEFAULT AS IDENTITY по размеру IntegerField

Исключения

Исключение Когда возникает
Bitrix\Main\ArgumentException Элемент массива fields не объект ScalarField
Bitrix\Main\DB\SqlQueryException База данных вернула ошибку при выполнении запроса
Bitrix\Main\DB\ConnectionException Подключиться к базе данных не удалось

Примеры

Пример. Код создает таблицу единиц измерения с автоинкрементным первичным ключом и выводит ее колонки. Блок finally удаляет таблицу:

<?php
use Bitrix\Main\Application;
use Bitrix\Main\ORM\Fields\IntegerField;
use Bitrix\Main\ORM\Fields\StringField;

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

$connection = Application::getConnection();

$connection->createTable(
    'demo_api_units',
    [
        'ID' => new IntegerField('ID'),
        'CODE' => new StringField('CODE', ['size' => 20]),
        'TITLE' => (new StringField('TITLE'))->configureNullable(),
    ],
    ['ID'],
    ['ID']
);

try
{
    print_r(array_keys($connection->getTableFields('demo_api_units')));
}
finally
{
    $connection->dropTable('demo_api_units');
}

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