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

SqlServerConnection

class SqlServerConnection extends Connection (View source)

Traits

DetectsConcurrencyErrors
DetectsLostConnections
ManagesTransactions
InteractsWithTime
Macroable

Properties

static protected array $macros

The registered string macros.

 from  Macroable
protected PDO|Closure $pdo

The active PDO connection.

 from  Connection
protected PDO|Closure $readPdo

The active PDO connection used for reads.

 from  Connection
protected string $database

The name of the connected database.

 from  Connection
protected string|null $readWriteType

The type of the connection.

 from  Connection
protected string $tablePrefix

The table prefix for the connection.

 from  Connection
protected array $config

The database connection configuration options.

 from  Connection
protected callable $reconnector

The reconnector instance for the connection.

 from  Connection
protected Grammar $queryGrammar

The query grammar implementation.

 from  Connection
protected Grammar $schemaGrammar

The schema grammar implementation.

 from  Connection
protected Processor $postProcessor

The query post processor implementation.

 from  Connection
protected Dispatcher|null $events

The event dispatcher instance.

 from  Connection
protected int $fetchMode

The default fetch mode of the connection.

 from  Connection
protected int $transactions

The number of active transactions.

 from  Connection
protected DatabaseTransactionsManager|null $transactionsManager

The transaction manager instance.

 from  Connection
protected bool $recordsModified

Indicates if changes have been made to the database.

 from  Connection
protected bool $readOnWriteConnection

Indicates if the connection should use the "write" PDO connection.

 from  Connection
protected array $queryLog

All of the queries run against the connection.

 from  Connection
protected bool $loggingQueries

Indicates whether queries are being logged.

 from  Connection
protected float $totalQueryDuration

The duration of all executed queries in milliseconds.

 from  Connection
protected array $queryDurationHandlers

All of the registered query duration handlers.

 from  Connection
protected bool $pretending

Indicates if the connection is in a "dry run".

 from  Connection
protected Closure[] $beforeStartingTransaction

All of the callbacks that should be invoked before a transaction is started.

 from  Connection
protected Closure[] $beforeExecutingCallbacks

All of the callbacks that should be invoked before a query is executed.

 from  Connection
static protected Closure[] $resolvers

The connection resolvers.

 from  Connection

Methods

bool
causedByConcurrencyError(Throwable $e)

Determine if the given exception was caused by a concurrency error such as a deadlock or serialization failure.

from  DetectsConcurrencyErrors
bool
causedByLostConnection(Throwable $e)

Determine if the given exception was caused by a lost connection.

from  DetectsLostConnections
TReturn
transaction(Closure $callback, int $attempts = 1)

Execute a Closure within a transaction.

void
handleTransactionException(Throwable $e, int $currentAttempt, int $maxAttempts)

Handle an exception encountered when running a transacted statement.

from  ManagesTransactions
void
beginTransaction()

Start a new database transaction.

from  ManagesTransactions
void
createTransaction()

Create a transaction within the database.

from  ManagesTransactions
void
createSavepoint()

Create a save point within the database.

from  ManagesTransactions
void
handleBeginTransactionException(Throwable $e)

Handle an exception from a transaction beginning.

from  ManagesTransactions
void
commit()

Commit the active database transaction.

from  ManagesTransactions
void
handleCommitTransactionException(Throwable $e, int $currentAttempt, int $maxAttempts)

Handle an exception encountered when committing a transaction.

from  ManagesTransactions
void
rollBack(int|null $toLevel = null)

Rollback the active database transaction.

from  ManagesTransactions
void
performRollBack(int $toLevel)

Perform a rollback within the database.

from  ManagesTransactions
void
handleRollBackException(Throwable $e)

Handle an exception from a rollback.

from  ManagesTransactions
int
transactionLevel()

Get the number of active transactions.

from  ManagesTransactions
void
afterCommit(callable $callback)

Execute the callback after a transaction commits.

from  ManagesTransactions
int
secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

