PHP Class Illuminate\Database\Connection

Inheritance: implements Illuminate\Database\ConnectionInterface, use trait Illuminate\Database\DetectsDeadlocks, use trait Illuminate\Database\DetectsLostConnections
Afficher le fichier Open project: illuminate/database Class Usage Examples

Protected Properties

Свойство Type Description
$config array The database connection configuration options.
$database string The name of the connected database.
$doctrineConnection Doctrine\DBAL\Connection The instance of Doctrine connection.
$events Illuminate\Contracts\Events\Dispatcher The event dispatcher instance.
$fetchArgument mixed The argument for the fetch mode.
$fetchConstructorArgument array The constructor arguments for the PDO::FETCH_CLASS fetch mode.
$fetchMode integer The default fetch mode of the connection.
$loggingQueries boolean Indicates whether queries are being logged.
$pdo PDO The active PDO connection.
$postProcessor Illuminate\Database\Query\Processors\Processor The query post processor implementation.
$pretending boolean Indicates if the connection is in a "dry run".
$queryGrammar Illuminate\Database\Query\Grammars\Grammar The query grammar implementation.
$queryLog array All of the queries run against the connection.
$readPdo PDO The active PDO connection used for reads.
$reconnector callable The reconnector instance for the connection.
$schemaGrammar Illuminate\Database\Schema\Grammars\Grammar The schema grammar implementation.
$tablePrefix string The table prefix for the connection.
$transactions integer The number of active transactions.

Méthodes publiques

