MariaDbBuilder

class MariaDbBuilder extends MySqlBuilder (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	Тип ключа морфирования по умолчанию для отношений.	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) Создать базу данных в схеме.	from MySqlBuilder
bool	dropDatabaseIfExists(string $name) Удалить базу данных из схемы, если она существует.	from MySqlBuilder
bool	hasTable(string $table) Определить, существует ли указанная таблица.	from Builder
bool	hasView(string $view) Определить, существует ли указанный вид.	from Builder
array	getTables() Получить таблицы для базы данных.	from MySqlBuilder
array	getTableListing() Получить имена таблиц, принадлежащих базе данных.	from Builder
array	getViews() Получить представления для базы данных.	from MySqlBuilder
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) Получить столбцы для заданной таблицы.	from MySqlBuilder
array	getIndexes(string $table) Получить индексы для заданной таблицы.	from MySqlBuilder
array	getIndexListing(string $table) Получить имена индексов для заданной таблицы.	from Builder
bool	hasIndex(string $table, string\|array $index, string\|null $type = null) Определить, имеет ли указанная таблица указанный индекс.	from Builder
array	getForeignKeys(string $table) Получить внешние ключи для заданной таблицы.	from MySqlBuilder
void	table(string $table, Closure $callback) Изменить таблицу в схеме.	from Builder
void	create(string $table, Closure $callback) Создать новую таблицу в схеме.	from Builder

void	drop(string $table) Удалить таблицу из схемы.	из Builder
void	dropIfExists(string $table) Удалить таблицу из схемы, если она существует.	из Builder
void	dropColumns(string $table, string\|array $columns) Удалить столбцы из схемы таблицы.	из Builder
void	dropAllTables() Удалить все таблицы из базы данных.	из MySqlBuilder
void	dropAllViews() Удалить все представления из базы данных.	из MySqlBuilder
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) Установить обратный вызов для разрешения схемы Blueprint.	из 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)

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

Параметры

string

$type

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

void

Исключения

InvalidArgumentException

static void morphUsingUuids()

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

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

void

END_OF_DOCUMENT_MARKER

static void morphUsingUlids()

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

Значение возврата

void

bool createDatabase(string $name)

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

Параметры

string

$name

Значение возврата

bool

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)

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

Параметры

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/MariaDbBuilder.html