Builder

class Builder (View source)

Свойства

protected Connection	$connection	Экземпляр подключения к базе данных.
protected Grammar	$grammar	Экземпляр грамматики схемы.
protected Closure	$resolver	Обратный вызов для разрешения схемы.
static int\|null	$defaultStringLength	Длина строки по умолчанию для миграций.
static string	$defaultMorphKeyType	Тип ключа по умолчанию для морфических отношений.
static bool	$alwaysUsesNativeSchemaOperationsIfPossible	Указывает, будут ли предотвращены операции Doctrine DBAL, если это возможно, при удалении и переименовании столбцов.

Методы

void

__construct(Connection $connection)

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

static void

defaultStringLength(int $length)

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

static void

defaultMorphKeyType(string $type)

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

static void

morphUsingUuids()

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

static void

morphUsingUlids()

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

static void

useNativeSchemaOperationsIfPossible(bool $value = true)

Попытка использовать собственные операции схемы для удаления и переименования столбцов, даже если установлен Doctrine DBAL.

bool

createDatabase(string $name)

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

bool

dropDatabaseIfExists(string $name)

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

bool

hasTable(string $table)

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

bool

hasColumn(string $table, string $column)

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

bool

hasColumns(string $table, array $columns)

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

void

whenTableHasColumn(string $table, string $column, Closure $callback)

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

void

whenTableDoesntHaveColumn(string $table, string $column, Closure $callback)

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

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()

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

mixed

withoutForeignKeyConstraints(Closure $callback)

Отключить ограничения внешних ключей во время выполнения коллбэка.

void

build(Blueprint $blueprint)

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

Blueprint

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

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

Connection

getConnection()

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

$this

setConnection(Connection $connection)

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

void

blueprintResolver(Closure $resolver)

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

Details

void __construct(Connection $connection)

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

Parameters

Connection

$connection

Return Value

void

static void defaultStringLength(int $length)

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

Parameters

int

$length

Return Value

void

static void defaultMorphKeyType(string $type)

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

Parameters

string

$type

Return Value

void

Exceptions

InvalidArgumentException

static void morphUsingUuids()

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

Return Value

void

static void morphUsingUlids()

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

Return Value

void

static void useNativeSchemaOperationsIfPossible(bool $value = true)

Попробовать использовать родные операции схемы для удаления и переименования столбцов, даже если Doctrine DBAL установлен.

Parameters

bool

$value

Return Value

void

bool createDatabase(string $name)

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

Parameters

string

$name

Return Value

bool

Exceptions

LogicException

bool dropDatabaseIfExists(string $name)

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

Parameters

string

$name

Return Value

bool

Exceptions

LogicException

bool hasTable(string $table)

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

Parameters

string

$table

Return Value

bool

bool hasColumn(string $table, string $column)

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

Parameters

string	$table
string	$column

Return Value

bool

bool hasColumns(string $table, array $columns)

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

Parameters

string	$table
array	$columns

Return Value

bool

void whenTableHasColumn(string $table, string $column, Closure $callback)

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

Parameters

string	$table
string	$column
Closure	$callback

Return Value

void

void whenTableDoesntHaveColumn(string $table, string $column, Closure $callback)

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

Parameters

string	$table
string	$column
Closure	$callback

Return Value

void

string getColumnType(string $table, string $column)

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

Parameters

string	$table
string	$column

Return Value

string

array getColumnListing(string $table)

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

Parameters

string

$table

Return Value

array

void table(string $table, Closure $callback)

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

Parameters

string	$table
Closure	$callback

Return Value

void

void create(string $table, Closure $callback)

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

Parameters

string	$table
Closure	$callback

Return Value

void

void drop(string $table)

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

Parameters

string

$table

Return Value

void

void dropIfExists(string $table)

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

Parameters

string

$table

Return Value

void

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

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

Parameters

string	$table
string\|array	$columns

Return Value

void

void dropAllTables()

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

Return Value

void

Exceptions

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

mixed withoutForeignKeyConstraints(Closure $callback)

Отключение ограничений внешнего ключа во время выполнения обратного вызова.

Параметры

Closure

$callback

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

mixed

protected void build(Blueprint $blueprint)

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

Параметры

Blueprint

$blueprint

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

void

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

Создание нового набора команд с помощью обратного вызова.

Параметры

string	$table
Closure	$callback

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

Blueprint

Connection getConnection()

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

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

Connection

$this setConnection(Connection $connection)

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

Параметры

Connection

$connection

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

$this

void blueprintResolver(Closure $resolver)

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

Параметры

Closure

$resolver

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

void

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