MySqlBuilder

class MySqlBuilder extends Builder (View source)

Свойства

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

Методы

static void	macro(string $name, object\|callable $macro) Зарегистрировать пользовательскую макрокоманду.	from Macroable
static void	mixin(object $mixin, bool $replace = true) Включить другой объект в класс.	from Macroable
static bool	hasMacro(string $name) Проверка регистрации макрокоманды.	from Macroable
static void	flushMacros() Очистить существующие макрокоманды.	from Macroable
static mixed	__callStatic(string $method, array $parameters) Динамичная обработка вызовов класса.	from Macroable
mixed	__call(string $method, array $parameters) Динамичная обработка вызовов класса.	from Macroable
void	__construct(Connection $connection) Создать новый менеджер схемы базы данных.	from Builder
static void	defaultStringLength(int $length) Установить длину по умолчанию для строк в миграциях.	from Builder
static void	defaultMorphKeyType(string $type) Установить тип ключа по умолчанию для морфинга в миграциях.	from Builder
static void	morphUsingUuids() Установить тип ключа по умолчанию для морфинга на UUID в миграциях.	from Builder
static void	morphUsingUlids() Установить тип ключа по умолчанию для морфинга на ULID в миграциях.	from Builder
bool	createDatabase(string $name) Создать базу данных в схеме.
bool	dropDatabaseIfExists(string $name) Удалить базу данных из схемы, если она существует.
bool	hasTable(string $table) Определить, существует ли указанная таблица.	from Builder
bool	hasView(string $view) Определить, существует ли указанный вид.	from Builder
array	getTables() Получить таблицы для базы данных.
array	getTableListing() Получить имена таблиц, принадлежащих базе данных.	from Builder
array	getViews() Получить представления для базы данных.
array	getTypes() Получить пользовательские типы, принадлежащие базе данных.	from Builder
bool	hasColumn(string $table, string $column) Определить, содержит ли указанная таблица указанный столбец.	from Builder
bool	hasColumns(string $table, array $columns) Определить, содержит ли указанная таблица указанные столбцы.	from Builder
void	whenTableHasColumn(string $table, string $column, Closure $callback) Выполнить обратный вызов конструктора таблицы, если указанная таблица имеет указанный столбец.	from Builder
void	whenTableDoesntHaveColumn(string $table, string $column, Closure $callback) Выполнить обратный вызов конструктора таблицы, если указанная таблица не содержит указанный столбец.	from Builder
string	getColumnType(string $table, string $column, bool $fullDefinition = false) Получить тип данных для указанного имени столбца.	from Builder
array	getColumnListing(string $table) Получить список столбцов для заданной таблицы.	from Builder
array	getColumns(string $table) Получить столбцы для заданной таблицы.
array	getIndexes(string $table) Получить индексы для заданной таблицы.
array	getIndexListing(string $table) Получить имена индексов для заданной таблицы.	from Builder
bool	hasIndex(string $table, string\|array $index, string\|null $type = null) Определить, содержит ли указанная таблица указанный индекс.	from Builder
array	getForeignKeys(string $table) Получить внешние ключи для заданной таблицы.
void	table(string $table, Closure $callback) Изменить таблицу в схеме.	from Builder
void	create(string $table, Closure $callback) Создать новую таблицу в схеме.	from Builder
void	drop(string $table) Удалить таблицу из схемы.	from Builder
void	dropIfExists(string $table) Удалить таблицу из схемы, если она существует.	from Builder

void	dropColumns(string $table, string\|array $columns) Удаление столбцов из схемы таблицы.	из Builder
void	dropAllTables() Удаление всех таблиц из базы данных.
void	dropAllViews() Удаление всех представлений из базы данных.
void	dropAllTypes() Удаление всех типов из базы данных.	из Builder
void	rename(string $from, string $to) Переименование таблицы в схеме.	из Builder
bool	enableForeignKeyConstraints() Включение ограничений внешнего ключа.	из Builder
bool	disableForeignKeyConstraints() Отключение ограничений внешнего ключа.	из Builder
mixed	withoutForeignKeyConstraints(Closure $callback) Отключение ограничений внешнего ключа во время выполнения обратного вызова.	из Builder
void	build(Blueprint $blueprint) Выполнение проекта для создания/модификации таблицы.	из Builder
Blueprint	createBlueprint(string $table, Closure\|null $callback = null) Создание нового набора команд с помощью обратного вызова.	из Builder
Connection	getConnection() Получение экземпляра подключения к базе данных.	из Builder
$this	setConnection(Connection $connection) Установка экземпляра подключения к базе данных.	из Builder
void	blueprintResolver(Closure $resolver) Установка обратного вызова для разрешения схемы проекта.	из Builder

Подробности

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

bool createDatabase(string $name)

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

Параметры

string

$name

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

bool

END_OF_DOCUMENT_MARKER

bool dropDatabaseIfExists(string $name)

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

Параметры

string

$name

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

bool

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)

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

Параметры

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

void dropAllViews()

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

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

void

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|null $callback = null)

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

Параметры

string	$table
Closure\|null	$callback

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

Blueprint

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/11.x/Illuminate/Database/Schema/MySqlBuilder.html