from  InteractsWithTime
int
availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

from  InteractsWithTime
DateTimeInterface|int
parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

from  InteractsWithTime
int
currentTime()

Get the current system time as a UNIX timestamp.

from  InteractsWithTime
string
runTimeForHumans(float $startTime, float $endTime = null)

Given a start time, format the total run time for human readability.

from  InteractsWithTime
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 handle calls to the class.

from  Macroable
__construct(PDO|Closure $pdo, string $database = '', string $tablePrefix = '', array $config = [])

Create a new database connection instance.

from  Connection
void
useDefaultQueryGrammar()

Set the query grammar to the default implementation.

from  Connection
Grammar
getDefaultQueryGrammar()

Get the default query grammar instance.

void
useDefaultSchemaGrammar()

Set the schema grammar to the default implementation.

from  Connection
Grammar|null
getDefaultSchemaGrammar()

Get the default schema grammar instance.

void
useDefaultPostProcessor()

Set the query post processor to the default implementation.

from  Connection
Processor
getDefaultPostProcessor()

Get the default post processor instance.

Builder
getSchemaBuilder()

Get a schema builder instance for the connection.

Builder
table(Closure|Builder|string $table, string|null $as = null)

Begin a fluent query against a database table.

from  Connection
Builder
query()

Get a new query builder instance.

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

Run a select statement and return a single result.

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

Run a select statement and return the first column of the first row.

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

Run a select statement against the database.

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

Run a select statement against the database.

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

Run a select statement against the database and returns all of the result sets.

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

Run a select statement against the database and returns a generator.

from  Connection
PDOStatement
prepared(PDOStatement $statement)

Configure the PDO prepared statement.

from  Connection
PDO
getPdoForSelect(bool $useReadPdo = true)

Get the PDO connection to use for a select query.

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

Run an insert statement against the database.

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

Run an update statement against the database.

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

Run a delete statement against the database.

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

Execute an SQL statement and return the boolean result.

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

Run an SQL statement and get the number of rows affected.

from  Connection
bool
unprepared(string $query)

Run a raw, unprepared query against the PDO connection.

from  Connection
int|null
threadCount()

Get the number of open connections for the database.

from  Connection
array
pretend(Closure $callback)

Execute the given callback in "dry run" mode.

from  Connection
mixed
withoutPretending(Closure $callback)

Execute the given callback without "pretending".

from  Connection
array
withFreshQueryLog(Closure $callback)

Execute the given callback in "dry run" mode.

from  Connection
void
bindValues(PDOStatement $statement, array $bindings)

Bind values to their parameters in the given statement.

from  Connection
array
prepareBindings(array $bindings)

Prepare the query bindings for execution.

from  Connection
mixed
run(string $query, array $bindings, Closure $callback)

Run a SQL statement and log its execution context.

from  Connection
mixed
runQueryCallback(string $query, array $bindings, Closure $callback)

Run a SQL statement.

from  Connection
bool
isUniqueConstraintError(Exception $exception)

Determine if the given database exception was caused by a unique constraint violation.

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

Log a query in the connection's query log.

from  Connection
float
getElapsedTime(float $start)

Get the elapsed time since a given starting point.

from  Connection
void
whenQueryingForLongerThan(DateTimeInterface|CarbonInterval|float|int $threshold, callable $handler)

Register a callback to be invoked when the connection queries for longer than a given amount of time.

from  Connection
void
allowQueryDurationHandlersToRunAgain()

Allow all the query duration handlers to run again, even if they have already run.

from  Connection
float
totalQueryDuration()

Get the duration of all run queries in milliseconds.

from  Connection
void
resetTotalQueryDuration()

Reset the duration of all run queries.

from  Connection
mixed
handleQueryException(QueryException $e, string $query, array $bindings, Closure $callback)

Handle a query exception.

from  Connection
mixed
tryAgainIfCausedByLostConnection(QueryException $e, string $query, array $bindings, Closure $callback)

