class Schema extends Facade

Constants

protected STATE_CONTEXT_KEY

The context key for the coroutine-local facade roots.

Properties

static protected Container|null $app

The application instance being facaded.

from  Facade
static protected array $resolvedInstance

The resolved object instances.

from  Facade
static protected array<string, true> $scopedAccessors

Accessors whose resolved objects belong to a coroutine scope.

from  Facade
static protected array<string, int> $coroutineAccessors

Accessors with coroutine-local roots, and their current generation.

from  Facade
static protected bool $cached

Indicates if the resolved facade should be cached.

Methods

static void
resolved(Closure $callback)

Run a Closure when the facade has been resolved.

from  Facade
static MockInterface|null
spy()

Convert the facade into a Mockery spy.

from  Facade
static MockInterface
partialMock()

Initiate a partial mock on the facade.

from  Facade
static CompositeExpectation|Expectation|HigherOrderMessage
shouldReceive()

Initiate a mock expectation on the facade.

from  Facade
static CompositeExpectation|Expectation|ExpectsHigherOrderMessage
expects()

Initiate a mock expectation on the facade.

from  Facade
static MockInterface
createFreshMockInstance()

Create a fresh mock instance for the given class.

from  Facade
static MockInterface
createMock()

Create a fresh mock instance for the given class.

from  Facade
static bool
isMock()

Determines whether a mock is set as the instance of the facade.

from  Facade
static string|null
getMockableClass()

Get the mockable class for the bound instance.

from  Facade
static void
swap(mixed $instance)

Hotswap the underlying instance behind the facade.

from  Facade
static bool
isFake()

Determines whether a "fake" has been set as the facade instance.

from  Facade
static mixed
getFacadeRoot()

Get the root object behind the facade.

from  Facade
static string
getFacadeAccessor()

Get the registered name of the component.

static mixed
resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

from  Facade
static void
clearResolvedInstance(string|null $name = null)

Clear a resolved facade instance.

from  Facade
static void
clearResolvedInstances()

Clear all of the resolved instances.

from  Facade
static Collection
defaultAliases()

Get the application default aliases.

from  Facade
static Container|null
getFacadeApplication()

Get the application instance behind the facade.

from  Facade
static void
setFacadeApplication(Container|null $app)

Set the application instance.

from  Facade
static mixed
__callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

from  Facade
static Builder
connection(string|null $name = null)

Get a schema builder instance for a connection.

static void
blueprintResolver(Closure $resolver)

No description

static void
create(string $table, Closure $callback)

No description

static bool
createDatabase(string $name)

No description

static void
createMigrationRepositoryTable(string $table)

No description

static void
createRangePartition(string $table, string $partition, array<int $, Expression|float|int|string> $from, Expression|float|int|string> $to)

No description

static void
defaultMorphKeyType(string $type)

No description

static void
defaultStringLength(int $length)

No description

static void
defaultTimePrecision(int|null $precision)

No description

static bool
disableForeignKeyConstraints()

No description

static void
drop(string $table)

No description

static void
dropAllTables()

No description

static void
dropAllTypes()

No description

static void
dropAllViews()

No description

static void
dropColumns(string $table, string[]|string $columns)

No description

static bool
dropDatabaseIfExists(string $name)

No description

static void
dropIfExists(string $table)

No description

static bool
enableForeignKeyConstraints()

No description

static void
ensureExtensionExists(string $name, string|null $schema = 'null')

No description

static void
ensureVectorExtensionExists(string|null $schema = 'null')

No description

static void
executeBlueprint(Blueprint $blueprint)

No description

static void
flushMacros()

No description

static void
flushState()

No description

static array
getColumn(string $table, string $column)

No description

static void
array()

<int, array> withoutCoveredPartitions(array<int, array> $tables, array<int, string> $except = '[]')

static string
getColumnType(string $table, string $column, bool $fullDefinition = 'false')

No description

static Connection
getConnection()

No description

static null|string[]
getCurrentSchemaListing()

No description

static string|null
getCurrentSchemaName()

No description

static bool
hasColumn(string $table, string $column)

No description

static bool
hasColumns(string $table, string[] $columns)

No description

static bool
hasForeignKey(string $table, array|string $foreignKey)

No description

static bool
hasIndex(string $table, array|string $index, string|null $type = 'null')

No description

static bool
hasMacro(string $name)

No description

static bool
hasTable(string $table)

No description

static bool
hasView(string $view)

No description

static void
macro(string $name, callable|object $macro)

No description

static void
mixin(object $mixin, bool $replace = 'true')

No description

static void
morphUsingUlids()

No description

static void
morphUsingUuids()

No description

static array
parseSchemaAndTable(string $reference, string|bool|null $withDefaultSchema = 'null')

No description