Méthode Description
__construct ( PDO | Closure $pdo, string $database = '', string $tablePrefix = '', array $config = [] ) : void Create a new database connection instance.
affectingStatement ( string $query, array $bindings = [] ) : integer Run an SQL statement and get the number of rows affected.
beginTransaction ( ) : void Start a new database transaction.
bindValues ( PDOStatement $statement, array $bindings ) : void Bind values to their parameters in the given statement.
commit ( ) : void Commit the active database transaction.
cursor ( string $query, array $bindings = [], boolean $useReadPdo = true ) : Generator Run a select statement against the database and returns a generator.
delete ( string $query, array $bindings = [] ) : integer Run a delete statement against the database.
disableQueryLog ( ) : void Disable the query log on the connection.
disconnect ( ) : void Disconnect from the underlying PDO connection.
enableQueryLog ( ) : void Enable the query log on the connection.
flushQueryLog ( ) : void Clear the query log.
getConfig ( string $option ) : mixed Get an option from the configuration options.
getDatabaseName ( ) : string Get the name of the connected database.
getDoctrineColumn ( string $table, string $column ) : Doctrine\DBAL\Schema\Column Get a Doctrine Schema Column instance.
getDoctrineConnection ( ) : Doctrine\DBAL\Connection Get the Doctrine DBAL database connection instance.
getDoctrineSchemaManager ( ) : Doctrine\DBAL\Schema\AbstractSchemaManager Get the Doctrine DBAL schema manager for the connection.
getDriverName ( ) : string Get the PDO driver name.
getEventDispatcher ( ) : Illuminate\Contracts\Events\Dispatcher Get the event dispatcher used by the connection.
getFetchArgument ( ) : mixed Get the fetch argument to be applied when selecting.
getFetchConstructorArgument ( ) : array Get custom constructor arguments for the PDO::FETCH_CLASS fetch mode.
getFetchMode ( ) : integer Get the default fetch mode for the connection.
getName ( ) : string | null Get the database connection name.
getPdo ( ) : PDO Get the current PDO connection.
getPostProcessor ( ) : Illuminate\Database\Query\Processors\Processor Get the query post processor used by the connection.
getQueryGrammar ( ) : Illuminate\Database\Query\Grammars\Grammar Get the query grammar used by the connection.
getQueryLog ( ) : array Get the connection query log.
getReadPdo ( ) : PDO Get the current PDO connection used for reading.
getSchemaBuilder ( ) : Illuminate\Database\Schema\Builder Get a schema builder instance for the connection.
getSchemaGrammar ( ) : Illuminate\Database\Schema\Grammars\Grammar Get the schema grammar used by the connection.
getTablePrefix ( ) : string Get the table prefix for the connection.
insert ( string $query, array $bindings = [] ) : boolean Run an insert statement against the database.
isDoctrineAvailable ( ) : boolean Is Doctrine available?
listen ( Closure $callback ) : void Register a database query listener with the connection.
logQuery ( string $query, array $bindings, float | null $time = null ) : void Log a query in the connection's query log.
logging ( ) : boolean Determine whether we're logging queries.
prepareBindings ( array $bindings ) : array Prepare the query bindings for execution.
pretend ( Closure $callback ) : array Execute the given callback in "dry run" mode.
pretending ( ) : boolean Determine if the connection in a "dry run".
query ( ) : Builder Get a new query builder instance.
raw ( mixed $value ) : Illuminate\Database\Query\Expression Get a new raw query expression.
reconnect ( ) : void Reconnect to the database.
rollBack ( integer | null $toLevel = null ) : void Rollback the active database transaction.
select ( string $query, array $bindings = [], boolean $useReadPdo = true ) : array Run a select statement against the database.
selectFromWriteConnection ( string $query, array $bindings = [] ) : array Run a select statement against the database.
selectOne ( string $query, array $bindings = [] ) : mixed | null Run a select statement and return a single result.
setDatabaseName ( string $database ) : string Set the name of the connected database.
setEventDispatcher ( Illuminate\Contracts\Events\Dispatcher $events ) : void Set the event dispatcher instance on the connection.
setFetchMode ( integer $fetchMode, mixed $fetchArgument = null, array $fetchConstructorArgument = [] ) : integer Set the default fetch mode for the connection, and optional arguments for the given fetch mode.
setPdo ( PDO | null $pdo ) Set the PDO connection.
setPostProcessor ( Illuminate\Database\Query\Processors\Processor $processor ) : void Set the query post processor used by the connection.
setQueryGrammar ( Illuminate\Database\Query\Grammars\Grammar $grammar ) : void Set the query grammar used by the connection.
setReadPdo ( PDO | null $pdo ) Set the PDO connection used for reading.
setReconnector ( callable $reconnector ) Set the reconnect instance on the connection.
setSchemaGrammar ( Illuminate\Database\Schema\Grammars\Grammar $grammar ) : void Set the schema grammar used by the connection.
setTablePrefix ( string $prefix ) : void Set the table prefix in use by the connection.
statement ( string $query, array $bindings = [] ) : boolean Execute an SQL statement and return the boolean result.
table ( string $table ) : Builder Begin a fluent query against a database table.
transaction ( Closure $callback, integer $attempts = 1 ) : mixed Execute a Closure within a transaction.
transactionLevel ( ) : integer Get the number of active transactions.
unprepared ( string $query ) : boolean Run a raw, unprepared query against the PDO connection.
update ( string $query, array $bindings = [] ) : integer Run an update statement against the database.
useDefaultPostProcessor ( ) : void Set the query post processor to the default implementation.
useDefaultQueryGrammar ( ) : void Set the query grammar to the default implementation.
useDefaultSchemaGrammar ( ) : void Set the schema grammar to the default implementation.
withTablePrefix ( Illuminate\Database\Grammar $grammar ) : Illuminate\Database\Grammar Set the table prefix and return the grammar.

Méthodes protégées