Handle a query exception that occurred during query execution.

from  Connection
mixed|false
reconnect()

Reconnect to the database.

from  Connection
void
reconnectIfMissingConnection()

Reconnect to the database if a PDO connection is missing.

from  Connection
void
disconnect()

Disconnect from the underlying PDO connection.

from  Connection
$this
beforeStartingTransaction(Closure $callback)

Register a hook to be run just before a database transaction is started.

from  Connection
$this
beforeExecuting(Closure $callback)

Register a hook to be run just before a database query is executed.

from  Connection
void
listen(Closure $callback)

Register a database query listener with the connection.

from  Connection
array|null
fireConnectionEvent(string $event)

Fire an event for this connection.

from  Connection
void
event(mixed $event)

Fire the given event if possible.

from  Connection
Expression
raw(mixed $value)

Get a new raw query expression.

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

Escape a value for safe SQL embedding.

from  Connection
string
escapeString(string $value)

Escape a string value for safe SQL embedding.

from  Connection
string
escapeBool(bool $value)

Escape a boolean value for safe SQL embedding.

from  Connection
string
escapeBinary(string $value)

Escape a binary value for safe SQL embedding.

bool
hasModifiedRecords()

Determine if the database connection has modified any database records.

from  Connection
void
recordsHaveBeenModified(bool $value = true)

Indicate if any records have been modified.

from  Connection
$this
setRecordModificationState(bool $value)

Set the record modification state.

from  Connection
void
forgetRecordModificationState()

Reset the record modification state.

from  Connection
$this
useWriteConnectionWhenReading(bool $value = true)

Indicate that the connection should use the write PDO connection for reads.

from  Connection
PDO
getPdo()

Get the current PDO connection.

from  Connection
PDO|Closure|null
getRawPdo()

Get the current PDO connection parameter without executing any reconnect logic.

from  Connection
PDO
getReadPdo()

Get the current PDO connection used for reading.

from  Connection
PDO|Closure|null
getRawReadPdo()

Get the current read PDO connection parameter without executing any reconnect logic.

from  Connection
$this
setPdo(PDO|Closure|null $pdo)

Set the PDO connection.

from  Connection
$this
setReadPdo(PDO|Closure|null $pdo)

Set the PDO connection used for reading.

from  Connection
$this
setReconnector(callable $reconnector)

Set the reconnect instance on the connection.

from  Connection
string|null
getName()

Get the database connection name.

from  Connection
string|null
getNameWithReadWriteType()

Get the database connection full name.

from  Connection
mixed
getConfig(string|null $option = null)

Get an option from the configuration options.

from  Connection
string
getDriverName()

Get the PDO driver name.

from  Connection
string
getDriverTitle()

Get a human-readable name for the given connection driver.

Grammar
getQueryGrammar()

Get the query grammar used by the connection.

from  Connection
$this
setQueryGrammar(Grammar $grammar)

Set the query grammar used by the connection.

from  Connection
Grammar
getSchemaGrammar()

Get the schema grammar used by the connection.

from  Connection
$this
setSchemaGrammar(Grammar $grammar)

Set the schema grammar used by the connection.

from  Connection
Processor
getPostProcessor()

Get the query post processor used by the connection.

from  Connection
$this
setPostProcessor(Processor $processor)

Set the query post processor used by the connection.

from  Connection
Dispatcher
getEventDispatcher()

Get the event dispatcher used by the connection.

from  Connection
$this
setEventDispatcher(Dispatcher $events)

Set the event dispatcher instance on the connection.

from  Connection
void
unsetEventDispatcher()

Unset the event dispatcher for this connection.

from  Connection
$this
setTransactionManager(DatabaseTransactionsManager $manager)

Set the transaction manager instance on the connection.

from  Connection
void
unsetTransactionManager()

Unset the transaction manager for this connection.

from  Connection
bool
pretending()

Determine if the connection is in a "dry run".

from  Connection
array
getQueryLog()

