1. class
  2. Illuminate
  3. \
  4. Database
  5. \
  6. DatabaseManager

DatabaseManager

class DatabaseManager implements ConnectionResolverInterface mixin Connection (View source)

Traits

Macroable

Properties

static protected array $macros

The registered string macros.

 from  Macroable
protected Application $app

The application instance.
protected ConnectionFactory $factory

The database connection factory instance.
protected Connection> $connections

The active connection instances.
protected array<string,array> $dynamicConnectionConfigurations

The dynamically configured (DB::build) connection configurations.
protected array<string,callable> $extensions

The custom connection resolvers.
protected callable $reconnector

The callback to be executed to reconnect to a database.

Methods

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

Register a custom macro.

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

Mix another object into the class.

from  Macroable
static bool
hasMacro(string $name)

Checks if macro is registered.

from  Macroable
static void
flushMacros()

Flush the existing macros.

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

Dynamically handle calls to the class.

from  Macroable
mixed
__call(string $method, array $parameters)

Dynamically pass methods to the default connection.

__construct(Application $app, ConnectionFactory $factory)

Create a new database manager instance.

ConnectionInterface
connection(string|null $name = null)

Get a database connection instance.

ConnectionInterface
build(array $config)

Build a database connection instance from the given configuration.

static string
calculateDynamicConnectionName(array $config)

Calculate the dynamic connection name for an on-demand connection based on its configuration.

ConnectionInterface
connectUsing(string $name, array $config, bool $force = false)

Get a database connection instance from the given configuration.

array
parseConnectionName(string $name)

Parse the connection into an array of the name and read / write type.

Connection
makeConnection(string $name)

Make the database connection instance.

array
configuration(string $name)

Get the configuration for a connection.

Connection
configure(Connection $connection, string $type)

Prepare the database connection instance.

void
dispatchConnectionEstablishedEvent(Connection $connection)

Dispatch the ConnectionEstablished event if the event dispatcher is available.

Connection
setPdoForType(Connection $connection, string|null $type = null)

Prepare the read / write mode for database connection instance.

void
purge(string|null $name = null)

Disconnect from the given database and remove from local cache.

void
disconnect(string|null $name = null)

Disconnect from the given database.

Connection
reconnect(string|null $name = null)

Reconnect to the given database.

mixed
usingConnection(string $name, callable $callback)

Set the default database connection for the callback execution.

Connection
refreshPdoConnections(string $name)

Refresh the PDO connections on a given connection.

string
getDefaultConnection()

Get the default connection name.

void
setDefaultConnection(string $name)

Set the default connection name.

string[]
supportedDrivers()

Get all of the supported drivers.

string[]
availableDrivers()

Get all of the drivers that are actually available.

void
extend(string $name, callable $resolver)

Register an extension connection resolver.

void
forgetExtension(string $name)

Remove an extension connection resolver.

Connection>
getConnections()

Return all of the created connections.

void
setReconnector(callable $reconnector)

Set the database reconnector callback.

$this
setApplication(Application $app)

Set the application instance used by the manager.

Details

in Macroable at line 29
static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

in Macroable at line 43
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 62
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static void flushMacros()

Flush the existing macros.

Return Value

void

in Macroable at line 86
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 489
mixed __call(string $method, array $parameters)

Dynamically pass methods to the default connection.

Parameters

string $method
array $parameters

Return Value

mixed

at line 73
__construct(Application $app, ConnectionFactory $factory)

Create a new database manager instance.

Parameters

Application $app
ConnectionFactory $factory

at line 91
ConnectionInterface connection(string|null $name = null)

Get a database connection instance.

Parameters

string|null $name

Return Value

ConnectionInterface

at line 117
ConnectionInterface build(array $config)

Build a database connection instance from the given configuration.

Parameters

array $config

Return Value

ConnectionInterface

at line 134
static string calculateDynamicConnectionName(array $config)

Calculate the dynamic connection name for an on-demand connection based on its configuration.

Parameters

array $config

Return Value

string

at line 149
ConnectionInterface connectUsing(string $name, array $config, bool $force = false)

Get a database connection instance from the given configuration.

Parameters

string $name
array $config
bool $force

Return Value

ConnectionInterface

at line 174
protected array parseConnectionName(string $name)

Parse the connection into an array of the name and read / write type.

Parameters

string $name

Return Value

array

at line 189
protected Connection makeConnection(string $name)

Make the database connection instance.

Parameters

string $name

Return Value

Connection

at line 218
protected array configuration(string $name)

Get the configuration for a connection.

Parameters

string $name

Return Value

array

Exceptions

InvalidArgumentException

at line 241
protected Connection configure(Connection $connection, string $type)

Prepare the database connection instance.

Parameters

Connection $connection
string $type

Return Value

Connection

at line 270
protected void dispatchConnectionEstablishedEvent(Connection $connection)

Dispatch the ConnectionEstablished event if the event dispatcher is available.

Parameters

Connection $connection

Return Value

void

at line 288
protected Connection setPdoForType(Connection $connection, string|null $type = null)

Prepare the read / write mode for database connection instance.

Parameters

Connection $connection
string|null $type

Return Value

Connection

at line 305
void purge(string|null $name = null)

Disconnect from the given database and remove from local cache.

Parameters

string|null $name

Return Value

void

at line 320
void disconnect(string|null $name = null)

Disconnect from the given database.

Parameters

string|null $name

Return Value

void

at line 333
Connection reconnect(string|null $name = null)

Reconnect to the given database.

Parameters

string|null $name

Return Value

Connection

at line 351
mixed usingConnection(string $name, callable $callback)

Set the default database connection for the callback execution.

Parameters

string $name
callable $callback

Return Value

mixed

at line 368
protected Connection refreshPdoConnections(string $name)

Refresh the PDO connections on a given connection.

Parameters

string $name

Return Value

Connection

at line 386
string getDefaultConnection()

Get the default connection name.

Return Value

string

at line 397
void setDefaultConnection(string $name)

Set the default connection name.

Parameters

string $name

Return Value

void

at line 407
string[] supportedDrivers()

Get all of the supported drivers.

Return Value

string[]

at line 417
string[] availableDrivers()

Get all of the drivers that are actually available.

Return Value

string[]

at line 432
void extend(string $name, callable $resolver)

Register an extension connection resolver.

Parameters

string $name
callable $resolver

Return Value

void

at line 443
void forgetExtension(string $name)

Remove an extension connection resolver.

Parameters

string $name

Return Value

void

at line 453
Connection> getConnections()

Return all of the created connections.

Return Value

Connection>

at line 464
void setReconnector(callable $reconnector)

Set the database reconnector callback.

Parameters

callable $reconnector

Return Value

void

at line 475
$this setApplication(Application $app)

Set the application instance used by the manager.

Parameters

Application $app

Return Value

$this