Spec-Zone.ru › Laravel 10

SQLiteBuilder

class SQLiteBuilder extends Builder (View source)

Трейты

Macroable

Свойства

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 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(bool $withSize = true)

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

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

 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)

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

 from Builder
Connection getConnection()

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

 from Builder
$this setConnection(Connection $connection)

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

 from Builder
void blueprintResolver(Closure $resolver)

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

 from Builder
array getAllViews() deprecated

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

Очистить файл базы данных.

Подробности

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)

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

Parameters

string $type

Return Value

void

Exceptions

InvalidArgumentException

static void morphUsingUuids()

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

Return Value

void

static void morphUsingUlids()

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

Return Value

void

static void useNativeSchemaOperationsIfPossible(bool $value = true)

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

Parameters

bool $value

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(bool $withSize = true)

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

Parameters

bool $withSize

Return Value

array

array getTableListing()

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

Return Value

array

array getViews()

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

Return Value

array

array getTypes()

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

Return Value

array

array getAllTables() deprecated

deprecated

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

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

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)

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

Параметры

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)

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

Параметры

Closure $resolver

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

void

array getAllViews() deprecated

deprecated

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

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

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

array

void refreshDatabaseFile()

Очистить файл базы данных.

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

void

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

Spec-Zone.ru

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