PostgresBuilder

class PostgresBuilder extends Builder (View source)

Особенности

Свойства

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

Методы

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
static void	useNativeSchemaOperationsIfPossible(bool $value = true) Попытаться использовать собственные операции схемы для удаления и переименования столбцов, даже если установлен Doctrine DBAL.	из Builder
bool	createDatabase(string $name) Создать базу данных в схеме.
bool	dropDatabaseIfExists(string $name) Удалить базу данных из схемы, если она существует.
bool	hasTable(string $table) Определить, существует ли указанная таблица.
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) Получить тип данных для указанного имени столбца.	из Builder
array	getColumnListing(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() Удалить все типы из базы данных.
void	getAllTables() Получить все имена таблиц для базы данных.
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 $callback = null) Создать новый набор команд с Closure.	из Builder
Connection	getConnection() Получить экземпляр подключения к базе данных.	из Builder
$this	setConnection(Connection $connection) Установить экземпляр подключения к базе данных.	из Builder
void	blueprintResolver(Closure $resolver) Установить обратный вызов для разрешения Schema Blueprint.	из Builder

массив	parseSearchPath(string\|array\|null $searchPath) Разбор значения конфигурации «search_path» в массив.
массив	getAllViews() Получение всех имён представлений для базы данных.
массив	getAllTypes() Получение всех имён типов для базы данных.
массив	parseSchemaAndTable(string $reference) Разбор ссылки на объект базы данных и извлечение базы данных, схемы и таблицы.

Подробности

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

Получение типа данных для указанного столбца.

Параметры

string	$table
string	$column

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

string

array getColumnListing(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

END_OF_DOCUMENT_MARKER

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

void getAllTables()

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

Return Value

void

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

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

Parameters

string	$table
Closure	$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 array parseSearchPath(string|array|null $searchPath)

Разбор значения конфигурации "search_path" в массив.

Parameters

string|array|null

$searchPath

Return Value

array

array getAllViews()

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

Return Value

array

array getAllTypes()

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

Return Value

array

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/9.x/Illuminate/Database/Schema/PostgresBuilder.html