W3cubDocs

/Laravel 11

DB

class DB extends Facade (View source)

Properties

static protected Application|null $app

The application instance being facaded.

 from Facade
static protected array $resolvedInstance

The resolved object instances.

 from Facade
static protected bool $cached

Indicates if the resolved instance should be cached.

 from Facade

Methods

static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.

 from Facade
static MockInterface spy()

Convert the facade into a Mockery spy.

 from Facade
static MockInterface partialMock()

Initiate a partial mock on the facade.

 from Facade
static Expectation shouldReceive()

Initiate a mock expectation on the facade.

 from Facade
static Expectation 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 $name)

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 Application|null getFacadeApplication()

Get the application instance behind the facade.

 from Facade
static void setFacadeApplication(Application|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 void prohibitDestructiveCommands(bool $prohibit = true)

Indicate if destructive Artisan commands should be prohibited.
static Connection connection(string|null $name = null)

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

No description
static void purge(string|null $name = null)

No description
static void disconnect(string|null $name = null)

No description
static Connection reconnect(string|null $name = null)

No description
static mixed usingConnection(string $name, callable $callback)

No description
static string getDefaultConnection()

No description
static void setDefaultConnection(string $name)

No description
static string[] supportedDrivers()

No description
static string[] availableDrivers()

No description
static void extend(string $name, callable $resolver)

No description
static void forgetExtension(string $name)

No description
static array getConnections()

No description
static void setReconnector(callable $reconnector)

No description
static DatabaseManager setApplication(Application $app)

No description
static void macro(string $name, object|callable $macro = null)

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

No description
static bool hasMacro(string $name)

No description
static void flushMacros()

No description
static mixed macroCall(string $method, array $parameters)

No description
static void useDefaultQueryGrammar()

No description
static void useDefaultSchemaGrammar()

No description
static void useDefaultPostProcessor()

No description
static Builder getSchemaBuilder()

No description
static Builder table(Expression|string $table, string|null $as = null)

No description
static Builder query()

No description
static mixed selectOne(string $query, array $bindings = [], bool $useReadPdo = true)

No description
static mixed scalar(string $query, array $bindings = [], bool $useReadPdo = true)

No description
static array selectFromWriteConnection(string $query, array $bindings = [])

No description
static array select(string $query, array $bindings = [], bool $useReadPdo = true)

No description
static array selectResultSets(string $query, array $bindings = [], bool $useReadPdo = true)

No description
static Generator cursor(string $query, array $bindings = [], bool $useReadPdo = true)

No description
static bool insert(string $query, array $bindings = [])

No description
static int update(string $query, array $bindings = [])

No description
static int delete(string $query, array $bindings = [])

No description
static bool statement(string $query, array $bindings = [])

No description
static int affectingStatement(string $query, array $bindings = [])

No description
static bool unprepared(string $query)

No description
static array pretend(Closure $callback)

No description
static mixed withoutPretending(Closure $callback)

No description
static void bindValues(PDOStatement $statement, array $bindings)

No description
static array prepareBindings(array $bindings)

No description
static void logQuery(string $query, array $bindings, float|null $time = null)

No description
static void whenQueryingForLongerThan(CarbonInterval|float|int $threshold, callable $handler)

No description
static void allowQueryDurationHandlersToRunAgain()

No description
static float totalQueryDuration()

No description
static void resetTotalQueryDuration()

No description
static void reconnectIfMissingConnection()

No description
static Connection beforeStartingTransaction(Closure $callback)

No description
static Connection beforeExecuting(Closure $callback)

No description
static void listen(Closure $callback)

No description
static Expression raw(mixed $value)

No description
static string escape(string|float|int|bool|null $value, bool $binary = false)

No description
static bool hasModifiedRecords()

No description
static void recordsHaveBeenModified(bool $value = true)

No description
static Connection setRecordModificationState(bool $value)

No description
static void forgetRecordModificationState()

No description
static Connection useWriteConnectionWhenReading(bool $value = true)

No description
static PDO getPdo()

No description
static Closure|null getRawPdo()

No description
static PDO getReadPdo()

No description
static Closure|null getRawReadPdo()

No description
static Connection setPdo(Closure|null $pdo)

No description
static Connection setReadPdo(Closure|null $pdo)

No description
static string|null getName()

No description
static string|null getNameWithReadWriteType()

No description
static mixed getConfig(string|null $option = null)

No description
static string getDriverName()

No description
static Grammar getQueryGrammar()

No description
static Connection setQueryGrammar(Grammar $grammar)

No description
static Grammar getSchemaGrammar()

No description
static Connection setSchemaGrammar(Grammar $grammar)

No description
static Processor getPostProcessor()

No description
static Connection setPostProcessor(Processor $processor)

No description
static Dispatcher getEventDispatcher()

No description
static Connection setEventDispatcher(Dispatcher $events)

No description
static void unsetEventDispatcher()

No description
static Connection setTransactionManager(DatabaseTransactionsManager $manager)

No description
static void unsetTransactionManager()

No description
static bool pretending()

No description
static array getQueryLog()

No description
static array getRawQueryLog()

No description
static void flushQueryLog()

No description
static void enableQueryLog()

No description
static void disableQueryLog()

No description
static bool logging()

No description
static string getDatabaseName()

No description
static Connection setDatabaseName(string $database)

No description
static Connection setReadWriteType(string|null $readWriteType)

No description
static string getTablePrefix()

No description
static Connection setTablePrefix(string $prefix)

No description
static Grammar withTablePrefix(Grammar $grammar)

No description
static string getServerVersion()

No description
static void resolverFor(string $driver, Closure $callback)

No description
static mixed getResolver(string $driver)

No description
static mixed transaction(Closure $callback, int $attempts = 1)

No description
static void beginTransaction()

No description
static void commit()

No description
static void rollBack(int|null $toLevel = null)

No description
static int transactionLevel()

No description
static void afterCommit(callable $callback)

No description

Details

static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.

Parameters

Closure $callback

Return Value

void

static MockInterface spy()

Convert the facade into a Mockery spy.

Return Value

MockInterface

static MockInterface partialMock()

Initiate a partial mock on the facade.

Return Value

MockInterface

static Expectation shouldReceive()

Initiate a mock expectation on the facade.

Return Value

Expectation

static Expectation expects()

Initiate a mock expectation on the facade.

Return Value

Expectation

static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Return Value

MockInterface

static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

static protected bool isMock()

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

Return Value

bool

static protected string|null getMockableClass()

Get the mockable class for the bound instance.

Return Value

string|null

static void swap(mixed $instance)

Hotswap the underlying instance behind the facade.

Parameters

mixed $instance

Return Value

void

static protected bool isFake()

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

Return Value

bool

static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

static protected mixed resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

static void clearResolvedInstance(string $name)

Clear a resolved facade instance.

Parameters

string $name

Return Value

void

static void clearResolvedInstances()

Clear all of the resolved instances.

Return Value

void

static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

static Application|null getFacadeApplication()

Get the application instance behind the facade.

Return Value

Application|null

static void setFacadeApplication(Application|null $app)

Set the application instance.

Parameters

Application|null $app

Return Value

void

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

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Return Value

mixed

Exceptions

RuntimeException

static void prohibitDestructiveCommands(bool $prohibit = true)

Indicate if destructive Artisan commands should be prohibited.

Prohibits: db:wipe, migrate:fresh, migrate:refresh, and migrate:reset

Parameters

bool $prohibit

Return Value

void

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

No description

Parameters

string|null $name

Return Value

Connection

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

No description

Parameters

string $name
array $config
bool $force

Return Value

ConnectionInterface

static void purge(string|null $name = null)

No description

Parameters

string|null $name

Return Value

void

static void disconnect(string|null $name = null)

No description

Parameters

string|null $name

Return Value

void

static Connection reconnect(string|null $name = null)

No description

Parameters

string|null $name

Return Value

Connection

static mixed usingConnection(string $name, callable $callback)

No description

Parameters

string $name
callable $callback

Return Value

mixed

static string getDefaultConnection()

No description

Return Value

string

static void setDefaultConnection(string $name)

No description

Parameters

string $name

Return Value

void

static string[] supportedDrivers()

No description

Return Value

string[]

static string[] availableDrivers()

No description

Return Value

string[]

static void extend(string $name, callable $resolver)

No description

Parameters

string $name
callable $resolver

Return Value

void

static void forgetExtension(string $name)

No description

Parameters

string $name

Return Value

void

static array getConnections()

No description

Return Value

array

static void setReconnector(callable $reconnector)

No description

Parameters

callable $reconnector

Return Value

void

static DatabaseManager setApplication(Application $app)

No description

Parameters

Application $app

Return Value

DatabaseManager

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

No description

Parameters

string $name
object|callable $macro

Return Value

void

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

No description

Parameters

object $mixin
bool $replace

Return Value

void

static bool hasMacro(string $name)

No description

Parameters

string $name

Return Value

bool

static void flushMacros()

No description

Return Value

void

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

No description

Parameters

string $method
array $parameters

Return Value

mixed

static void useDefaultQueryGrammar()

No description

Return Value

void

static void useDefaultSchemaGrammar()

No description

Return Value

void

static void useDefaultPostProcessor()

No description

Return Value

void

static Builder getSchemaBuilder()

No description

Return Value

Builder

static Builder table(Expression|string $table, string|null $as = null)

No description

Parameters

Expression|string $table
string|null $as

Return Value

Builder

static Builder query()

No description

Return Value

Builder

static mixed selectOne(string $query, array $bindings = [], bool $useReadPdo = true)

No description

Parameters

string $query
array $bindings
bool $useReadPdo

Return Value

mixed

static mixed scalar(string $query, array $bindings = [], bool $useReadPdo = true)

No description

Parameters

string $query
array $bindings
bool $useReadPdo

Return Value

mixed

static array selectFromWriteConnection(string $query, array $bindings = [])

No description

Parameters

string $query
array $bindings

Return Value

array

static array select(string $query, array $bindings = [], bool $useReadPdo = true)

No description

Parameters

string $query
array $bindings
bool $useReadPdo

Return Value

array

static array selectResultSets(string $query, array $bindings = [], bool $useReadPdo = true)

No description

Parameters

string $query
array $bindings
bool $useReadPdo

Return Value

array

static Generator cursor(string $query, array $bindings = [], bool $useReadPdo = true)

No description

Parameters

string $query
array $bindings
bool $useReadPdo

Return Value

Generator

static bool insert(string $query, array $bindings = [])

No description

Parameters

string $query
array $bindings

Return Value

bool

static int update(string $query, array $bindings = [])

No description

Parameters

string $query
array $bindings

Return Value

int

static int delete(string $query, array $bindings = [])

No description

Parameters

string $query
array $bindings

Return Value

int

static bool statement(string $query, array $bindings = [])

No description

Parameters

string $query
array $bindings

Return Value

bool

static int affectingStatement(string $query, array $bindings = [])

No description

Parameters

string $query
array $bindings

Return Value

int

static bool unprepared(string $query)

No description

Parameters

string $query

Return Value

bool

static array pretend(Closure $callback)

No description

Parameters

Closure $callback

Return Value

array

static mixed withoutPretending(Closure $callback)

No description

Parameters

Closure $callback

Return Value

mixed

static void bindValues(PDOStatement $statement, array $bindings)

No description

Parameters

PDOStatement $statement
array $bindings

Return Value

void

static array prepareBindings(array $bindings)

No description

Parameters

array $bindings

Return Value

array

static void logQuery(string $query, array $bindings, float|null $time = null)

No description

Parameters

string $query
array $bindings
float|null $time

Return Value

void

static void whenQueryingForLongerThan(CarbonInterval|float|int $threshold, callable $handler)

No description

Parameters

CarbonInterval|float|int $threshold
callable $handler

Return Value

void

static void allowQueryDurationHandlersToRunAgain()

No description

Return Value

void

static float totalQueryDuration()

No description

Return Value

float

static void resetTotalQueryDuration()

No description

Return Value

void

static void reconnectIfMissingConnection()

No description

Return Value

void

static Connection beforeStartingTransaction(Closure $callback)

No description

Parameters

Closure $callback

Return Value

Connection

static Connection beforeExecuting(Closure $callback)

No description

Parameters

Closure $callback

Return Value

Connection

static void listen(Closure $callback)

No description

Parameters

Closure $callback

Return Value

void

static Expression raw(mixed $value)

No description

Parameters

mixed $value

Return Value

Expression

static string escape(string|float|int|bool|null $value, bool $binary = false)

No description

Parameters

string|float|int|bool|null $value
bool $binary

Return Value

string

static bool hasModifiedRecords()

No description

Return Value

bool

static void recordsHaveBeenModified(bool $value = true)

No description

Parameters

bool $value

Return Value

void

static Connection setRecordModificationState(bool $value)

No description

Parameters

bool $value

Return Value

Connection

static void forgetRecordModificationState()

No description

Return Value

void

static Connection useWriteConnectionWhenReading(bool $value = true)

No description

Parameters

bool $value

Return Value

Connection

static PDO getPdo()

No description

Return Value

PDO

static Closure|null getRawPdo()

No description

Return Value

Closure|null

static PDO getReadPdo()

No description

Return Value

PDO

static Closure|null getRawReadPdo()

No description

Return Value

Closure|null

static Connection setPdo(Closure|null $pdo)

No description

Parameters

Closure|null $pdo

Return Value

Connection

static Connection setReadPdo(Closure|null $pdo)

No description

Parameters

Closure|null $pdo

Return Value

Connection

static string|null getName()

No description

Return Value

string|null

static string|null getNameWithReadWriteType()

No description

Return Value

string|null

static mixed getConfig(string|null $option = null)

No description

Parameters

string|null $option

Return Value

mixed

static string getDriverName()

No description

Return Value

string

static Grammar getQueryGrammar()

No description

Return Value

Grammar

static Connection setQueryGrammar(Grammar $grammar)

No description

Parameters

Grammar $grammar

Return Value

Connection

static Grammar getSchemaGrammar()

No description

Return Value

Grammar

static Connection setSchemaGrammar(Grammar $grammar)

No description

Parameters

Grammar $grammar

Return Value

Connection

static Processor getPostProcessor()

No description

Return Value

Processor

static Connection setPostProcessor(Processor $processor)

No description

Parameters

Processor $processor

Return Value

Connection

static Dispatcher getEventDispatcher()

No description

Return Value

Dispatcher

static Connection setEventDispatcher(Dispatcher $events)

No description

Parameters

Dispatcher $events

Return Value

Connection

static void unsetEventDispatcher()

No description

Return Value

void

static Connection setTransactionManager(DatabaseTransactionsManager $manager)

No description

Parameters

DatabaseTransactionsManager $manager

Return Value

Connection

static void unsetTransactionManager()

No description

Return Value

void

static bool pretending()

No description

Return Value

bool

static array getQueryLog()

No description

Return Value

array

static array getRawQueryLog()

No description

Return Value

array

static void flushQueryLog()

No description

Return Value

void

static void enableQueryLog()

No description

Return Value

void

static void disableQueryLog()

No description

Return Value

void

static bool logging()

No description

Return Value

bool

static string getDatabaseName()

No description

Return Value

string

static Connection setDatabaseName(string $database)

No description

Parameters

string $database

Return Value

Connection

static Connection setReadWriteType(string|null $readWriteType)

No description

Parameters

string|null $readWriteType

Return Value

Connection

static string getTablePrefix()

No description

Return Value

string

static Connection setTablePrefix(string $prefix)

No description

Parameters

string $prefix

Return Value

Connection

static Grammar withTablePrefix(Grammar $grammar)

No description

Parameters

Grammar $grammar

Return Value

Grammar

static string getServerVersion()

No description

Return Value

string

static void resolverFor(string $driver, Closure $callback)

No description

Parameters

string $driver
Closure $callback

Return Value

void

static mixed getResolver(string $driver)

No description

Parameters

string $driver

Return Value

mixed

static mixed transaction(Closure $callback, int $attempts = 1)

No description

Parameters

Closure $callback
int $attempts

Return Value

mixed

static void beginTransaction()

No description

Return Value

void

static void commit()

No description

Return Value

void

static void rollBack(int|null $toLevel = null)

No description

Parameters

int|null $toLevel

Return Value

void

static int transactionLevel()

No description

Return Value

int

static void afterCommit(callable $callback)

No description

Parameters

callable $callback

Return Value

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Support/Facades/DB.html