Builder

класс Builder (View source)

Свойства

protected Connection	$connection	Экземпляр подключения к базе данных.
protected Grammar	$grammar	Экземпляр грамматики схемы.
protected Closure	$resolver	Обратный вызов обработчика Blueprint.
static int	$defaultStringLength	Длина строки по умолчанию для миграций.
static string	$defaultMorphKeyType	Тип ключа морфизма по умолчанию.

Методы

void

__construct(Connection $connection)

Создает новый менеджер схемы базы данных.

static void

defaultStringLength(int $length)

Устанавливает длину строки по умолчанию для миграций.

static void

defaultMorphKeyType(string $type)

Устанавливает тип ключа морфизма по умолчанию для миграций.

static void

morphUsingUuids()

Устанавливает тип ключа морфизма по умолчанию для миграций в UUID.

bool

createDatabase(string $name)

Создает базу данных в схеме.

bool

dropDatabaseIfExists(string $name)

Удаляет базу данных из схемы, если она существует.

bool

hasTable(string $table)

Определяет, существует ли данная таблица.

bool

hasColumn(string $table, string $column)

Определяет, содержит ли данная таблица данный столбец.

bool

hasColumns(string $table, array $columns)

Определяет, содержит ли данная таблица данные столбцы.

string

getColumnType(string $table, string $column)

Получает тип данных для данного имени столбца.

array

getColumnListing(string $table)

Получает список столбцов для данной таблицы.

void

table(string $table, Closure $callback)

Модифицирует таблицу в схеме.

void

create(string $table, Closure $callback)

Создает новую таблицу в схеме.

void

drop(string $table)

Удаляет таблицу из схемы.

void

dropIfExists(string $table)

Удаляет таблицу из схемы, если она существует.

void

dropColumns(string $table, string|array $columns)

Удаляет столбцы из схемы таблицы.

void

dropAllTables()

Удаляет все таблицы из базы данных.

void

dropAllViews()

Удаляет все представления из базы данных.

void

dropAllTypes()

Удаляет все типы из базы данных.

void

getAllTables()

Получает все имена таблиц для базы данных.

void

rename(string $from, string $to)

Переименовывает таблицу в схеме.

bool

enableForeignKeyConstraints()

Включает ограничения внешних ключей.

bool

disableForeignKeyConstraints()

Отключает ограничения внешних ключей.

void

build(Blueprint $blueprint)

Выполняет blueprint для построения/модификации таблицы.

Blueprint

createBlueprint(string $table, Closure $callback = null)

Создает новый набор команд с Closure.

void

registerCustomDoctrineType(string $class, string $name, string $type)

Регистрирует пользовательский тип сопоставления Doctrine.

Connection

getConnection()

Получает экземпляр подключения к базе данных.

$this

setConnection(Connection $connection)

Устанавливает экземпляр подключения к базе данных.

void

blueprintResolver(Closure $resolver)

Устанавливает обратный вызов обработчика Schema Blueprint.

Подробности

void __construct(Connection $connection)

Создает новый менеджер схемы базы данных.

Параметры

Connection

$connection

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

void

static void defaultStringLength(int $length)

Устанавливает длину строки по умолчанию для миграций.

Параметры

int

$length

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

void

static void defaultMorphKeyType(string $type)

Устанавливает тип ключа морфизма по умолчанию для миграций.

Параметры

string

$type

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

void

Исключения

InvalidArgumentException

static void morphUsingUuids()

Устанавливает тип ключа морфизма по умолчанию для миграций в UUID.

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

void

bool createDatabase(string $name)

Создает базу данных в схеме.

Параметры

string

$name

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

bool

Исключения

LogicException

END_OF_DOCUMENT_MARKER

bool dropDatabaseIfExists(string $name)

Удалить базу данных из схемы, если база данных существует.

Параметры

string

$name

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

bool

Исключения

LogicException

bool hasTable(string $table)

Определить, существует ли заданная таблица.

Параметры

string

$table

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

bool

bool hasColumn(string $table, string $column)

Определить, содержит ли заданная таблица заданный столбец.

Параметры

string	$table
string	$column

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

bool

bool hasColumns(string $table, array $columns)

Определить, содержит ли заданная таблица заданные столбцы.

Параметры

string	$table
array	$columns

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

bool

string getColumnType(string $table, string $column)

Получить тип данных для заданного имени столбца.

Параметры

string	$table
string	$column

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

string

array getColumnListing(string $table)

Получить список столбцов для заданной таблицы.

Параметры

string

$table

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

array

void table(string $table, Closure $callback)

Изменить таблицу в схеме.

Параметры

string	$table
Closure	$callback

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

void

void create(string $table, Closure $callback)

Создать новую таблицу в схеме.

Параметры

string	$table
Closure	$callback

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

void

void drop(string $table)

Удалить таблицу из схемы.

Параметры

string

$table

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

void

void dropIfExists(string $table)

Удалить таблицу из схемы, если она существует.

Параметры

string

$table

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

void

void dropColumns(string $table, string|array $columns)

Удалить столбцы из схемы таблицы.

Параметры

string	$table
string\|array	$columns

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

void

void dropAllTables()

Удалить все таблицы из базы данных.

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

void

Исключения

LogicException

void dropAllViews()

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

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

void

Исключения

LogicException

void dropAllTypes()

Удалить все типы из базы данных.

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

void

Исключения

LogicException

void getAllTables()

Получить все имена таблиц для базы данных.

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

void

Исключения

LogicException

void rename(string $from, string $to)

Переименовать таблицу в схеме.

Параметры

string	$from
string	$to

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

void

bool enableForeignKeyConstraints()

Включить ограничения внешнего ключа.

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

bool

bool disableForeignKeyConstraints()

Отключить ограничения внешнего ключа.

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

bool

protected void build(Blueprint $blueprint)

Выполнить проект для создания/изменения таблицы.

Параметры

Blueprint

$blueprint

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

void

protected Blueprint createBlueprint(string $table, Closure $callback = null)

Создать новый набор команд с Closure.

Параметры

string	$table
Closure	$callback

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

Blueprint

void registerCustomDoctrineType(string $class, string $name, string $type)

Зарегистрировать пользовательский тип сопоставления Doctrine.

Параметры

string	$class
string	$name
string	$type

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

void

Connection getConnection()

Получить экземпляр подключения к базе данных.

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

Connection

$this setConnection(Connection $connection)

Установить экземпляр подключения к базе данных.

Параметры

Connection

$connection

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

$this

void blueprintResolver(Closure $resolver)

Установить обратный вызов для разрешения схемы Blueprint.

Параметры

Closure

$resolver

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

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Database/Schema/Builder.html