Get the connection query log.

from  Connection
array
getRawQueryLog()

Get the connection query log with embedded bindings.

from  Connection
void
flushQueryLog()

Clear the query log.

from  Connection
void
enableQueryLog()

Enable the query log on the connection.

from  Connection
void
disableQueryLog()

Disable the query log on the connection.

from  Connection
bool
logging()

Determine whether we're logging queries.

from  Connection
string
getDatabaseName()

Get the name of the connected database.

from  Connection
$this
setDatabaseName(string $database)

Set the name of the connected database.

from  Connection
$this
setReadWriteType(string|null $readWriteType)

Set the read / write type of the connection.

from  Connection
string
getTablePrefix()

Get the table prefix for the connection.

from  Connection
$this
setTablePrefix(string $prefix)

Set the table prefix in use by the connection.

from  Connection
mixed
withoutTablePrefix(Closure $callback)

Execute the given callback without table prefix.

from  Connection
string
getServerVersion()

Get the server version for the connection.

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

Register a connection resolver.

from  Connection
static Closure|null
getResolver(string $driver)

Get the connection resolver for the given driver.

from  Connection
getSchemaState(Filesystem|null $files = null, callable|null $processFactory = null)

Get the schema state for the connection.

Details

in DetectsConcurrencyErrors at line 17
protected bool causedByConcurrencyError(Throwable $e)

Determine if the given exception was caused by a concurrency error such as a deadlock or serialization failure.

Parameters

Throwable $e

Return Value

bool

in DetectsLostConnections at line 16
protected bool causedByLostConnection(Throwable $e)

Determine if the given exception was caused by a lost connection.

Parameters

Throwable $e

Return Value

bool

at line 34
TReturn transaction(Closure $callback, int $attempts = 1)

Execute a Closure within a transaction.

Parameters

Closure $callback
int $attempts

Return Value

TReturn

Exceptions

Throwable

in ManagesTransactions at line 85
protected void handleTransactionException(Throwable $e, int $currentAttempt, int $maxAttempts)

Handle an exception encountered when running a transacted statement.

Parameters

Throwable $e
int $currentAttempt
int $maxAttempts

Return Value

void

Exceptions

Throwable

in ManagesTransactions at line 121
void beginTransaction()

Start a new database transaction.

Return Value

void

Exceptions

Throwable

in ManagesTransactions at line 145
protected void createTransaction()

Create a transaction within the database.

Return Value

void

Exceptions

Throwable

in ManagesTransactions at line 167
protected void createSavepoint()

Create a save point within the database.

Return Value

void

Exceptions

Throwable

in ManagesTransactions at line 182
protected void handleBeginTransactionException(Throwable $e)

Handle an exception from a transaction beginning.

Parameters

Throwable $e

Return Value

void

Exceptions

Throwable

in ManagesTransactions at line 200
void commit()

Commit the active database transaction.

Return Value

void

Exceptions

Throwable

in ManagesTransactions at line 229
protected void handleCommitTransactionException(Throwable $e, int $currentAttempt, int $maxAttempts)

Handle an exception encountered when committing a transaction.

Parameters

Throwable $e
int $currentAttempt
int $maxAttempts

Return Value

void

Exceptions

Throwable

in ManagesTransactions at line 252
void rollBack(int|null $toLevel = null)

Rollback the active database transaction.

Parameters

int|null $toLevel

Return Value

void

Exceptions

Throwable

in ManagesTransactions at line 291
protected void performRollBack(int $toLevel)

Perform a rollback within the database.

Parameters

int $toLevel

Return Value

void

Exceptions

Throwable

in ManagesTransactions at line 314
protected void handleRollBackException(Throwable $e)

Handle an exception from a rollback.

Parameters

Throwable $e

Return Value

void

Exceptions

Throwable

in ManagesTransactions at line 332
int transactionLevel()

Get the number of active transactions.

Return Value

int

in ManagesTransactions at line 345
void afterCommit(callable $callback)

