Builder

класс Builder (View source)

Черты

Свойства

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

Методы

static void	macro(string $name, object\|callable $macro) Зарегистрировать пользовательский макрос.	из Macroable
static void	mixin(object $mixin, bool $replace = true) Включить другой объект в класс.	из Macroable
static bool	hasMacro(string $name) Проверить, зарегистрирован ли макрос.	из Macroable
static void	flushMacros() Очистить существующие макросы.	из Macroable
static mixed	__callStatic(string $method, array $parameters) Динамически обрабатывать вызовы класса.	из Macroable
mixed	__call(string $method, array $parameters) Динамически обрабатывать вызовы класса.	из Macroable
void	__construct(Connection $connection) Создать новый менеджер схемы базы данных.
static void	defaultStringLength(int $length) Установить длину строки по умолчанию для миграций.
static void	defaultMorphKeyType(string $type) Установить тип ключа морфинга по умолчанию для миграций.
static void	morphUsingUuids() Установить тип ключа морфинга по умолчанию для миграций на UUID.
static void	morphUsingUlids() Установить тип ключа морфинга по умолчанию для миграций на ULID.
bool	createDatabase(string $name) Создать базу данных в схеме.
bool	dropDatabaseIfExists(string $name) Удалить базу данных из схемы, если база данных существует.
bool	hasTable(string $table) Определить, существует ли данная таблица.
bool	hasView(string $view) Определить, существует ли данное представление.
array	getTables() Получить таблицы, принадлежащие базе данных.
array	getTableListing() Получить имена таблиц, принадлежащих базе данных.
array	getViews() Получить представления, принадлежащие базе данных.
array	getTypes() Получить определяемые пользователем типы, принадлежащие базе данных.
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, bool $fullDefinition = false) Получить тип данных для данного имени столбца.
array	getColumnListing(string $table) Получить список столбцов для данной таблицы.
array	getColumns(string $table) Получить столбцы для данной таблицы.
array	getIndexes(string $table) Получить индексы для данной таблицы.
array	getIndexListing(string $table) Получить имена индексов для данной таблицы.
bool	hasIndex(string $table, string\|array $index, string\|null $type = null) Определить, имеет ли данная таблица данный индекс.
array	getForeignKeys(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	rename(string $from, string $to) Переименовать таблицу в схеме.
bool	enableForeignKeyConstraints() Включить ограничения внешних ключей.
bool	disableForeignKeyConstraints() Отключить ограничения внешних ключей.
mixed	withoutForeignKeyConstraints(Closure $callback) Отключить ограничения внешних ключей во время выполнения обратного вызова.
void	build(Blueprint $blueprint) Выполнить чертеж для построения/изменения таблицы.
Blueprint	createBlueprint(string $table, Closure\|null $callback = null) Создать новый набор команд с Closure.

Connection	getConnection() Получить экземпляр подключения к базе данных.
$this	setConnection(Connection $connection) Установить экземпляр подключения к базе данных.
void	blueprintResolver(Closure $resolver) Установить обратный вызов разрешителя схемы Blueprint.

Подробности

static void macro(string $name, object|callable $macro)

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

Параметры

string	$name
object\|callable	$macro

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

void

static void mixin(object $mixin, bool $replace = true)

Смешать другой объект в класс.

Параметры

object	$mixin
bool	$replace

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

Проверяет, зарегистрирован ли макрос.

Параметры

string

$name

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

bool

static void flushMacros()

Очистить существующие макросы.

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

void

static mixed __callStatic(string $method, array $parameters)

Динамически обрабатывает вызовы класса.

Параметры

string	$method
array	$parameters

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

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

Динамически обрабатывает вызовы класса.

Параметры

string	$method
array	$parameters

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

mixed

Исключения

BadMethodCallException

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

static void morphUsingUlids()

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

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

void

bool createDatabase(string $name)

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

Параметры

string

$name

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

bool

Исключения

LogicException

bool dropDatabaseIfExists(string $name)

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

Параметры

string

$name

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

bool

Исключения

LogicException

bool hasTable(string $table)

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

Параметры

string

$table

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

bool

bool hasView(string $view)

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

Параметры

string

$view

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

bool

array getTables()

Получить таблицы, принадлежащие базе данных.

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

array

array getTableListing()

Получить имена таблиц, принадлежащих базе данных.

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

array

array getViews()

Получить представления, принадлежащие базе данных.

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

array

array getTypes()

Получить определенные пользователем типы, принадлежащие базе данных.

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

array

bool hasColumn(string $table, string $column)

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

Параметры

string	$table
string	$column

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

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, bool $fullDefinition = false)

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

Parameters

string	$table
string	$column
bool	$fullDefinition

Return Value

string

array getColumnListing(string $table)

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

Parameters

string

$table

Return Value

array

array getColumns(string $table)

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

Parameters

string

$table

Return Value

array

array getIndexes(string $table)

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

Parameters

string

$table

Return Value

array

array getIndexListing(string $table)

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

Parameters

string

$table

Return Value

array

bool hasIndex(string $table, string|array $index, string|null $type = null)

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

Parameters

string	$table
string\|array	$index
string\|null	$type

Return Value

bool

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

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

Return Value

void

Exceptions

LogicException

void dropAllTypes()

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

Return Value

void

Exceptions

LogicException

void rename(string $from, string $to)

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

Parameters

string	$from
string	$to

Return Value

void

bool enableForeignKeyConstraints()

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

Return Value

bool

bool disableForeignKeyConstraints()

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

Return Value

bool

mixed withoutForeignKeyConstraints(Closure $callback)

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

Parameters

Closure

$callback

Return Value

mixed

protected void build(Blueprint $blueprint)

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

Parameters

Blueprint

$blueprint

Return Value

void

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

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

Parameters

string	$table
Closure\|null	$callback

Return Value

Blueprint

Connection getConnection()

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

Return Value

Connection

$this setConnection(Connection $connection)

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

Parameters

Connection

$connection

Return Value

$this

void blueprintResolver(Closure $resolver)

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

Parameters

Closure

$resolver

Return Value

void

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