Méthode Description
fireConnectionEvent ( string $event ) : void Fire an event for this connection.
getDefaultPostProcessor ( ) : Illuminate\Database\Query\Processors\Processor Get the default post processor instance.
getDefaultQueryGrammar ( ) : Illuminate\Database\Query\Grammars\Grammar Get the default query grammar instance.
getDefaultSchemaGrammar ( ) : Illuminate\Database\Schema\Grammars\Grammar Get the default schema grammar instance.
getElapsedTime ( integer $start ) : float Get the elapsed time since a given starting point.
getPdoForSelect ( boolean $useReadPdo = true ) : PDO Get the PDO connection to use for a select query.
reconnectIfMissingConnection ( ) : void Reconnect to the database if a PDO connection is missing.
run ( string $query, array $bindings, Closure $callback ) : mixed Run a SQL statement and log its execution context.
runQueryCallback ( string $query, array $bindings, Closure $callback ) : mixed Run a SQL statement.
tryAgainIfCausedByLostConnection ( Illuminate\Database\QueryException $e, string $query, array $bindings, Closure $callback ) : mixed Handle a query exception that occurred during query execution.

Method Details

__construct() public méthode

Create a new database connection instance.
public __construct ( PDO | Closure $pdo, string $database = '', string $tablePrefix = '', array $config = [] ) : void
$pdo PDO | Closure
$database string
$tablePrefix string
$config array
Résultat void

affectingStatement() public méthode

Run an SQL statement and get the number of rows affected.
public affectingStatement ( string $query, array $bindings = [] ) : integer
$query string
$bindings array
Résultat integer

beginTransaction() public méthode

Start a new database transaction.
public beginTransaction ( ) : void
Résultat void

bindValues() public méthode

Bind values to their parameters in the given statement.
public bindValues ( PDOStatement $statement, array $bindings ) : void
$statement PDOStatement
$bindings array
Résultat void

commit() public méthode

Commit the active database transaction.
public commit ( ) : void
Résultat void

cursor() public méthode

Run a select statement against the database and returns a generator.
public cursor ( string $query, array $bindings = [], boolean $useReadPdo = true ) : Generator
$query string
$bindings array
$useReadPdo boolean
Résultat Generator

delete() public méthode

Run a delete statement against the database.
public delete ( string $query, array $bindings = [] ) : integer
$query string
$bindings array
Résultat integer

disableQueryLog() public méthode

Disable the query log on the connection.
public disableQueryLog ( ) : void
Résultat void

disconnect() public méthode

Disconnect from the underlying PDO connection.
public disconnect ( ) : void
Résultat void

enableQueryLog() public méthode

Enable the query log on the connection.
public enableQueryLog ( ) : void
Résultat void

fireConnectionEvent() protected méthode

Fire an event for this connection.
protected fireConnectionEvent ( string $event ) : void
$event string
Résultat void

flushQueryLog() public méthode

Clear the query log.
public flushQueryLog ( ) : void
Résultat void

getConfig() public méthode

Get an option from the configuration options.
public getConfig ( string $option ) : mixed
$option string
Résultat mixed

getDatabaseName() public méthode

Get the name of the connected database.
public getDatabaseName ( ) : string
Résultat string

getDefaultPostProcessor() protected méthode

Get the default post processor instance.
protected getDefaultPostProcessor ( ) : Illuminate\Database\Query\Processors\Processor
Résultat Illuminate\Database\Query\Processors\Processor

getDefaultQueryGrammar() protected méthode

Get the default query grammar instance.
protected getDefaultQueryGrammar ( ) : Illuminate\Database\Query\Grammars\Grammar
Résultat Illuminate\Database\Query\Grammars\Grammar

getDefaultSchemaGrammar() protected méthode

Get the default schema grammar instance.
protected getDefaultSchemaGrammar ( ) : Illuminate\Database\Schema\Grammars\Grammar
Résultat Illuminate\Database\Schema\Grammars\Grammar

getDoctrineColumn() public méthode

Get a Doctrine Schema Column instance.
public getDoctrineColumn ( string $table, string $column ) : Doctrine\DBAL\Schema\Column
$table string
$column string
Résultat Doctrine\DBAL\Schema\Column

getDoctrineConnection() public méthode

Get the Doctrine DBAL database connection instance.
public getDoctrineConnection ( ) : Doctrine\DBAL\Connection
Résultat Doctrine\DBAL\Connection

getDoctrineSchemaManager() public méthode