Execute the callback after a transaction commits.

Parameters

callable $callback

Return Value

void

Exceptions

RuntimeException

in InteractsWithTime at line 17
protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

in InteractsWithTime at line 32
protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

in InteractsWithTime at line 47
protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

DateTimeInterface|int

in InteractsWithTime at line 61
protected int currentTime()

Get the current system time as a UNIX timestamp.

Return Value

int

in InteractsWithTime at line 73
protected string runTimeForHumans(float $startTime, float $endTime = null)

Given a start time, format the total run time for human readability.

Parameters

float $startTime
float $endTime

Return Value

string

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

in Macroable at line 112
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Connection at line 212
__construct(PDO|Closure $pdo, string $database = '', string $tablePrefix = '', array $config = [])

Create a new database connection instance.

Parameters

PDO|Closure $pdo
string $database
string $tablePrefix
array $config

in Connection at line 238
void useDefaultQueryGrammar()

Set the query grammar to the default implementation.

Return Value

void

at line 94
protected Grammar getDefaultQueryGrammar()

Get the default query grammar instance.

Return Value

Grammar

in Connection at line 258
void useDefaultSchemaGrammar()

Set the schema grammar to the default implementation.

Return Value

void

at line 118
protected Grammar|null getDefaultSchemaGrammar()

Get the default schema grammar instance.

Return Value

Grammar|null

in Connection at line 278
void useDefaultPostProcessor()

Set the query post processor to the default implementation.

Return Value

void

at line 141
protected Processor getDefaultPostProcessor()

Get the default post processor instance.

Return Value

Processor

at line 104
Builder getSchemaBuilder()

Get a schema builder instance for the connection.

Return Value

Builder

in Connection at line 314
Builder table(Closure|Builder|string $table, string|null $as = null)

Begin a fluent query against a database table.

Parameters

Closure|Builder|string $table
string|null $as

Return Value

Builder

in Connection at line 324
Builder query()

Get a new query builder instance.

Return Value

Builder

in Connection at line 339
mixed selectOne(string $query, array $bindings = [], bool $useReadPdo = true)

Run a select statement and return a single result.

Parameters

string $query
array $bindings
bool $useReadPdo

Return Value

mixed

in Connection at line 356
mixed scalar(string $query, array $bindings = [], bool $useReadPdo = true)

Run a select statement and return the first column of the first row.

Parameters

string $query
array $bindings
bool $useReadPdo

Return Value

mixed

Exceptions

MultipleColumnsSelectedException

in Connection at line 380
array selectFromWriteConnection(string $query, array $bindings = [])

Run a select statement against the database.

Parameters

string $query
array $bindings

Return Value

array

in Connection at line 393
array select(string $query, array $bindings = [], bool $useReadPdo = true)

Run a select statement against the database.

Parameters

string $query
array $bindings
bool $useReadPdo

Return Value

array

in Connection at line 423
array selectResultSets(string $query, array $bindings = [], bool $useReadPdo = true)

Run a select statement against the database and returns all of the result sets.

Parameters

string $query
array $bindings
bool $useReadPdo

Return Value

array

in Connection at line 456
Generator cursor(string $query, array $bindings = [], bool $useReadPdo = true)

Run a select statement against the database and returns a generator.

Parameters

string $query
array $bindings
bool $useReadPdo

Return Value

Generator

in Connection at line 492
protected PDOStatement prepared(PDOStatement $statement)

Configure the PDO prepared statement.

Parameters

PDOStatement $statement

Return Value

PDOStatement

in Connection at line 507
protected PDO getPdoForSelect(bool $useReadPdo = true)

Get the PDO connection to use for a select query.

Parameters

bool $useReadPdo

Return Value

PDO

in Connection at line 519
bool insert(string $query, array $bindings = [])

Run an insert statement against the database.

Parameters

string $query
array $bindings

Return Value

bool

in Connection at line 531
int update(string $query, array $bindings = [])