static string
qualifyIndexName(string $name)

No description

static void
rename(string $from, string $to)

No description

static void
table(string $table, Closure $callback)

No description

static void
truncateTables(array<int $, string> $tables)

No description

static void
whenTableDoesntHaveColumn(string $table, string $column, Closure $callback)

No description

static void
whenTableDoesntHaveIndex(string $table, array|string $index, Closure $callback, string|null $type = 'null')

No description

static void
whenTableHasColumn(string $table, string $column, Closure $callback)

No description

static void
whenTableHasIndex(string $table, array|string $index, Closure $callback, string|null $type = 'null')

No description

static mixed
withoutForeignKeyConstraints(Closure $callback)

No description

Details

in Facade at line 85
static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.

The callback is registered on the worker-global container and runs for every subsequent resolution of the facade accessor.

Parameters

Closure $callback

Return Value

void

in Facade at line 106
static MockInterface|null spy()

Convert the facade into a Mockery spy.

Swaps the resolved facade instance for the worker lifetime.

Return Value

MockInterface|null

in Facade at line 125
static MockInterface partialMock()

Initiate a partial mock on the facade.

Swaps the resolved facade instance for the worker lifetime.

Return Value

MockInterface

in Facade at line 142
static CompositeExpectation|Expectation|HigherOrderMessage shouldReceive()

Initiate a mock expectation on the facade.

Swaps the resolved facade instance for the worker lifetime.

Return Value

CompositeExpectation|Expectation|HigherOrderMessage

in Facade at line 159
static CompositeExpectation|Expectation|ExpectsHigherOrderMessage expects()

Initiate a mock expectation on the facade.

Swaps the resolved facade instance for the worker lifetime.

Return Value

CompositeExpectation|Expectation|ExpectsHigherOrderMessage

in Facade at line 176
static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Swaps the resolved facade instance for the worker lifetime.

Return Value

MockInterface

in Facade at line 189
static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 199
static protected bool isMock()

Determines whether a mock is set as the instance of the facade.

Return Value

bool

in Facade at line 210
static protected string|null getMockableClass()

Get the mockable class for the bound instance.

Return Value

string|null

in Facade at line 226
static void swap(mixed $instance)

Hotswap the underlying instance behind the facade.

Replaces the worker-wide resolved facade instance and container binding; runtime use races across coroutines and changes every subsequent facade call.

Parameters

mixed $instance

Return Value

void

in Facade at line 239
static bool isFake()

Determines whether a "fake" has been set as the facade instance.

Return Value

bool

in Facade at line 250
static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

at line 91
static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

in Facade at line 266
static protected mixed resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

in Facade at line 312
static void clearResolvedInstance(string|null $name = null)

Clear a resolved facade instance.

Later facade calls everywhere resolve again; only references already held keep the previous instance.

Parameters

string|null $name

Return Value

void

in Facade at line 330
static void clearResolvedInstances()

Clear all of the resolved instances.

Later facade calls everywhere resolve again; only references already held keep the previous instances.

Return Value

void

in Facade at line 344
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

in Facade at line 404
static Container|null getFacadeApplication()

Get the application instance behind the facade.

Return Value

Container|null

in Facade at line 415
static void setFacadeApplication(Container|null $app)

Set the application instance.

Replaces the worker-wide facade application reference; runtime use races across coroutines and breaks every facade lookup.

Parameters

Container|null $app

Return Value

void

in Facade at line 427
static mixed __callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Return Value

mixed

Exceptions

RuntimeException
Throwable

at line 83
static Builder connection(string|null $name = null)

Get a schema builder instance for a connection.

Parameters

string|null $name

Return Value

Builder

at line 73
static void blueprintResolver(Closure $resolver)

No description

Parameters

Closure $resolver

Return Value

void

at line 73
static void create(string $table, Closure $callback)

No description

Parameters

string $table
Closure $callback

Return Value

void

at line 73
static bool createDatabase(string $name)

No description

Parameters

string $name

Return Value

bool

at line 73
static void createMigrationRepositoryTable(string $table)

No description

Parameters

string $table

Return Value

void

at line 73
static void createRangePartition(string $table, string $partition, array<int $, Expression|float|int|string> $from, Expression|float|int|string> $to)

No description

Parameters

string $table
string $partition
array<int $
Expression|float|int|string> $from
Expression|float|int|string> $to

Return Value

void

at line 73
static void defaultMorphKeyType(string $type)

No description

Parameters

string $type

Return Value

void

at line 73
static void defaultStringLength(int $length)

No description

Parameters

int $length

Return Value

void

at line 73
static void defaultTimePrecision(int|null $precision)

No description

Parameters

int|null $precision

Return Value

void

at line 73
static bool disableForeignKeyConstraints()

No description

