class Manager

Standalone database manager for non-production use outside full application bootstrap.

Uses SimpleConnectionResolver to retain non-pooled connections, including in-memory SQLite databases, without requiring full application bootstrap.

For production Swoole applications with connection pooling, use the full Hypervel application with ConnectionResolver instead.

Traits

Properties

static protected object|null $instance

The current globally used instance.

from  CapsuleManagerTrait
protected Container $container

The container instance.

from  CapsuleManagerTrait
protected DatabaseManager $manager

The database manager instance.

Methods

void
setupContainer(Container $container)

Setup the IoC container instance.

void
setAsGlobal()

Make this capsule instance available globally.

getContainer()

Get the IoC container instance.

void
setContainer(Container $container)

Set the IoC container instance.

static void
flushState()

Flush all static state.

__construct(Container|null $container = null)

Create a new database capsule manager.

void
setupDefaultConfiguration()

Setup the default database configuration options.

void
setupManager()

Build the database manager instance.

static Connection
connection(string|null $connection = null)

Get a connection instance from the global manager.

static Builder
table(Closure|Builder|Builder|Relation|Expression|UnitEnum|string $table, string|null $as = null, string|null $connection = null)

Get a fluent query builder instance.

static Builder
schema(string|null $connection = null)

Get a schema builder instance.

getConnection(string|null $name = null)

Get a registered connection instance.

void
addConnection(array $config, string $name = 'default')

Register a connection with the manager.

void
bootEloquent()

Bootstrap Eloquent so it is ready for usage.

getDatabaseManager()

Get the database manager instance.

Dispatcher|null
getEventDispatcher()

Get the current event dispatcher instance.

void
setEventDispatcher(Dispatcher $dispatcher)

Set the event dispatcher instance to be used by connections.

static mixed
__callStatic(string $method, array $parameters)

Dynamically pass methods to the default connection.

Details

protected void setupContainer(Container $container)

Setup the IoC container instance.

Parameters

Container $container

Return Value

void

void setAsGlobal()

Make this capsule instance available globally.

Swaps the global Capsule instance used by static calls; request-time use races across coroutines.

Return Value

void

Container getContainer()

Get the IoC container instance.

Return Value

Container

void setContainer(Container $container)

Set the IoC container instance.

Swaps the Capsule container used by this standalone manager; request-time use races across coroutines.

Parameters

Container $container

Return Value

void

static void flushState()

Flush all static state.

Return Value

void

at line 46
__construct(Container|null $container = null)

Create a new database capsule manager.

Parameters

Container|null $container

at line 61
protected void setupDefaultConfiguration()

Setup the default database configuration options.

Return Value

void

at line 71
protected void setupManager()

Build the database manager instance.

Return Value

void

at line 89
static Connection connection(string|null $connection = null)

Get a connection instance from the global manager.

Parameters

string|null $connection

Return Value

Connection

at line 97
static Builder table(Closure|Builder|Builder|Relation|Expression|UnitEnum|string $table, string|null $as = null, string|null $connection = null)

Get a fluent query builder instance.

Parameters

Closure|Builder|Builder|Relation|Expression|UnitEnum|string $table
string|null $as
string|null $connection

Return Value

Builder

at line 105
static Builder schema(string|null $connection = null)

Get a schema builder instance.

Parameters

string|null $connection

Return Value

Builder

at line 113
Connection getConnection(string|null $name = null)

Get a registered connection instance.

Parameters

string|null $name

Return Value

Connection

at line 121
void addConnection(array $config, string $name = 'default')

Register a connection with the manager.

Parameters

array $config
string $name

Return Value

void

at line 137
void bootEloquent()

Bootstrap Eloquent so it is ready for usage.

The resolver and dispatcher persist in Eloquent's static properties for the worker lifetime and are used by every model across all coroutines.

Return Value

void

at line 156
DatabaseManager getDatabaseManager()

Get the database manager instance.

Return Value

DatabaseManager

at line 164
Dispatcher|null getEventDispatcher()

Get the current event dispatcher instance.

Return Value

Dispatcher|null

at line 176
void setEventDispatcher(Dispatcher $dispatcher)

Set the event dispatcher instance to be used by connections.

Parameters

Dispatcher $dispatcher

Return Value

void

at line 184
static mixed __callStatic(string $method, array $parameters)

Dynamically pass methods to the default connection.

Parameters

string $method
array $parameters

Return Value

mixed