Spec-Zone.ru › Laravel 10

SqlServerBuilder

класс SqlServerBuilder расширяет 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()

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

 from Builder
array getTableListing()

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

 from Builder
array getViews()

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

 from Builder
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)

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

 from Builder
array getIndexes(string $table)

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

 from Builder
array getIndexListing(string $table)

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

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

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

 from Builder
array getForeignKeys(string $table)

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

 from Builder
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()

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

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

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

 из Builder
bool enableForeignKeyConstraints()

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

 из Builder
bool disableForeignKeyConstraints()

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

 из Builder
mixed withoutForeignKeyConstraints(Closure $callback)

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

 из Builder
void build(Blueprint $blueprint)

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

 из Builder
Проект createBlueprint(string $table, Closure $callback = null)

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

 из Библиотеки
Подключение getConnection()

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

 из Библиотеки
$this setConnection(Подключение $connection)

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

 из Библиотеки
void blueprintResolver(Closure $resolver)

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

 из Библиотеки
массив getAllViews() устаревший

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

Подробности

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

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

Параметры

строка $name
объект|вызываемый $macro

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

void

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

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

Параметры

объект $mixin
булево $replace

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

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

Параметры

строка $name

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

bool

static void flushMacros()

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

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

void

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

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

Параметры

строка $method
массив $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()

Установить тип ключа морфинга по умолчанию для миграций на 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() deprecated

deprecated

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

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

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

array

bool hasColumn(string $table, string $column)

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

Parameters

string $table
string $column

Return Value

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)

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

Параметры

строка $table
строка|массив $index
строка|null $type

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

bool

array getForeignKeys(string $table)

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

Параметры

строка $table

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

массив

void table(string $table, Closure $callback)

Изменить таблицу в схеме.

Параметры

строка $table
Closure $callback

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

void

void create(string $table, Closure $callback)

Создать новую таблицу в схеме.

Параметры

строка $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)

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

Параметры

string $table
Closure $callback

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

Blueprint

Connection getConnection()

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

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

Connection

$this setConnection(Connection $connection)

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

Параметры

Connection $connection

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

$this

void blueprintResolver(Closure $resolver)

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

Параметры

Closure $resolver

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

void

array getAllViews() deprecated

deprecated

Will будет удалён в будущей версии 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/SqlServerBuilder.html

Spec-Zone.ru

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