Run an update statement against the database.

Parameters

string $query
array $bindings

Return Value

int

in Connection at line 543
int delete(string $query, array $bindings = [])

Run a delete statement against the database.

Parameters

string $query
array $bindings

Return Value

int

in Connection at line 555
bool statement(string $query, array $bindings = [])

Execute an SQL statement and return the boolean result.

Parameters

string $query
array $bindings

Return Value

bool

in Connection at line 579
int affectingStatement(string $query, array $bindings = [])

Run an SQL statement and get the number of rows affected.

Parameters

string $query
array $bindings

Return Value

int

in Connection at line 609
bool unprepared(string $query)

Run a raw, unprepared query against the PDO connection.

Parameters

string $query

Return Value

bool

in Connection at line 629
int|null threadCount()

Get the number of open connections for the database.

Return Value

int|null

in Connection at line 642
array pretend(Closure $callback)

Execute the given callback in "dry run" mode.

Parameters

Closure $callback

Return Value

array

in Connection at line 664
mixed withoutPretending(Closure $callback)

Execute the given callback without "pretending".

Parameters

Closure $callback

Return Value

mixed

in Connection at line 685
protected array withFreshQueryLog(Closure $callback)

Execute the given callback in "dry run" mode.

Parameters

Closure $callback

Return Value

array

in Connection at line 713
void bindValues(PDOStatement $statement, array $bindings)

Bind values to their parameters in the given statement.

Parameters

PDOStatement $statement
array $bindings

Return Value

void

in Connection at line 734
array prepareBindings(array $bindings)

Prepare the query bindings for execution.

Parameters

array $bindings

Return Value

array

in Connection at line 762
protected mixed run(string $query, array $bindings, Closure $callback)

Run a SQL statement and log its execution context.

Parameters

string $query
array $bindings
Closure $callback

Return Value

mixed

Exceptions

QueryException

in Connection at line 803
protected mixed runQueryCallback(string $query, array $bindings, Closure $callback)

Run a SQL statement.

Parameters

string $query
array $bindings
Closure $callback

Return Value

mixed

Exceptions

QueryException

at line 84
protected bool isUniqueConstraintError(Exception $exception)

Determine if the given database exception was caused by a unique constraint violation.

Parameters

Exception $exception

Return Value

bool

in Connection at line 847
void logQuery(string $query, array $bindings, float|null $time = null)

Log a query in the connection's query log.

Parameters

string $query
array $bindings
float|null $time

Return Value

void

in Connection at line 868
protected float getElapsedTime(float $start)

Get the elapsed time since a given starting point.

Parameters

float $start

Return Value

float

in Connection at line 880
void whenQueryingForLongerThan(DateTimeInterface|CarbonInterval|float|int $threshold, callable $handler)

Register a callback to be invoked when the connection queries for longer than a given amount of time.

Parameters

DateTimeInterface|CarbonInterval|float|int $threshold
callable $handler

Return Value

void

in Connection at line 911
void allowQueryDurationHandlersToRunAgain()

Allow all the query duration handlers to run again, even if they have already run.

Return Value

void

in Connection at line 923
float totalQueryDuration()

Get the duration of all run queries in milliseconds.

Return Value

float

in Connection at line 933
void resetTotalQueryDuration()

Reset the duration of all run queries.

Return Value

void

in Connection at line 949
protected mixed handleQueryException(QueryException $e, string $query, array $bindings, Closure $callback)

Handle a query exception.

Parameters

QueryException $e
string $query
array $bindings
Closure $callback

Return Value

mixed

Exceptions

QueryException

in Connection at line 971
protected mixed tryAgainIfCausedByLostConnection(QueryException $e, string $query, array $bindings, Closure $callback)

Handle a query exception that occurred during query execution.

Parameters

QueryException $e
string $query
array $bindings
Closure $callback

Return Value

mixed

Exceptions

QueryException

in Connection at line 989
mixed|false reconnect()

