Spec-Zone.ru › Laravel 11

PostgresBuilder

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

Черты

ParsesSearchPath
Macroable

Свойства

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)

Определить, существует ли данная таблица.
bool hasView(string $view)

Определить, существует ли данное представление.
array getTables()

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

 from Builder
array getTableListing()

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

 from Builder
array getViews()

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

 from Builder
array getTypes()

Получить определяемые пользователем типы, принадлежащие базе данных.
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)

Получить индексы для данной таблицы.
array getIndexListing(string $table)

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

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

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

 from Builder
array getForeignKeys(string $table)

Получить внешние ключи для данной таблицы.
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()

Удалить все типы из базы данных.
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|null $callback = null)

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

 from Builder
Connection getConnection()

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

 from Builder
$this setConnection(Connection $connection)

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

 from Builder
void blueprintResolver(Closure $resolver)

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

 from Builder
array parseSearchPath(string|array|null $searchPath)

Разбить значение конфигурации "search_path" на массив.
array getSchemas()

Получить схемы для подключения.
array parseSchemaAndTable(string $reference)

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

Подробная информация

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.

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

void

static void morphUsingUlids()

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

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

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

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, bool $fullDefinition = false)

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

Параметры

string $table
string $column
bool $fullDefinition

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

string

array getColumnListing(string $table)

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

Параметры

string $table

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

array

array getColumns(string $table)

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

Параметры

string $table

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

array

array getIndexes(string $table)

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

Параметры

string $table

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

array

array getIndexListing(string $table)

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

Параметры

string $table

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

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)

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

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

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)

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

Parameters

Closure $resolver

Return Value

void

protected array parseSearchPath(string|array|null $searchPath)

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

Parameters

string|array|null $searchPath

Return Value

array

protected array getSchemas()

Получить схемы для соединения.

Return Value

array

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/PostgresBuilder.html

Spec-Zone.ru

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