Return Value

bool

at line 73
static void drop(string $table)

No description

Parameters

string $table

Return Value

void

at line 73
static void dropAllTables()

No description

Return Value

void

at line 73
static void dropAllTypes()

No description

Return Value

void

at line 73
static void dropAllViews()

No description

Return Value

void

at line 73
static void dropColumns(string $table, string[]|string $columns)

No description

Parameters

string $table
string[]|string $columns

Return Value

void

at line 73
static bool dropDatabaseIfExists(string $name)

No description

Parameters

string $name

Return Value

bool

at line 73
static void dropIfExists(string $table)

No description

Parameters

string $table

Return Value

void

at line 73
static bool enableForeignKeyConstraints()

No description

Return Value

bool

at line 73
static void ensureExtensionExists(string $name, string|null $schema = 'null')

No description

Parameters

string $name
string|null $schema

Return Value

void

at line 73
static void ensureVectorExtensionExists(string|null $schema = 'null')

No description

Parameters

string|null $schema

Return Value

void

at line 73
static void executeBlueprint(Blueprint $blueprint)

No description

Parameters

Blueprint $blueprint

Return Value

void

at line 73
static void flushMacros()

No description

Return Value

void

at line 73
static void flushState()

No description

Return Value

void

at line 73
static array getColumn(string $table, string $column)

No description

Parameters

string $table
string $column

Return Value

array

at line 73
static void array()

<int, array> withoutCoveredPartitions(array<int, array> $tables, array<int, string> $except = '[]')

Return Value

void

at line 73
static string getColumnType(string $table, string $column, bool $fullDefinition = 'false')

No description

Parameters

string $table
string $column
bool $fullDefinition

Return Value

string

at line 73
static Connection getConnection()

No description

Return Value

Connection

at line 73
static null|string[] getCurrentSchemaListing()

No description

Return Value

null|string[]

at line 73
static string|null getCurrentSchemaName()

No description

Return Value

string|null

at line 73
static bool hasColumn(string $table, string $column)

No description

Parameters

string $table
string $column

Return Value

bool

at line 73
static bool hasColumns(string $table, string[] $columns)

No description

Parameters

string $table
string[] $columns

Return Value

bool

at line 73
static bool hasForeignKey(string $table, array|string $foreignKey)

No description

Parameters

string $table
array|string $foreignKey

Return Value

bool

at line 73
static bool hasIndex(string $table, array|string $index, string|null $type = 'null')

No description

Parameters

string $table
array|string $index
string|null $type

Return Value

bool

at line 73
static bool hasMacro(string $name)

No description

Parameters

string $name

Return Value

bool

at line 73
static bool hasTable(string $table)

No description

Parameters

string $table

Return Value

bool

at line 73
static bool hasView(string $view)

No description

Parameters

string $view

Return Value

bool

at line 73
static void macro(string $name, callable|object $macro)

No description

Parameters

string $name
callable|object $macro

Return Value

void

at line 73
static void mixin(object $mixin, bool $replace = 'true')

No description

Parameters

object $mixin
bool $replace

Return Value

void

at line 73
static void morphUsingUlids()

No description

Return Value

void

at line 73
static void morphUsingUuids()

No description

Return Value

void

at line 73
static array parseSchemaAndTable(string $reference, string|bool|null $withDefaultSchema = 'null')

No description

Parameters

string $reference
string|bool|null $withDefaultSchema

Return Value

array

at line 73
static string qualifyIndexName(string $name)

No description

Parameters

string $name

Return Value

string

at line 73
static void rename(string $from, string $to)

No description

Parameters

string $from
string $to

Return Value

void

at line 73
static void table(string $table, Closure $callback)

No description

Parameters

string $table
Closure $callback

Return Value

void

at line 73
static void truncateTables(array<int $, string> $tables)

No description

Parameters

array<int $
string> $tables

Return Value

void

at line 73
static void whenTableDoesntHaveColumn(string $table, string $column, Closure $callback)

No description

Parameters

string $table
string $column
Closure $callback

Return Value

void

at line 73
static void whenTableDoesntHaveIndex(string $table, array|string $index, Closure $callback, string|null $type = 'null')

No description

Parameters

string $table
array|string $index
Closure $callback
string|null $type

Return Value

void

at line 73
static void whenTableHasColumn(string $table, string $column, Closure $callback)

No description

Parameters

string $table
string $column
Closure $callback

Return Value

void

at line 73
static void whenTableHasIndex(string $table, array|string $index, Closure $callback, string|null $type = 'null')

No description

Parameters

string $table
array|string $index
Closure $callback
string|null $type

Return Value

void

at line 73
static mixed withoutForeignKeyConstraints(Closure $callback)

No description

Parameters

Closure $callback

Return Value

mixed