Get the Doctrine DBAL schema manager for the connection.
public getDoctrineSchemaManager ( ) : Doctrine\DBAL\Schema\AbstractSchemaManager
Résultat Doctrine\DBAL\Schema\AbstractSchemaManager

getDriverName() public méthode

Get the PDO driver name.
public getDriverName ( ) : string
Résultat string

getElapsedTime() protected méthode

Get the elapsed time since a given starting point.
protected getElapsedTime ( integer $start ) : float
$start integer
Résultat float

getEventDispatcher() public méthode

Get the event dispatcher used by the connection.
public getEventDispatcher ( ) : Illuminate\Contracts\Events\Dispatcher
Résultat Illuminate\Contracts\Events\Dispatcher

getFetchArgument() public méthode

Get the fetch argument to be applied when selecting.
public getFetchArgument ( ) : mixed
Résultat mixed

getFetchConstructorArgument() public méthode

Get custom constructor arguments for the PDO::FETCH_CLASS fetch mode.
public getFetchConstructorArgument ( ) : array
Résultat array

getFetchMode() public méthode

Get the default fetch mode for the connection.
public getFetchMode ( ) : integer
Résultat integer

getName() public méthode

Get the database connection name.
public getName ( ) : string | null
Résultat string | null

getPdo() public méthode

Get the current PDO connection.
public getPdo ( ) : PDO
Résultat PDO

getPdoForSelect() protected méthode

Get the PDO connection to use for a select query.
protected getPdoForSelect ( boolean $useReadPdo = true ) : PDO
$useReadPdo boolean
Résultat PDO

getPostProcessor() public méthode

Get the query post processor used by the connection.
public getPostProcessor ( ) : Illuminate\Database\Query\Processors\Processor
Résultat Illuminate\Database\Query\Processors\Processor

getQueryGrammar() public méthode

Get the query grammar used by the connection.
public getQueryGrammar ( ) : Illuminate\Database\Query\Grammars\Grammar
Résultat Illuminate\Database\Query\Grammars\Grammar

getQueryLog() public méthode

Get the connection query log.
public getQueryLog ( ) : array
Résultat array

getReadPdo() public méthode

Get the current PDO connection used for reading.
public getReadPdo ( ) : PDO
Résultat PDO

getSchemaBuilder() public méthode

Get a schema builder instance for the connection.
public getSchemaBuilder ( ) : Illuminate\Database\Schema\Builder
Résultat Illuminate\Database\Schema\Builder

getSchemaGrammar() public méthode

Get the schema grammar used by the connection.
public getSchemaGrammar ( ) : Illuminate\Database\Schema\Grammars\Grammar
Résultat Illuminate\Database\Schema\Grammars\Grammar

getTablePrefix() public méthode

Get the table prefix for the connection.
public getTablePrefix ( ) : string
Résultat string

insert() public méthode

Run an insert statement against the database.
public insert ( string $query, array $bindings = [] ) : boolean
$query string
$bindings array
Résultat boolean

isDoctrineAvailable() public méthode

Is Doctrine available?
public isDoctrineAvailable ( ) : boolean
Résultat boolean

listen() public méthode

Register a database query listener with the connection.
public listen ( Closure $callback ) : void
$callback Closure
Résultat void

logQuery() public méthode

Log a query in the connection's query log.
public logQuery ( string $query, array $bindings, float | null $time = null ) : void
$query string
$bindings array
$time float | null
Résultat void

logging() public méthode

Determine whether we're logging queries.
public logging ( ) : boolean
Résultat boolean

prepareBindings() public méthode

Prepare the query bindings for execution.
public prepareBindings ( array $bindings ) : array
$bindings array
Résultat array

pretend() public méthode

Execute the given callback in "dry run" mode.
public pretend ( Closure $callback ) : array
$callback Closure
Résultat array

pretending() public méthode

Determine if the connection in a "dry run".
public pretending ( ) : boolean
Résultat boolean

query() public méthode

Get a new query builder instance.
public query ( ) : Builder
Résultat Illuminate\Database\Query\Builder