Reconnect to the database.

Return Value

mixed|false

Exceptions

LostConnectionException

in Connection at line 1003
void reconnectIfMissingConnection()

Reconnect to the database if a PDO connection is missing.

Return Value

void

in Connection at line 1015
void disconnect()

Disconnect from the underlying PDO connection.

Return Value

void

in Connection at line 1026
$this beforeStartingTransaction(Closure $callback)

Register a hook to be run just before a database transaction is started.

Parameters

Closure $callback

Return Value

$this

in Connection at line 1039
$this beforeExecuting(Closure $callback)

Register a hook to be run just before a database query is executed.

Parameters

Closure $callback

Return Value

$this

in Connection at line 1052
void listen(Closure $callback)

Register a database query listener with the connection.

Parameters

Closure $callback

Return Value

void

in Connection at line 1063
protected array|null fireConnectionEvent(string $event)

Fire an event for this connection.

Parameters

string $event

Return Value

array|null

in Connection at line 1080
protected void event(mixed $event)

Fire the given event if possible.

Parameters

mixed $event

Return Value

void

in Connection at line 1091
Expression raw(mixed $value)

Get a new raw query expression.

Parameters

mixed $value

Return Value

Expression

in Connection at line 1103
string escape(string|float|int|bool|null $value, bool $binary = false)

Escape a value for safe SQL embedding.

Parameters

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

Return Value

string

in Connection at line 1134
protected string escapeString(string $value)

Escape a string value for safe SQL embedding.

Parameters

string $value

Return Value

string

in Connection at line 1145
protected string escapeBool(bool $value)

Escape a boolean value for safe SQL embedding.

Parameters

bool $value

Return Value

string

at line 71
protected string escapeBinary(string $value)

Escape a binary value for safe SQL embedding.

Parameters

string $value

Return Value

string

in Connection at line 1166
bool hasModifiedRecords()

Determine if the database connection has modified any database records.

Return Value

bool

in Connection at line 1177
void recordsHaveBeenModified(bool $value = true)

Indicate if any records have been modified.

Parameters

bool $value

Return Value

void

in Connection at line 1190
$this setRecordModificationState(bool $value)

Set the record modification state.

Parameters

bool $value

Return Value

$this

in Connection at line 1202
void forgetRecordModificationState()

Reset the record modification state.

Return Value

void

in Connection at line 1213
$this useWriteConnectionWhenReading(bool $value = true)

Indicate that the connection should use the write PDO connection for reads.

Parameters

bool $value

Return Value

$this

in Connection at line 1225
PDO getPdo()

Get the current PDO connection.

Return Value

PDO

in Connection at line 1239
PDO|Closure|null getRawPdo()

Get the current PDO connection parameter without executing any reconnect logic.

Return Value

PDO|Closure|null

in Connection at line 1249
PDO getReadPdo()

Get the current PDO connection used for reading.

Return Value

PDO

in Connection at line 1272
PDO|Closure|null getRawReadPdo()

Get the current read PDO connection parameter without executing any reconnect logic.

Return Value

PDO|Closure|null

in Connection at line 1283
$this setPdo(PDO|Closure|null $pdo)

Set the PDO connection.

Parameters

PDO|Closure|null $pdo

Return Value

$this

in Connection at line 1298
$this setReadPdo(PDO|Closure|null $pdo)

Set the PDO connection used for reading.

Parameters

PDO|Closure|null $pdo

Return Value

$this

in Connection at line 1311
$this setReconnector(callable $reconnector)

Set the reconnect instance on the connection.

Parameters

callable $reconnector

Return Value

$this

in Connection at line 1323
string|null getName()

Get the database connection name.

Return Value

string|null

in Connection at line 1333
string|null getNameWithReadWriteType()

Get the database connection full name.

Return Value

string|null

in Connection at line 1344
mixed getConfig(string|null $option = null)

Get an option from the configuration options.

Parameters

string|null $option

Return Value

