SqlServerBuilder

class SqlServerBuilder 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	Тип ключа морфирования по умолчанию для отношений.	from Builder

Методы

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) Создать новый менеджер схемы базы данных.	из Builder
static void	defaultStringLength(int $length) Установить длину строки по умолчанию для миграций.	из Builder
static void	defaultMorphKeyType(string $type) Установить тип ключа morph по умолчанию для миграций.	из Builder
static void	morphUsingUuids() Установить тип ключа morph по умолчанию для миграций на UUID.	из Builder
static void	morphUsingUlids() Установить тип ключа morph по умолчанию для миграций на ULID.	из Builder
bool	createDatabase(string $name) Создать базу данных в схеме.
bool	dropDatabaseIfExists(string $name) Удалить базу данных из схемы, если база данных существует.
bool	hasTable(string $table) Определить, существует ли данная таблица.
bool	hasView(string $view) Определить, существует ли данная представление.
array	getTables() Получить таблицы, которые принадлежат базе данных.	из Builder
array	getTableListing() Получить имена таблиц, которые принадлежат базе данных.	из Builder
array	getViews() Получить представления, которые принадлежат базе данных.	из Builder
array	getTypes() Получить определённые пользователем типы, которые принадлежат базе данных.	из Builder
bool	hasColumn(string $table, string $column) Определить, содержит ли данная таблица заданный столбец.	из Builder
bool	hasColumns(string $table, array $columns) Определить, содержит ли данная таблица заданные столбцы.	из Builder
void	whenTableHasColumn(string $table, string $column, Closure $callback) Выполнить обратный вызов билдера таблицы, если данная таблица содержит заданный столбец.	из Builder
void	whenTableDoesntHaveColumn(string $table, string $column, Closure $callback) Выполнить обратный вызов билдера таблицы, если данная таблица не содержит заданный столбец.	из Builder
string	getColumnType(string $table, string $column, bool $fullDefinition = false) Получить тип данных для заданного имени столбца.	из Builder
array	getColumnListing(string $table) Получить список столбцов для данной таблицы.	из Builder
array	getColumns(string $table) Получить столбцы для данной таблицы.
array	getIndexes(string $table) Получить индексы для данной таблицы.
array	getIndexListing(string $table) Получить имена индексов для данной таблицы.	из Builder
bool	hasIndex(string $table, string\|array $index, string\|null $type = null) Определить, содержит ли данная таблица заданный индекс.	из Builder
array	getForeignKeys(string $table) Получить внешние ключи для данной таблицы.
void	table(string $table, Closure $callback) Изменить таблицу в схеме.	из Builder
void	create(string $table, Closure $callback) Создать новую таблицу в схеме.	из Builder
void	drop(string $table) Удалить таблицу из схемы.	из Builder
void	dropIfExists(string $table) Удалить таблицу из схемы, если она существует.	из 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) Создать новый набор команд с Closure.	из Builder
Connection	getConnection() Получить экземпляр подключения к базе данных.	из Builder
$this	setConnection(Connection $connection) Установить экземпляр подключения к базе данных.	из Builder
void	blueprintResolver(Closure $resolver) Установить обратный вызов для разрешения Schema Blueprint.	из Builder
string	getDefaultSchema() Получить схему по умолчанию для подключения.
array	parseSchemaAndTable(string $reference) Обработать ссылку на объект базы данных и извлечь схему и таблицу.

Подробности

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

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

Parameters

string	$name
object\|callable	$macro

Return Value

void

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

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

Parameters

object	$mixin
bool	$replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

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

Parameters

string

$name

Return Value

bool

static void flushMacros()

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

Return Value

void

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

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

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

void __construct(Connection $connection)

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

Parameters

Connection

$connection

Return Value

void

static void defaultStringLength(int $length)

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

Parameters

int

$length

Return Value

void

static void defaultMorphKeyType(string $type)

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

Parameters

string

$type

Return Value

void

Exceptions

InvalidArgumentException

static void morphUsingUuids()

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

Return Value

void

static void morphUsingUlids()

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

Return Value

void

bool createDatabase(string $name)

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

Parameters

string

$name

Return Value

bool

bool dropDatabaseIfExists(string $name)

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

Parameters

string

$name

Return Value

bool

bool hasTable(string $table)

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

Parameters

string

$table

Return Value

bool

bool hasView(string $view)

Определить, существует ли указанный вид.

Parameters

string

$view

Return Value

bool

array getTables()

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

Return Value

array

array getTableListing()

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

Return Value

array

array getViews()

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

Return Value

array

array getTypes()

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

Return Value

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)

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

Parameters

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

Return Value

bool

array getForeignKeys(string $table)

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

Parameters

string

$table

Return Value

array

void table(string $table, Closure $callback)

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

Parameters

string	$table
Closure	$callback

Return Value

void

void create(string $table, Closure $callback)

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

Parameters

string	$table
Closure	$callback

Return Value

void

void drop(string $table)

Удалить таблицу из схемы.

Parameters

string

$table

Return Value

void

void dropIfExists(string $table)

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

Parameters

string

$table

Return Value

void

void dropColumns(string $table, string|array $columns)

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

Parameters

string	$table
string\|array	$columns

Return Value

void

void dropAllTables()

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

Return Value

void

void dropAllViews()

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

Return Value

void

void dropAllTypes()

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

Return Value

void

Exceptions

LogicException

void rename(string $from, string $to)

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

Parameters

string	$from
string	$to

Return Value

void

bool enableForeignKeyConstraints()

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

Return Value

bool

bool disableForeignKeyConstraints()

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

Return Value

bool

mixed withoutForeignKeyConstraints(Closure $callback)

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

Parameters

Closure

$callback

Return Value

mixed

protected void build(Blueprint $blueprint)

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

Parameters

Blueprint

$blueprint

Return Value

void

protected Blueprint createBlueprint(string $table, Closure|null $callback = null)

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

Parameters

string	$table
Closure\|null	$callback

Return Value

Blueprint

Connection getConnection()

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

Return Value

Connection

$this setConnection(Connection $connection)

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

Parameters

Connection

$connection

Return Value

$this

void blueprintResolver(Closure $resolver)

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

Parameters

Closure

$resolver

Return Value

void

protected string getDefaultSchema()

Получить схему по умолчанию для подключения.

Return Value

string

protected array parseSchemaAndTable(string $reference)

Разбить ссылку на объект базы данных и получить схему и таблицу.

Parameters

string

$reference

Return Value

array

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