raw() public méthode

Get a new raw query expression.
public raw ( mixed $value ) : Illuminate\Database\Query\Expression
$value mixed
Résultat Illuminate\Database\Query\Expression

reconnect() public méthode

Reconnect to the database.
public reconnect ( ) : void
Résultat void

reconnectIfMissingConnection() protected méthode

Reconnect to the database if a PDO connection is missing.
protected reconnectIfMissingConnection ( ) : void
Résultat void

rollBack() public méthode

Rollback the active database transaction.
public rollBack ( integer | null $toLevel = null ) : void
$toLevel integer | null
Résultat void

run() protected méthode

Run a SQL statement and log its execution context.
protected run ( string $query, array $bindings, Closure $callback ) : mixed
$query string
$bindings array
$callback Closure
Résultat mixed

runQueryCallback() protected méthode

Run a SQL statement.
protected runQueryCallback ( string $query, array $bindings, Closure $callback ) : mixed
$query string
$bindings array
$callback Closure
Résultat mixed

select() public méthode

Run a select statement against the database.
public select ( string $query, array $bindings = [], boolean $useReadPdo = true ) : array
$query string
$bindings array
$useReadPdo boolean
Résultat array

selectFromWriteConnection() public méthode

Run a select statement against the database.
public selectFromWriteConnection ( string $query, array $bindings = [] ) : array
$query string
$bindings array
Résultat array

selectOne() public méthode

Run a select statement and return a single result.
public selectOne ( string $query, array $bindings = [] ) : mixed | null
$query string
$bindings array
Résultat mixed | null

setDatabaseName() public méthode

Set the name of the connected database.
public setDatabaseName ( string $database ) : string
$database string
Résultat string

setEventDispatcher() public méthode

Set the event dispatcher instance on the connection.
public setEventDispatcher ( Illuminate\Contracts\Events\Dispatcher $events ) : void
$events Illuminate\Contracts\Events\Dispatcher
Résultat void

setFetchMode() public méthode

Set the default fetch mode for the connection, and optional arguments for the given fetch mode.
public setFetchMode ( integer $fetchMode, mixed $fetchArgument = null, array $fetchConstructorArgument = [] ) : integer
$fetchMode integer
$fetchArgument mixed
$fetchConstructorArgument array
Résultat integer

setPdo() public méthode

Set the PDO connection.
public setPdo ( PDO | null $pdo )
$pdo PDO | null

setPostProcessor() public méthode

Set the query post processor used by the connection.
public setPostProcessor ( Illuminate\Database\Query\Processors\Processor $processor ) : void
$processor Illuminate\Database\Query\Processors\Processor
Résultat void

setQueryGrammar() public méthode

Set the query grammar used by the connection.
public setQueryGrammar ( Illuminate\Database\Query\Grammars\Grammar $grammar ) : void
$grammar Illuminate\Database\Query\Grammars\Grammar
Résultat void

setReadPdo() public méthode

Set the PDO connection used for reading.
public setReadPdo ( PDO | null $pdo )
$pdo PDO | null

setReconnector() public méthode

Set the reconnect instance on the connection.
public setReconnector ( callable $reconnector )
$reconnector callable

setSchemaGrammar() public méthode

Set the schema grammar used by the connection.
public setSchemaGrammar ( Illuminate\Database\Schema\Grammars\Grammar $grammar ) : void
$grammar Illuminate\Database\Schema\Grammars\Grammar
Résultat void

setTablePrefix() public méthode

Set the table prefix in use by the connection.
public setTablePrefix ( string $prefix ) : void
$prefix string
Résultat void

statement() public méthode

Execute an SQL statement and return the boolean result.
public statement ( string $query, array $bindings = [] ) : boolean
$query string
$bindings array
Résultat boolean

table() public méthode

Begin a fluent query against a database table.
public table ( string $table ) : Builder
$table string
Résultat Illuminate\Database\Query\Builder

transaction() public méthode

