Connection
class Connection implements ConnectionInterface (View source)
Traits
Properties
| static protected array | $macros | The registered string macros. | from Macroable |
| protected | $pdo | ||
| protected | $readPdo | ||
| protected string | $database | The name of the connected database. | |
| protected string|null | $readWriteType | The type of the connection. | |
| protected string | $tablePrefix | The table prefix for the connection. | |
| protected array | $config | The database connection configuration options. | |
| protected | $reconnector | The reconnector instance for the connection. | |
| protected Grammar | $queryGrammar | The query grammar implementation. | |
| protected Grammar | $schemaGrammar | The schema grammar implementation. | |
| protected Processor | $postProcessor | The query post processor implementation. | |
| protected Dispatcher|null | $events | The event dispatcher instance. | |
| protected int | $fetchMode | The default fetch mode of the connection. | |
| protected int | $transactions | The number of active transactions. | |
| protected DatabaseTransactionsManager|null | $transactionsManager | The transaction manager instance. | |
| protected bool | $recordsModified | Indicates if changes have been made to the database. | |
| protected bool | $readOnWriteConnection | Indicates if the connection should use the "write" PDO connection. | |
| protected | $queryLog | All of the queries run against the connection. | |
| protected bool | $loggingQueries | Indicates whether queries are being logged. | |
| protected float | $totalQueryDuration | The duration of all executed queries in milliseconds. | |
| protected | $queryDurationHandlers | All of the registered query duration handlers. | |
| protected bool | $pretending | Indicates if the connection is in a "dry run". | |
| protected Closure[] | $beforeStartingTransaction | All of the callbacks that should be invoked before a transaction is started. | |
| protected | $beforeExecutingCallbacks | All of the callbacks that should be invoked before a query is executed. | |
| static protected Closure[] | $resolvers | The connection resolvers. |
Methods
Determine if the given exception was caused by a concurrency error such as a deadlock or serialization failure.
Determine if the given exception was caused by a lost connection.
Handle an exception encountered when running a transacted statement.
Handle an exception encountered when committing a transaction.
Rollback the active database transaction.
Execute the callback after a transaction commits.
Execute the callback after a transaction rolls back.
Get the number of seconds until the given DateTime.
If the given value is an interval, convert it to a DateTime instance.
Given a start time, format the total run time for human readability.
Mix another object into the class.
Dynamically handle calls to the class.
Dynamically handle calls to the class.
No description
Set the query grammar to the default implementation.
Get the default query grammar instance.
Set the schema grammar to the default implementation.
Get the default schema grammar instance.
Set the query post processor to the default implementation.
Get the default post processor instance.
Get a schema builder instance for the connection.
Run a select statement and return a single result.
Run a select statement and return the first column of the first row.
Run a select statement against the database.
Run a select statement against the database.
Run a select statement against the database and returns all of the result sets.
Run a select statement against the database and returns a generator.
Get the PDO connection to use for a select query.
Run an insert statement against the database.
Run an update statement against the database.
Run a delete statement against the database.
Execute an SQL statement and return the boolean result.
Run an SQL statement and get the number of rows affected.
Run a raw, unprepared query against the PDO connection.
Get the number of open connections for the database.
No description
Bind values to their parameters in the given statement.
Prepare the query bindings for execution.
Determine if the given database exception was caused by a unique constraint violation.
Log a query in the connection's query log.
Get the elapsed time in milliseconds since a given starting point.
Register a callback to be invoked when the connection queries for longer than a given amount of time.
Allow all the query duration handlers to run again, even if they have already run.
Get the duration of all run queries in milliseconds.
Reset the duration of all run queries.
Handle a query exception.
Handle a query exception that occurred during query execution.
Reconnect to the database.
Reconnect to the database if a PDO connection is missing.
Disconnect from the underlying PDO connection.
Register a hook to be run just before a database transaction is started.
Register a hook to be run just before a database query is executed.
Fire an event for this connection.
Fire the given event if possible.
Get a new raw query expression.
Escape a value for safe SQL embedding.
Escape a string value for safe SQL embedding.
Escape a boolean value for safe SQL embedding.
Escape a binary value for safe SQL embedding.
Determine if the database connection has modified any database records.
Indicate if any records have been modified.
Set the record modification state.
Reset the record modification state.
Indicate that the connection should use the write PDO connection for reads.
Get the current PDO connection parameter without executing any reconnect logic.
Get the current PDO connection used for reading.
Get the current read PDO connection parameter without executing any reconnect logic.
Set the reconnect instance on the connection.
Get the database connection name.
Get the database connection full name.
Get an option from the configuration options.
Get the PDO driver name.
Get a human-readable name for the given connection driver.
Get the query grammar used by the connection.
Get the schema grammar used by the connection.
Get the query post processor used by the connection.
Get the event dispatcher used by the connection.
Unset the event dispatcher for this connection.
Run the statement to start a new transaction.
Set the transaction manager instance on the connection.
Unset the transaction manager for this connection.
Determine if the connection is in a "dry run".
Get the connection query log.
Get the connection query log with embedded bindings.
Clear the query log.
Enable the query log on the connection.
Disable the query log on the connection.
Determine whether we're logging queries.
Get the name of the connected database.
Set the name of the connected database.
Set the read / write type of the connection.
Get the table prefix for the connection.
Set the table prefix in use by the connection.
Get the server version for the connection.
Get the connection resolver for the given driver.
Details
protected bool causedByConcurrencyError(Throwable $e)
Determine if the given exception was caused by a concurrency error such as a deadlock or serialization failure.
protected bool causedByLostConnection(Throwable $e)
Determine if the given exception was caused by a lost connection.
TReturn transaction(Closure $callback, int $attempts = 1)
No description
protected void handleTransactionException(Throwable $e, int $currentAttempt, int $maxAttempts)
Handle an exception encountered when running a transacted statement.
void beginTransaction()
Start a new database transaction.
protected void createTransaction()
Create a transaction within the database.
protected void createSavepoint()
Create a save point within the database.
protected void handleBeginTransactionException(Throwable $e)
Handle an exception from a transaction beginning.
void commit()
Commit the active database transaction.
protected void handleCommitTransactionException(Throwable $e, int $currentAttempt, int $maxAttempts)
Handle an exception encountered when committing a transaction.
void rollBack(int|null $toLevel = null)
Rollback the active database transaction.
protected void performRollBack(int $toLevel)
Perform a rollback within the database.
protected void handleRollBackException(Throwable $e)
Handle an exception from a rollback.
int transactionLevel()
Get the number of active transactions.
void afterCommit(callable $callback)
Execute the callback after a transaction commits.
void afterRollBack(callable $callback)
Execute the callback after a transaction rolls back.
protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)
Get the number of seconds until the given DateTime.
protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)
Get the "available at" UNIX timestamp.
protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)
If the given value is an interval, convert it to a DateTime instance.
protected int currentTime()
Get the current system time as a UNIX timestamp.
protected string runTimeForHumans(float $startTime, float|null $endTime = null)
Given a start time, format the total run time for human readability.
static void macro(string $name, object|callable $macro)
Register a custom macro.
static void mixin(object $mixin, bool $replace = true)
Mix another object into the class.
static bool hasMacro(string $name)
Checks if macro is registered.
static void flushMacros()
Flush the existing macros.
static mixed __callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
mixed __call(string $method, array $parameters)
Dynamically handle calls to the class.
__construct($pdo, $database = '', $tablePrefix = '', array $config = [])
No description
void useDefaultQueryGrammar()
Set the query grammar to the default implementation.
protected Grammar getDefaultQueryGrammar()
Get the default query grammar instance.
void useDefaultSchemaGrammar()
Set the schema grammar to the default implementation.
protected Grammar|null getDefaultSchemaGrammar()
Get the default schema grammar instance.
void useDefaultPostProcessor()
Set the query post processor to the default implementation.
protected Processor getDefaultPostProcessor()
Get the default post processor instance.
Builder getSchemaBuilder()
Get a schema builder instance for the connection.
Builder table(Closure|Builder|UnitEnum|string $table, string|null $as = null)
Begin a fluent query against a database table.
Builder query()
Get a new query builder instance.
mixed selectOne(string $query, array $bindings = [], bool $useReadPdo = true)
Run a select statement and return a single result.
mixed scalar(string $query, array $bindings = [], bool $useReadPdo = true)
Run a select statement and return the first column of the first row.
array selectFromWriteConnection(string $query, array $bindings = [])
Run a select statement against the database.
array select(string $query, array $bindings = [], bool $useReadPdo = true)
Run a select statement against the database.
array selectResultSets(string $query, array $bindings = [], bool $useReadPdo = true)
Run a select statement against the database and returns all of the result sets.
Generator cursor(string $query, array $bindings = [], bool $useReadPdo = true)
Run a select statement against the database and returns a generator.
protected PDOStatement prepared(PDOStatement $statement)
Configure the PDO prepared statement.
protected PDO getPdoForSelect(bool $useReadPdo = true)
Get the PDO connection to use for a select query.
bool insert(string $query, array $bindings = [])
Run an insert statement against the database.
int update(string $query, array $bindings = [])
Run an update statement against the database.
int delete(string $query, array $bindings = [])
Run a delete statement against the database.
bool statement(string $query, array $bindings = [])
Execute an SQL statement and return the boolean result.
int affectingStatement(string $query, array $bindings = [])
Run an SQL statement and get the number of rows affected.
bool unprepared(string $query)
Run a raw, unprepared query against the PDO connection.
int|null threadCount()
Get the number of open connections for the database.
array pretend(Closure $callback)
Execute the given callback in "dry run" mode.
mixed withoutPretending(Closure $callback)
Execute the given callback without "pretending".
protected withFreshQueryLog($callback)
No description
void bindValues(PDOStatement $statement, array $bindings)
Bind values to their parameters in the given statement.
array prepareBindings(array $bindings)
Prepare the query bindings for execution.
protected mixed run(string $query, array $bindings, Closure $callback)
Run a SQL statement and log its execution context.
protected mixed runQueryCallback(string $query, array $bindings, Closure $callback)
Run a SQL statement.
protected 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.
protected float getElapsedTime(float $start)
Get the elapsed time in milliseconds since a given starting point.
void whenQueryingForLongerThan(DateTimeInterface|CarbonInterval|float|int $threshold, $handler)
Register a callback to be invoked when the connection queries for longer than a given amount of time.
void allowQueryDurationHandlersToRunAgain()
Allow all the query duration handlers to run again, even if they have already run.
float totalQueryDuration()
Get the duration of all run queries in milliseconds.
void resetTotalQueryDuration()
Reset the duration of all run queries.
protected mixed handleQueryException(QueryException $e, string $query, array $bindings, Closure $callback)
Handle a query exception.
protected mixed tryAgainIfCausedByLostConnection(QueryException $e, string $query, array $bindings, Closure $callback)
Handle a query exception that occurred during query execution.
mixed|false reconnect()
Reconnect to the database.
void reconnectIfMissingConnection()
Reconnect to the database if a PDO connection is missing.
void disconnect()
Disconnect from the underlying PDO connection.
$this beforeStartingTransaction(Closure $callback)
Register a hook to be run just before a database transaction is started.
$this beforeExecuting(Closure $callback)
Register a hook to be run just before a database query is executed.
void listen(Closure $callback)
Register a database query listener with the connection.
protected array|null fireConnectionEvent(string $event)
Fire an event for this connection.
protected void event(mixed $event)
Fire the given event if possible.
Expression raw(mixed $value)
Get a new raw query expression.
string escape(string|float|int|bool|null $value, bool $binary = false)
Escape a value for safe SQL embedding.
protected string escapeString(string $value)
Escape a string value for safe SQL embedding.
protected string escapeBool(bool $value)
Escape a boolean value for safe SQL embedding.
protected string escapeBinary(string $value)
Escape a binary value for safe SQL embedding.
bool hasModifiedRecords()
Determine if the database connection has modified any database records.
void recordsHaveBeenModified(bool $value = true)
Indicate if any records have been modified.
$this setRecordModificationState(bool $value)
Set the record modification state.
void forgetRecordModificationState()
Reset the record modification state.
$this useWriteConnectionWhenReading(bool $value = true)
Indicate that the connection should use the write PDO connection for reads.
PDO getPdo()
Get the current PDO connection.
PDO|Closure|null getRawPdo()
Get the current PDO connection parameter without executing any reconnect logic.
PDO getReadPdo()
Get the current PDO connection used for reading.
PDO|Closure|null getRawReadPdo()
Get the current read PDO connection parameter without executing any reconnect logic.
$this setReconnector(callable $reconnector)
Set the reconnect instance on the connection.
string|null getName()
Get the database connection name.
string|null getNameWithReadWriteType()
Get the database connection full name.
mixed getConfig(string|null $option = null)
Get an option from the configuration options.
string getDriverName()
Get the PDO driver name.
string getDriverTitle()
Get a human-readable name for the given connection driver.
Grammar getQueryGrammar()
Get the query grammar used by the connection.
$this setQueryGrammar(Grammar $grammar)
Set the query grammar used by the connection.
Grammar getSchemaGrammar()
Get the schema grammar used by the connection.
$this setSchemaGrammar(Grammar $grammar)
Set the schema grammar used by the connection.
Processor getPostProcessor()
Get the query post processor used by the connection.
$this setPostProcessor(Processor $processor)
Set the query post processor used by the connection.
Dispatcher getEventDispatcher()
Get the event dispatcher used by the connection.
$this setEventDispatcher(Dispatcher $events)
Set the event dispatcher instance on the connection.
void unsetEventDispatcher()
Unset the event dispatcher for this connection.
protected void executeBeginTransactionStatement()
Run the statement to start a new transaction.
$this setTransactionManager(DatabaseTransactionsManager $manager)
Set the transaction manager instance on the connection.
void unsetTransactionManager()
Unset the transaction manager for this connection.
bool pretending()
Determine if the connection is in a "dry run".
getQueryLog()
Get the connection query log.
array getRawQueryLog()
Get the connection query log with embedded bindings.
void flushQueryLog()
Clear the query log.
void enableQueryLog()
Enable the query log on the connection.
void disableQueryLog()
Disable the query log on the connection.
bool logging()
Determine whether we're logging queries.
string getDatabaseName()
Get the name of the connected database.
$this setDatabaseName(string $database)
Set the name of the connected database.
$this setReadWriteType(string|null $readWriteType)
Set the read / write type of the connection.
string getTablePrefix()
Get the table prefix for the connection.
$this setTablePrefix(string $prefix)
Set the table prefix in use by the connection.
mixed withoutTablePrefix(Closure $callback)
Execute the given callback without table prefix.
string getServerVersion()
Get the server version for the connection.
static void resolverFor(string $driver, Closure $callback)
Register a connection resolver.
static Closure|null getResolver(string $driver)
Get the connection resolver for the given driver.