Spec-Zone.ru › Laravel 10

MySqlBuilder

класс MySqlBuilder расширяет Builder (View source)

Свойства

Macroable

Свойства

static protected array $macros

Зарегистрированные макросы строк.

 from Macroable
protected Connection $connection

Экземпляр соединения с базой данных.

 from Builder
protected Grammar $grammar

Экземпляр грамматики схемы.

 from Builder
protected Closure $resolver

Обратный вызов обработчика Blueprint.

 from Builder
static int|null $defaultStringLength

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

 from Builder
static string $defaultMorphKeyType

Тип ключа по умолчанию для морфических отношений.

 from Builder
static bool $alwaysUsesNativeSchemaOperationsIfPossible

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

 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
static void useNativeSchemaOperationsIfPossible(bool $value = true)

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

 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
array getAllTables() deprecated

Получить все имена таблиц для базы данных.
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)

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

 from Builder
void dropAllTables()

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

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

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

 from Builder
void rename(string $from, string $to)

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

 from Builder
bool enableForeignKeyConstraints()

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

 from Builder
bool disableForeignKeyConstraints()

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

 from Builder
mixed withoutForeignKeyConstraints(Closure $callback)

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

 from Builder
void build(Blueprint $blueprint)

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

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

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

 from Builder
Connection getConnection()

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

 from Builder
$this setConnection(Connection $connection)

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

 из Builder
void blueprintResolver(Closure $resolver)

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

 из Builder
array getAllViews() устаревший

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

Подробности

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

static void useNativeSchemaOperationsIfPossible(bool $value = true)

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

Параметры

bool $value

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

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

array getAllTables() устаревший

устаревший

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

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

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

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

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

Параметры

string $table
Closure $callback

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

Blueprint

Connection getConnection()

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

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

Connection

$this setConnection(Connection $connection)

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

Параметры

Connection $connection

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

$this

void blueprintResolver(Closure $resolver)

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

Параметры

Closure $resolver

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

void

array getAllViews() устарело

устарело

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

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

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

array

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API