| Methods |
public
|
__construct(Connection $connection): void
Create a new database Schema manager.
Create a new database Schema manager.
|
#
|
public
static
|
defaultStringLength(int $length): void
Set the default string length for migrations.
Set the default string length for migrations.
|
#
|
public
static
|
defaultTimePrecision(?int $precision): void
Set the default time precision for migrations.
Set the default time precision for migrations.
|
#
|
public
static
|
defaultMorphKeyType(string $type): void
Set the default morph key type for migrations.
Set the default morph key type for migrations.
Throws
|
#
|
public
static
|
morphUsingUuids(): void
Set the default morph key type for migrations to UUIDs.
Set the default morph key type for migrations to UUIDs.
|
#
|
public
static
|
morphUsingUlids(): void
Set the default morph key type for migrations to ULIDs.
Set the default morph key type for migrations to ULIDs.
|
#
|
public
|
createDatabase(string $name): bool
Create a database in the schema.
Create a database in the schema.
|
#
|
public
|
dropDatabaseIfExists(string $name): bool
Drop a database from the schema if the database exists.
Drop a database from the schema if the database exists.
|
#
|
public
|
getSchemas(): array
Get the schemas that belong to the connection.
Get the schemas that belong to the connection.
|
#
|
public
|
hasTable(string $table): bool
Determine if the given table exists.
Determine if the given table exists.
|
#
|
public
|
hasView(string $view): bool
Determine if the given view exists.
Determine if the given view exists.
|
#
|
public
|
getTables(string|string[]|null $schema = null): array
Get the tables that belong to the connection.
Get the tables that belong to the connection.
|
#
|
public
|
getTableListing(string|string[]|null $schema = null, bool $schemaQualified = true): array
Get the names of the tables that belong to the connection.
Get the names of the tables that belong to the connection.
|
#
|
public
|
getViews(string|string[]|null $schema = null): array
Get the views that belong to the connection.
Get the views that belong to the connection.
|
#
|
public
|
getTypes(string|string[]|null $schema = null): array
Get the user-defined types that belong to the connection.
Get the user-defined types that belong to the connection.
|
#
|
public
|
hasColumn(string $table, string $column): bool
Determine if the given table has a given column.
Determine if the given table has a given column.
|
#
|
public
|
hasColumns(string $table, array $columns): bool
Determine if the given table has given columns.
Determine if the given table has given columns.
|
#
|
public
|
whenTableHasColumn(string $table, string $column, Closure $callback): void
Execute a table builder callback if the given table has a given column.
Execute a table builder callback if the given table has a given column.
|
#
|
public
|
whenTableDoesntHaveColumn(string $table, string $column, Closure $callback): void
Execute a table builder callback if the given table doesn't have a given column.
Execute a table builder callback if the given table doesn't have a given column.
|
#
|
public
|
getColumnType(string $table, string $column, bool $fullDefinition = false): string
Get the data type for the given column name.
Get the data type for the given column name.
|
#
|
public
|
getColumnListing(string $table): array
Get the column listing for a given table.
Get the column listing for a given table.
|
#
|
public
|
getColumns(string $table): array
Get the columns for a given table.
Get the columns for a given table.
|
#
|
public
|
getIndexes(string $table): array
Get the indexes for a given table.
Get the indexes for a given table.
|
#
|
public
|
getIndexListing(string $table): array
Get the names of the indexes for a given table.
Get the names of the indexes for a given table.
|
#
|
public
|
hasIndex(string $table, string|array $index, string|null $type = null): bool
Determine if the given table has a given index.
Determine if the given table has a given index.
|
#
|
public
|
getForeignKeys(string $table): array
Get the foreign keys for a given table.
Get the foreign keys for a given table.
|
#
|
public
|
table(string $table, Closure $callback): void
Modify a table on the schema.
Modify a table on the schema.
|
#
|
public
|
create(string $table, Closure $callback): void
Create a new table on the schema.
Create a new table on the schema.
|
#
|
public
|
drop(string $table): void
Drop a table from the schema.
Drop a table from the schema.
|
#
|
public
|
dropIfExists(string $table): void
Drop a table from the schema if it exists.
Drop a table from the schema if it exists.
|
#
|
public
|
dropColumns(string $table, string|array $columns): void
Drop columns from a table schema.
Drop columns from a table schema.
|
#
|
public
|
dropAllTables(): void
Drop all tables from the database.
Drop all tables from the database.
Throws
|
#
|
public
|
dropAllViews(): void
Drop all views from the database.
Drop all views from the database.
Throws
|
#
|
public
|
dropAllTypes(): void
Drop all types from the database.
Drop all types from the database.
Throws
|
#
|
public
|
rename(string $from, string $to): void
Rename a table on the schema.
Rename a table on the schema.
|
#
|
public
|
enableForeignKeyConstraints(): bool
Enable foreign key constraints.
Enable foreign key constraints.
|
#
|
public
|
disableForeignKeyConstraints(): bool
Disable foreign key constraints.
Disable foreign key constraints.
|
#
|
public
|
withoutForeignKeyConstraints(Closure $callback): mixed
Disable foreign key constraints during the execution of a callback.
Disable foreign key constraints during the execution of a callback.
|
#
|
protected
|
build(Blueprint $blueprint): void
Execute the blueprint to build / modify the table.
Execute the blueprint to build / modify the table.
|
#
|
protected
|
createBlueprint(string $table, Closure|null $callback = null): Blueprint
Create a new command set with a Closure.
Create a new command set with a Closure.
|
#
|
public
|
getCurrentSchemaListing(): string[]|null
Get the names of the current schemas for the connection.
Get the names of the current schemas for the connection.
|
#
|
public
|
getCurrentSchemaName(): string|null
Get the default schema name for the connection.
Get the default schema name for the connection.
|
#
|
public
|
parseSchemaAndTable(string $reference, string|bool|null $withDefaultSchema = null): array
Parse the given database object reference and extract the schema and table.
Parse the given database object reference and extract the schema and table.
|
#
|
public
|
getConnection(): Connection
Get the database connection instance.
Get the database connection instance.
|
#
|
public
|
blueprintResolver(Closure $resolver): void
Set the Schema Blueprint resolver callback.
Set the Schema Blueprint resolver callback.
|
#
|