Builder

class Builder (View source)

Свойства

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

Traits

Macroable

Методы

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.
static void	useNativeSchemaOperationsIfPossible(bool $value = true) Попытаться использовать родные операции со схемой для удаления, переименования и изменения столбцов, даже если установлен Doctrine DBAL.
bool	createDatabase(string $name) Создать базу данных в схеме.
bool	dropDatabaseIfExists(string $name) Удалить базу данных из схемы, если она существует.
bool	hasTable(string $table) Определить, существует ли заданная таблица.
bool	hasView(string $view) Определить, существует ли заданный вид.
array	getTables() Получить таблицы, принадлежащие базе данных.
array	getTableListing() Получить имена таблиц, принадлежащих базе данных.
array	getViews() Получить представления, принадлежащие базе данных.
array	getTypes() Получить пользовательские типы, принадлежащие базе данных.
array	getAllTables() deprecated Получить все имена таблиц для базы данных.
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 $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)

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

Параметры

string

$type

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

void

Исключения

InvalidArgumentException

static void morphUsingUuids()

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

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

void

static void morphUsingUlids()

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

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

void

static void useNativeSchemaOperationsIfPossible(bool $value = true)

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

Параметры

bool

$value

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

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

array getAllTables() deprecated

deprecated

Будет удалено в будущей версии Laravel.

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

Значение возвращаемого значения

array

Исключения

LogicException

bool hasColumn(string $table, string $column)

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

Параметры

string	$table
string	$column

Значение возвращаемого значения

bool

bool hasColumns(string $table, array $columns)

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

Параметры

string	$table
array	$columns

Значение возвращаемого значения

bool

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

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

Параметры

string	$table
string	$column
Closure	$callback

Значение возвращаемого значения

void

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

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

Параметры

string	$table
string	$column
Closure	$callback

Значение возвращаемого значения

void

string getColumnType(string $table, string $column, bool $fullDefinition = false)

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

Параметры

string	$table
string	$column
bool	$fullDefinition

Значение возвращаемого значения

string

array getColumnListing(string $table)

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

Параметры

string

$table

Значение возвращаемого значения

array

array getColumns(string $table)

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

Параметры

string

$table

Значение возвращаемого значения

array

array getIndexes(string $table)

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

Параметры

string

$table

Значение возвращаемого значения

array

array getIndexListing(string $table)

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

Параметры

string

$table

Значение возвращаемого значения

array

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

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

Параметры

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

Значение возвращаемого значения

bool

array getForeignKeys(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 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/10.x/Illuminate/Database/Schema/Builder.html