Execute a Closure within a transaction.
public transaction ( Closure $callback, integer $attempts = 1 ) : mixed
$callback Closure
$attempts integer
Résultat mixed

transactionLevel() public méthode

Get the number of active transactions.
public transactionLevel ( ) : integer
Résultat integer

tryAgainIfCausedByLostConnection() protected méthode

Handle a query exception that occurred during query execution.
protected tryAgainIfCausedByLostConnection ( Illuminate\Database\QueryException $e, string $query, array $bindings, Closure $callback ) : mixed
$e Illuminate\Database\QueryException
$query string
$bindings array
$callback Closure
Résultat mixed

unprepared() public méthode

Run a raw, unprepared query against the PDO connection.
public unprepared ( string $query ) : boolean
$query string
Résultat boolean

update() public méthode

Run an update statement against the database.
public update ( string $query, array $bindings = [] ) : integer
$query string
$bindings array
Résultat integer

useDefaultPostProcessor() public méthode

Set the query post processor to the default implementation.
public useDefaultPostProcessor ( ) : void
Résultat void

useDefaultQueryGrammar() public méthode

Set the query grammar to the default implementation.
public useDefaultQueryGrammar ( ) : void
Résultat void

useDefaultSchemaGrammar() public méthode

Set the schema grammar to the default implementation.
public useDefaultSchemaGrammar ( ) : void
Résultat void

withTablePrefix() public méthode

Set the table prefix and return the grammar.
public withTablePrefix ( Illuminate\Database\Grammar $grammar ) : Illuminate\Database\Grammar
$grammar Illuminate\Database\Grammar
Résultat Illuminate\Database\Grammar

Property Details

$config protected_oe property

The database connection configuration options.
protected array $config
Résultat array

$database protected_oe property

The name of the connected database.
protected string $database
Résultat string

$doctrineConnection protected_oe property

The instance of Doctrine connection.
protected Connection,Doctrine\DBAL $doctrineConnection
Résultat Doctrine\DBAL\Connection

$events protected_oe property

The event dispatcher instance.
protected Dispatcher,Illuminate\Contracts\Events $events
Résultat Illuminate\Contracts\Events\Dispatcher

$fetchArgument protected_oe property

The argument for the fetch mode.
protected mixed $fetchArgument
Résultat mixed

$fetchConstructorArgument protected_oe property

The constructor arguments for the PDO::FETCH_CLASS fetch mode.
protected array $fetchConstructorArgument
Résultat array

$fetchMode protected_oe property

The default fetch mode of the connection.
protected int $fetchMode
Résultat integer

$loggingQueries protected_oe property

Indicates whether queries are being logged.
protected bool $loggingQueries
Résultat boolean

$pdo protected_oe property

The active PDO connection.
protected PDO $pdo
Résultat PDO

$postProcessor protected_oe property

The query post processor implementation.
protected Processor,Illuminate\Database\Query\Processors $postProcessor
Résultat Illuminate\Database\Query\Processors\Processor

$pretending protected_oe property

Indicates if the connection is in a "dry run".
protected bool $pretending
Résultat boolean

$queryGrammar protected_oe property

The query grammar implementation.
protected Grammar,Illuminate\Database\Query\Grammars $queryGrammar
Résultat Illuminate\Database\Query\Grammars\Grammar

$queryLog protected_oe property

All of the queries run against the connection.
protected array $queryLog
Résultat array

$readPdo protected_oe property

The active PDO connection used for reads.
protected PDO $readPdo
Résultat PDO

$reconnector protected_oe property

The reconnector instance for the connection.
protected callable $reconnector
Résultat callable

$schemaGrammar protected_oe property

The schema grammar implementation.
protected Grammar,Illuminate\Database\Schema\Grammars $schemaGrammar
Résultat Illuminate\Database\Schema\Grammars\Grammar

$tablePrefix protected_oe property

The table prefix for the connection.
protected string $tablePrefix
Résultat string

$transactions protected_oe property

The number of active transactions.
protected int $transactions
Résultat integer