Spec-Zone.ru › Laravel 10

PostgresBuilder

class PostgresBuilder extends Builder (View source)

Трейты

ParsesSearchPath
Macroable

Свойства

static protected array $macros

Зарегистрированные строковые макросы.

 из Macroable
protected Connection $connection

Экземпляр подключения к базе данных.

 из Builder
protected Grammar $grammar

Экземпляр синтаксического анализатора схемы.

 из Builder
protected Closure $resolver

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

 из Builder
static int|null $defaultStringLength

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

 из Builder
static string $defaultMorphKeyType

Тип ключа морфирования по умолчанию для отношений.

 из Builder
static bool $alwaysUsesNativeSchemaOperationsIfPossible

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

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

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

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

 from Builder
array getTables()

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

 from Builder
array getTableListing()

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

 from Builder
array getViews()

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

 from Builder
array getTypes()

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

Получить столбцы для заданной таблицы.
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 $callback = null)

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

 from Builder
Connection getConnection()

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

 from Builder
$this setConnection(Connection $connection)

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

 from Builder
void blueprintResolver(Closure $resolver)

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

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

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

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

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

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

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

Details

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 по умолчанию для миграций.

Параметры

string $type

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

void

Исключения

InvalidArgumentException

static void morphUsingUuids()

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

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

void

static void morphUsingUlids()

Установите тип ключа morph по умолчанию для миграций на 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 hasView(string $view)

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

Параметры

string $view

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

bool

array getTables()

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

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

array

array getTableListing()

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

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

array

array getViews()

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

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

array

array getTypes()

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

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

array

array getAllTables() deprecated

deprecated

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

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

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

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)

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

Параметры

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

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)

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

Параметры

Closure $resolver

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

void

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

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

Параметры

string|array|null $searchPath

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

array

array getAllViews() deprecated

deprecated

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

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

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

array
END_OF_DOCUMENT_MARKER

массив getAllTypes() устаревший

устаревший

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

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

Значение результата

массив

защищённый массив getSchemas()

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

Значение результата

массив

защищённый массив parseSchemaAndTable(string $reference)

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

Параметры

строка $reference

Значение результата

массив

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

Spec-Zone.ru

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