mixed

in Connection at line 1354
string getDriverName()

Get the PDO driver name.

Return Value

string

at line 20
string getDriverTitle()

Get a human-readable name for the given connection driver.

Return Value

string

in Connection at line 1374
Grammar getQueryGrammar()

Get the query grammar used by the connection.

Return Value

Grammar

in Connection at line 1385
$this setQueryGrammar(Grammar $grammar)

Set the query grammar used by the connection.

Parameters

Grammar $grammar

Return Value

$this

in Connection at line 1397
Grammar getSchemaGrammar()

Get the schema grammar used by the connection.

Return Value

Grammar

in Connection at line 1408
$this setSchemaGrammar(Grammar $grammar)

Set the schema grammar used by the connection.

Parameters

Grammar $grammar

Return Value

$this

in Connection at line 1420
Processor getPostProcessor()

Get the query post processor used by the connection.

Return Value

Processor

in Connection at line 1431
$this setPostProcessor(Processor $processor)

Set the query post processor used by the connection.

Parameters

Processor $processor

Return Value

$this

in Connection at line 1443
Dispatcher getEventDispatcher()

Get the event dispatcher used by the connection.

Return Value

Dispatcher

in Connection at line 1454
$this setEventDispatcher(Dispatcher $events)

Set the event dispatcher instance on the connection.

Parameters

Dispatcher $events

Return Value

$this

in Connection at line 1466
void unsetEventDispatcher()

Unset the event dispatcher for this connection.

Return Value

void

in Connection at line 1477
$this setTransactionManager(DatabaseTransactionsManager $manager)

Set the transaction manager instance on the connection.

Parameters

DatabaseTransactionsManager $manager

Return Value

$this

in Connection at line 1489
void unsetTransactionManager()

Unset the transaction manager for this connection.

Return Value

void

in Connection at line 1499
bool pretending()

Determine if the connection is in a "dry run".

Return Value

bool

in Connection at line 1509
array getQueryLog()

Get the connection query log.

Return Value

array

in Connection at line 1519
array getRawQueryLog()

Get the connection query log with embedded bindings.

Return Value

array

in Connection at line 1535
void flushQueryLog()

Clear the query log.

Return Value

void

in Connection at line 1545
void enableQueryLog()

Enable the query log on the connection.

Return Value

void

in Connection at line 1555
void disableQueryLog()

Disable the query log on the connection.

Return Value

void

in Connection at line 1565
bool logging()

Determine whether we're logging queries.

Return Value

bool

in Connection at line 1575
string getDatabaseName()

Get the name of the connected database.

Return Value

string

in Connection at line 1586
$this setDatabaseName(string $database)

Set the name of the connected database.

Parameters

string $database

Return Value

$this

in Connection at line 1599
$this setReadWriteType(string|null $readWriteType)

Set the read / write type of the connection.

Parameters

string|null $readWriteType

Return Value

$this

in Connection at line 1611
string getTablePrefix()

Get the table prefix for the connection.

Return Value

string

in Connection at line 1622
$this setTablePrefix(string $prefix)

Set the table prefix in use by the connection.

Parameters

string $prefix

Return Value

$this

in Connection at line 1635
mixed withoutTablePrefix(Closure $callback)

Execute the given callback without table prefix.

Parameters

Closure $callback

Return Value

mixed

in Connection at line 1653
string getServerVersion()

Get the server version for the connection.

Return Value

string

in Connection at line 1665
static void resolverFor(string $driver, Closure $callback)

Register a connection resolver.

Parameters

string $driver
Closure $callback

Return Value

void

in Connection at line 1676
static Closure|null getResolver(string $driver)

Get the connection resolver for the given driver.

Parameters

string $driver

Return Value

Closure|null

at line 131
getSchemaState(Filesystem|null $files = null, callable|null $processFactory = null)

Get the schema state for the connection.

Parameters

Filesystem|null $files
callable|null $processFactory

Exceptions

RuntimeException