Создать таблицу Entity::createDbTable

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

Доступно с версии: 14.5.1

Метод Entity::createDbTable создает таблицу сущности в базе данных. Метод выполняет запросы из compileDbTableStructureDump. Метод нужен в установщике модуля и для сущностей на лету.

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

public function createDbTable()

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

Метод ничего не возвращает.

Особенности

  • Если таблица уже есть, MySQL не изменит ее. Если у сущности есть поля с unique = true, повторный вызов завершится ошибкой SQL: запрос создания индекса не проверяет, есть ли индекс.
  • Метод не удаляет таблицу. Для удаления используйте Connection::dropTable.

Примеры

Пример. Код создает таблицу, проверяет ее и удаляет:

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

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

$entity = Entity::compileEntity('DemoUnit', [
    new IntegerField('ID', ['primary' => true, 'autocomplete' => true]),
    new StringField('NAME'),
], ['namespace' => 'Vendor\Units', 'table_name' => 'demo_api_units']);

$connection = $entity->getConnection();
$entity->createDbTable();

var_dump($connection->isTableExists('demo_api_units'));
$connection->dropTable('demo_api_units');

Код выведет bool(true).

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