SQLiteBuilder

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

Черты

Свойства

static protected array	$macros	Зарегистрированные строковые макросы.	из Macroable
protected Connection	$connection	Экземпляр подключения к базе данных.	из Builder
protected Grammar	$grammar	Экземпляр грамматики схемы.	из Builder
protected Closure	$resolver	Обратный вызов решателя Blueprint.	из Builder
static int\|null	$defaultStringLength	Длина строки по умолчанию для миграций.	из Builder
static string	$defaultMorphKeyType	Тип ключа морфизма по умолчанию.	из 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) Создать базу данных в схеме.
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
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) Получить индексы для данной таблицы.	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

END_OF_DOCUMENT_MARKER

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
bool	setBusyTimeout(int $milliseconds) Установить таймаут ожидания.
bool	setJournalMode(string $mode) Установить режим журнала.
bool	setSynchronous(int $mode) Установить синхронный режим.
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)

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

Параметры

string

$type

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

void

Исключения

InvalidArgumentException

static void morphUsingUuids()

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

Return Value

void

static void morphUsingUlids()

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

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

Parameters

bool

$withSize

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)

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

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)

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

Parameters

Closure

$resolver

Return Value

void

bool setBusyTimeout(int $milliseconds)

Установить таймаут ожидания.

Parameters

int

$milliseconds

Return Value

bool

bool setJournalMode(string $mode)

Установить режим журнала.

Parameters

string

$mode

Return Value

bool

bool setSynchronous(int $mode)

Установить синхронный режим.

Parameters

int

$mode

Return Value

bool

void refreshDatabaseFile()

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

Return Value

void

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