12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265 |
- <?php
- namespace Illuminate\Database;
- use PDO;
- use Closure;
- use Exception;
- use PDOStatement;
- use LogicException;
- use DateTimeInterface;
- use Illuminate\Support\Arr;
- use Illuminate\Database\Query\Expression;
- use Illuminate\Contracts\Events\Dispatcher;
- use Illuminate\Database\Events\QueryExecuted;
- use Doctrine\DBAL\Connection as DoctrineConnection;
- use Illuminate\Database\Query\Processors\Processor;
- use Illuminate\Database\Query\Builder as QueryBuilder;
- use Illuminate\Database\Schema\Builder as SchemaBuilder;
- use Illuminate\Database\Query\Grammars\Grammar as QueryGrammar;
- class Connection implements ConnectionInterface
- {
- use DetectsDeadlocks,
- DetectsLostConnections,
- Concerns\ManagesTransactions;
- /**
- * The active PDO connection.
- *
- * @var \PDO|\Closure
- */
- protected $pdo;
- /**
- * The active PDO connection used for reads.
- *
- * @var \PDO|\Closure
- */
- protected $readPdo;
- /**
- * The name of the connected database.
- *
- * @var string
- */
- protected $database;
- /**
- * The table prefix for the connection.
- *
- * @var string
- */
- protected $tablePrefix = '';
- /**
- * The database connection configuration options.
- *
- * @var array
- */
- protected $config = [];
- /**
- * The reconnector instance for the connection.
- *
- * @var callable
- */
- protected $reconnector;
- /**
- * The query grammar implementation.
- *
- * @var \Illuminate\Database\Query\Grammars\Grammar
- */
- protected $queryGrammar;
- /**
- * The schema grammar implementation.
- *
- * @var \Illuminate\Database\Schema\Grammars\Grammar
- */
- protected $schemaGrammar;
- /**
- * The query post processor implementation.
- *
- * @var \Illuminate\Database\Query\Processors\Processor
- */
- protected $postProcessor;
- /**
- * The event dispatcher instance.
- *
- * @var \Illuminate\Contracts\Events\Dispatcher
- */
- protected $events;
- /**
- * The default fetch mode of the connection.
- *
- * @var int
- */
- protected $fetchMode = PDO::FETCH_OBJ;
- /**
- * The number of active transactions.
- *
- * @var int
- */
- protected $transactions = 0;
- /**
- * Indicates if changes have been made to the database.
- *
- * @var int
- */
- protected $recordsModified = false;
- /**
- * All of the queries run against the connection.
- *
- * @var array
- */
- protected $queryLog = [];
- /**
- * Indicates whether queries are being logged.
- *
- * @var bool
- */
- protected $loggingQueries = false;
- /**
- * Indicates if the connection is in a "dry run".
- *
- * @var bool
- */
- protected $pretending = false;
- /**
- * The instance of Doctrine connection.
- *
- * @var \Doctrine\DBAL\Connection
- */
- protected $doctrineConnection;
- /**
- * The connection resolvers.
- *
- * @var array
- */
- protected static $resolvers = [];
- /**
- * Create a new database connection instance.
- *
- * @param \PDO|\Closure $pdo
- * @param string $database
- * @param string $tablePrefix
- * @param array $config
- * @return void
- */
- public function __construct($pdo, $database = '', $tablePrefix = '', array $config = [])
- {
- $this->pdo = $pdo;
- // First we will setup the default properties. We keep track of the DB
- // name we are connected to since it is needed when some reflective
- // type commands are run such as checking whether a table exists.
- $this->database = $database;
- $this->tablePrefix = $tablePrefix;
- $this->config = $config;
- // We need to initialize a query grammar and the query post processors
- // which are both very important parts of the database abstractions
- // so we initialize these to their default values while starting.
- $this->useDefaultQueryGrammar();
- $this->useDefaultPostProcessor();
- }
- /**
- * Set the query grammar to the default implementation.
- *
- * @return void
- */
- public function useDefaultQueryGrammar()
- {
- $this->queryGrammar = $this->getDefaultQueryGrammar();
- }
- /**
- * Get the default query grammar instance.
- *
- * @return \Illuminate\Database\Query\Grammars\Grammar
- */
- protected function getDefaultQueryGrammar()
- {
- return new QueryGrammar;
- }
- /**
- * Set the schema grammar to the default implementation.
- *
- * @return void
- */
- public function useDefaultSchemaGrammar()
- {
- $this->schemaGrammar = $this->getDefaultSchemaGrammar();
- }
- /**
- * Get the default schema grammar instance.
- *
- * @return \Illuminate\Database\Schema\Grammars\Grammar
- */
- protected function getDefaultSchemaGrammar()
- {
- //
- }
- /**
- * Set the query post processor to the default implementation.
- *
- * @return void
- */
- public function useDefaultPostProcessor()
- {
- $this->postProcessor = $this->getDefaultPostProcessor();
- }
- /**
- * Get the default post processor instance.
- *
- * @return \Illuminate\Database\Query\Processors\Processor
- */
- protected function getDefaultPostProcessor()
- {
- return new Processor;
- }
- /**
- * Get a schema builder instance for the connection.
- *
- * @return \Illuminate\Database\Schema\Builder
- */
- public function getSchemaBuilder()
- {
- if (is_null($this->schemaGrammar)) {
- $this->useDefaultSchemaGrammar();
- }
- return new SchemaBuilder($this);
- }
- /**
- * Begin a fluent query against a database table.
- *
- * @param string $table
- * @return \Illuminate\Database\Query\Builder
- */
- public function table($table)
- {
- return $this->query()->from($table);
- }
- /**
- * Get a new query builder instance.
- *
- * @return \Illuminate\Database\Query\Builder
- */
- public function query()
- {
- return new QueryBuilder(
- $this, $this->getQueryGrammar(), $this->getPostProcessor()
- );
- }
- /**
- * Run a select statement and return a single result.
- *
- * @param string $query
- * @param array $bindings
- * @param bool $useReadPdo
- * @return mixed
- */
- public function selectOne($query, $bindings = [], $useReadPdo = true)
- {
- $records = $this->select($query, $bindings, $useReadPdo);
- return array_shift($records);
- }
- /**
- * Run a select statement against the database.
- *
- * @param string $query
- * @param array $bindings
- * @return array
- */
- public function selectFromWriteConnection($query, $bindings = [])
- {
- return $this->select($query, $bindings, false);
- }
- /**
- * Run a select statement against the database.
- *
- * @param string $query
- * @param array $bindings
- * @param bool $useReadPdo
- * @return array
- */
- public function select($query, $bindings = [], $useReadPdo = true)
- {
- return $this->run($query, $bindings, function ($query, $bindings) use ($useReadPdo) {
- if ($this->pretending()) {
- return [];
- }
- // For select statements, we'll simply execute the query and return an array
- // of the database result set. Each element in the array will be a single
- // row from the database table, and will either be an array or objects.
- $statement = $this->prepared($this->getPdoForSelect($useReadPdo)
- ->prepare($query));
- $this->bindValues($statement, $this->prepareBindings($bindings));
- $statement->execute();
- return $statement->fetchAll();
- });
- }
- /**
- * Run a select statement against the database and returns a generator.
- *
- * @param string $query
- * @param array $bindings
- * @param bool $useReadPdo
- * @return \Generator
- */
- public function cursor($query, $bindings = [], $useReadPdo = true)
- {
- $statement = $this->run($query, $bindings, function ($query, $bindings) use ($useReadPdo) {
- if ($this->pretending()) {
- return [];
- }
- // First we will create a statement for the query. Then, we will set the fetch
- // mode and prepare the bindings for the query. Once that's done we will be
- // ready to execute the query against the database and return the cursor.
- $statement = $this->prepared($this->getPdoForSelect($useReadPdo)
- ->prepare($query));
- $this->bindValues(
- $statement, $this->prepareBindings($bindings)
- );
- // Next, we'll execute the query against the database and return the statement
- // so we can return the cursor. The cursor will use a PHP generator to give
- // back one row at a time without using a bunch of memory to render them.
- $statement->execute();
- return $statement;
- });
- while ($record = $statement->fetch()) {
- yield $record;
- }
- }
- /**
- * Configure the PDO prepared statement.
- *
- * @param \PDOStatement $statement
- * @return \PDOStatement
- */
- protected function prepared(PDOStatement $statement)
- {
- $statement->setFetchMode($this->fetchMode);
- $this->event(new Events\StatementPrepared(
- $this, $statement
- ));
- return $statement;
- }
- /**
- * Get the PDO connection to use for a select query.
- *
- * @param bool $useReadPdo
- * @return \PDO
- */
- protected function getPdoForSelect($useReadPdo = true)
- {
- return $useReadPdo ? $this->getReadPdo() : $this->getPdo();
- }
- /**
- * Run an insert statement against the database.
- *
- * @param string $query
- * @param array $bindings
- * @return bool
- */
- public function insert($query, $bindings = [])
- {
- return $this->statement($query, $bindings);
- }
- /**
- * Run an update statement against the database.
- *
- * @param string $query
- * @param array $bindings
- * @return int
- */
- public function update($query, $bindings = [])
- {
- return $this->affectingStatement($query, $bindings);
- }
- /**
- * Run a delete statement against the database.
- *
- * @param string $query
- * @param array $bindings
- * @return int
- */
- public function delete($query, $bindings = [])
- {
- return $this->affectingStatement($query, $bindings);
- }
- /**
- * Execute an SQL statement and return the boolean result.
- *
- * @param string $query
- * @param array $bindings
- * @return bool
- */
- public function statement($query, $bindings = [])
- {
- return $this->run($query, $bindings, function ($query, $bindings) {
- if ($this->pretending()) {
- return true;
- }
- $statement = $this->getPdo()->prepare($query);
- $this->bindValues($statement, $this->prepareBindings($bindings));
- $this->recordsHaveBeenModified();
- return $statement->execute();
- });
- }
- /**
- * Run an SQL statement and get the number of rows affected.
- *
- * @param string $query
- * @param array $bindings
- * @return int
- */
- public function affectingStatement($query, $bindings = [])
- {
- return $this->run($query, $bindings, function ($query, $bindings) {
- if ($this->pretending()) {
- return 0;
- }
- // For update or delete statements, we want to get the number of rows affected
- // by the statement and return that back to the developer. We'll first need
- // to execute the statement and then we'll use PDO to fetch the affected.
- $statement = $this->getPdo()->prepare($query);
- $this->bindValues($statement, $this->prepareBindings($bindings));
- $statement->execute();
- $this->recordsHaveBeenModified(
- ($count = $statement->rowCount()) > 0
- );
- return $count;
- });
- }
- /**
- * Run a raw, unprepared query against the PDO connection.
- *
- * @param string $query
- * @return bool
- */
- public function unprepared($query)
- {
- return $this->run($query, [], function ($query) {
- if ($this->pretending()) {
- return true;
- }
- $this->recordsHaveBeenModified(
- $change = $this->getPdo()->exec($query) !== false
- );
- return $change;
- });
- }
- /**
- * Execute the given callback in "dry run" mode.
- *
- * @param \Closure $callback
- * @return array
- */
- public function pretend(Closure $callback)
- {
- return $this->withFreshQueryLog(function () use ($callback) {
- $this->pretending = true;
- // Basically to make the database connection "pretend", we will just return
- // the default values for all the query methods, then we will return an
- // array of queries that were "executed" within the Closure callback.
- $callback($this);
- $this->pretending = false;
- return $this->queryLog;
- });
- }
- /**
- * Execute the given callback in "dry run" mode.
- *
- * @param \Closure $callback
- * @return array
- */
- protected function withFreshQueryLog($callback)
- {
- $loggingQueries = $this->loggingQueries;
- // First we will back up the value of the logging queries property and then
- // we'll be ready to run callbacks. This query log will also get cleared
- // so we will have a new log of all the queries that are executed now.
- $this->enableQueryLog();
- $this->queryLog = [];
- // Now we'll execute this callback and capture the result. Once it has been
- // executed we will restore the value of query logging and give back the
- // value of the callback so the original callers can have the results.
- $result = $callback();
- $this->loggingQueries = $loggingQueries;
- return $result;
- }
- /**
- * Bind values to their parameters in the given statement.
- *
- * @param \PDOStatement $statement
- * @param array $bindings
- * @return void
- */
- public function bindValues($statement, $bindings)
- {
- foreach ($bindings as $key => $value) {
- $statement->bindValue(
- is_string($key) ? $key : $key + 1, $value,
- is_int($value) ? PDO::PARAM_INT : PDO::PARAM_STR
- );
- }
- }
- /**
- * Prepare the query bindings for execution.
- *
- * @param array $bindings
- * @return array
- */
- public function prepareBindings(array $bindings)
- {
- $grammar = $this->getQueryGrammar();
- foreach ($bindings as $key => $value) {
- // We need to transform all instances of DateTimeInterface into the actual
- // date string. Each query grammar maintains its own date string format
- // so we'll just ask the grammar for the format to get from the date.
- if ($value instanceof DateTimeInterface) {
- $bindings[$key] = $value->format($grammar->getDateFormat());
- } elseif (is_bool($value)) {
- $bindings[$key] = (int) $value;
- }
- }
- return $bindings;
- }
- /**
- * Run a SQL statement and log its execution context.
- *
- * @param string $query
- * @param array $bindings
- * @param \Closure $callback
- * @return mixed
- *
- * @throws \Illuminate\Database\QueryException
- */
- protected function run($query, $bindings, Closure $callback)
- {
- $this->reconnectIfMissingConnection();
- $start = microtime(true);
- // Here we will run this query. If an exception occurs we'll determine if it was
- // caused by a connection that has been lost. If that is the cause, we'll try
- // to re-establish connection and re-run the query with a fresh connection.
- try {
- $result = $this->runQueryCallback($query, $bindings, $callback);
- } catch (QueryException $e) {
- $result = $this->handleQueryException(
- $e, $query, $bindings, $callback
- );
- }
- // Once we have run the query we will calculate the time that it took to run and
- // then log the query, bindings, and execution time so we will report them on
- // the event that the developer needs them. We'll log time in milliseconds.
- $this->logQuery(
- $query, $bindings, $this->getElapsedTime($start)
- );
- return $result;
- }
- /**
- * Run a SQL statement.
- *
- * @param string $query
- * @param array $bindings
- * @param \Closure $callback
- * @return mixed
- *
- * @throws \Illuminate\Database\QueryException
- */
- protected function runQueryCallback($query, $bindings, Closure $callback)
- {
- // To execute the statement, we'll simply call the callback, which will actually
- // run the SQL against the PDO connection. Then we can calculate the time it
- // took to execute and log the query SQL, bindings and time in our memory.
- try {
- $result = $callback($query, $bindings);
- }
- // If an exception occurs when attempting to run a query, we'll format the error
- // message to include the bindings with SQL, which will make this exception a
- // lot more helpful to the developer instead of just the database's errors.
- catch (Exception $e) {
- throw new QueryException(
- $query, $this->prepareBindings($bindings), $e
- );
- }
- return $result;
- }
- /**
- * Log a query in the connection's query log.
- *
- * @param string $query
- * @param array $bindings
- * @param float|null $time
- * @return void
- */
- public function logQuery($query, $bindings, $time = null)
- {
- $this->event(new QueryExecuted($query, $bindings, $time, $this));
- if ($this->loggingQueries) {
- $this->queryLog[] = compact('query', 'bindings', 'time');
- }
- }
- /**
- * Get the elapsed time since a given starting point.
- *
- * @param int $start
- * @return float
- */
- protected function getElapsedTime($start)
- {
- return round((microtime(true) - $start) * 1000, 2);
- }
- /**
- * Handle a query exception.
- *
- * @param \Illuminate\Database\QueryException $e
- * @param string $query
- * @param array $bindings
- * @param \Closure $callback
- * @return mixed
- *
- * @throws \Illuminate\Database\QueryException
- */
- protected function handleQueryException(QueryException $e, $query, $bindings, Closure $callback)
- {
- if ($this->transactions >= 1) {
- throw $e;
- }
- return $this->tryAgainIfCausedByLostConnection(
- $e, $query, $bindings, $callback
- );
- }
- /**
- * Handle a query exception that occurred during query execution.
- *
- * @param \Illuminate\Database\QueryException $e
- * @param string $query
- * @param array $bindings
- * @param \Closure $callback
- * @return mixed
- *
- * @throws \Illuminate\Database\QueryException
- */
- protected function tryAgainIfCausedByLostConnection(QueryException $e, $query, $bindings, Closure $callback)
- {
- if ($this->causedByLostConnection($e->getPrevious())) {
- $this->reconnect();
- return $this->runQueryCallback($query, $bindings, $callback);
- }
- throw $e;
- }
- /**
- * Reconnect to the database.
- *
- * @return void
- *
- * @throws \LogicException
- */
- public function reconnect()
- {
- if (is_callable($this->reconnector)) {
- $this->doctrineConnection = null;
- return call_user_func($this->reconnector, $this);
- }
- throw new LogicException('Lost connection and no reconnector available.');
- }
- /**
- * Reconnect to the database if a PDO connection is missing.
- *
- * @return void
- */
- protected function reconnectIfMissingConnection()
- {
- if (is_null($this->pdo)) {
- $this->reconnect();
- }
- }
- /**
- * Disconnect from the underlying PDO connection.
- *
- * @return void
- */
- public function disconnect()
- {
- $this->setPdo(null)->setReadPdo(null);
- }
- /**
- * Register a database query listener with the connection.
- *
- * @param \Closure $callback
- * @return void
- */
- public function listen(Closure $callback)
- {
- if (isset($this->events)) {
- $this->events->listen(Events\QueryExecuted::class, $callback);
- }
- }
- /**
- * Fire an event for this connection.
- *
- * @param string $event
- * @return array|null
- */
- protected function fireConnectionEvent($event)
- {
- if (! isset($this->events)) {
- return;
- }
- switch ($event) {
- case 'beganTransaction':
- return $this->events->dispatch(new Events\TransactionBeginning($this));
- case 'committed':
- return $this->events->dispatch(new Events\TransactionCommitted($this));
- case 'rollingBack':
- return $this->events->dispatch(new Events\TransactionRolledBack($this));
- }
- }
- /**
- * Fire the given event if possible.
- *
- * @param mixed $event
- * @return void
- */
- protected function event($event)
- {
- if (isset($this->events)) {
- $this->events->dispatch($event);
- }
- }
- /**
- * Get a new raw query expression.
- *
- * @param mixed $value
- * @return \Illuminate\Database\Query\Expression
- */
- public function raw($value)
- {
- return new Expression($value);
- }
- /**
- * Indicate if any records have been modified.
- *
- * @param bool $value
- * @return void
- */
- public function recordsHaveBeenModified($value = true)
- {
- if (! $this->recordsModified) {
- $this->recordsModified = $value;
- }
- }
- /**
- * Is Doctrine available?
- *
- * @return bool
- */
- public function isDoctrineAvailable()
- {
- return class_exists('Doctrine\DBAL\Connection');
- }
- /**
- * Get a Doctrine Schema Column instance.
- *
- * @param string $table
- * @param string $column
- * @return \Doctrine\DBAL\Schema\Column
- */
- public function getDoctrineColumn($table, $column)
- {
- $schema = $this->getDoctrineSchemaManager();
- return $schema->listTableDetails($table)->getColumn($column);
- }
- /**
- * Get the Doctrine DBAL schema manager for the connection.
- *
- * @return \Doctrine\DBAL\Schema\AbstractSchemaManager
- */
- public function getDoctrineSchemaManager()
- {
- return $this->getDoctrineDriver()->getSchemaManager($this->getDoctrineConnection());
- }
- /**
- * Get the Doctrine DBAL database connection instance.
- *
- * @return \Doctrine\DBAL\Connection
- */
- public function getDoctrineConnection()
- {
- if (is_null($this->doctrineConnection)) {
- $driver = $this->getDoctrineDriver();
- $this->doctrineConnection = new DoctrineConnection(array_filter([
- 'pdo' => $this->getPdo(),
- 'dbname' => $this->getConfig('database'),
- 'driver' => $driver->getName(),
- 'serverVersion' => $this->getConfig('server_version'),
- ]), $driver);
- }
- return $this->doctrineConnection;
- }
- /**
- * Get the current PDO connection.
- *
- * @return \PDO
- */
- public function getPdo()
- {
- if ($this->pdo instanceof Closure) {
- return $this->pdo = call_user_func($this->pdo);
- }
- return $this->pdo;
- }
- /**
- * Get the current PDO connection used for reading.
- *
- * @return \PDO
- */
- public function getReadPdo()
- {
- if ($this->transactions > 0) {
- return $this->getPdo();
- }
- if ($this->recordsModified && $this->getConfig('sticky')) {
- return $this->getPdo();
- }
- if ($this->readPdo instanceof Closure) {
- return $this->readPdo = call_user_func($this->readPdo);
- }
- return $this->readPdo ?: $this->getPdo();
- }
- /**
- * Set the PDO connection.
- *
- * @param \PDO|\Closure|null $pdo
- * @return $this
- */
- public function setPdo($pdo)
- {
- $this->transactions = 0;
- $this->pdo = $pdo;
- return $this;
- }
- /**
- * Set the PDO connection used for reading.
- *
- * @param \PDO|\Closure|null $pdo
- * @return $this
- */
- public function setReadPdo($pdo)
- {
- $this->readPdo = $pdo;
- return $this;
- }
- /**
- * Set the reconnect instance on the connection.
- *
- * @param callable $reconnector
- * @return $this
- */
- public function setReconnector(callable $reconnector)
- {
- $this->reconnector = $reconnector;
- return $this;
- }
- /**
- * Get the database connection name.
- *
- * @return string|null
- */
- public function getName()
- {
- return $this->getConfig('name');
- }
- /**
- * Get an option from the configuration options.
- *
- * @param string|null $option
- * @return mixed
- */
- public function getConfig($option = null)
- {
- return Arr::get($this->config, $option);
- }
- /**
- * Get the PDO driver name.
- *
- * @return string
- */
- public function getDriverName()
- {
- return $this->getConfig('driver');
- }
- /**
- * Get the query grammar used by the connection.
- *
- * @return \Illuminate\Database\Query\Grammars\Grammar
- */
- public function getQueryGrammar()
- {
- return $this->queryGrammar;
- }
- /**
- * Set the query grammar used by the connection.
- *
- * @param \Illuminate\Database\Query\Grammars\Grammar $grammar
- * @return $this
- */
- public function setQueryGrammar(Query\Grammars\Grammar $grammar)
- {
- $this->queryGrammar = $grammar;
- return $this;
- }
- /**
- * Get the schema grammar used by the connection.
- *
- * @return \Illuminate\Database\Schema\Grammars\Grammar
- */
- public function getSchemaGrammar()
- {
- return $this->schemaGrammar;
- }
- /**
- * Set the schema grammar used by the connection.
- *
- * @param \Illuminate\Database\Schema\Grammars\Grammar $grammar
- * @return $this
- */
- public function setSchemaGrammar(Schema\Grammars\Grammar $grammar)
- {
- $this->schemaGrammar = $grammar;
- return $this;
- }
- /**
- * Get the query post processor used by the connection.
- *
- * @return \Illuminate\Database\Query\Processors\Processor
- */
- public function getPostProcessor()
- {
- return $this->postProcessor;
- }
- /**
- * Set the query post processor used by the connection.
- *
- * @param \Illuminate\Database\Query\Processors\Processor $processor
- * @return $this
- */
- public function setPostProcessor(Processor $processor)
- {
- $this->postProcessor = $processor;
- return $this;
- }
- /**
- * Get the event dispatcher used by the connection.
- *
- * @return \Illuminate\Contracts\Events\Dispatcher
- */
- public function getEventDispatcher()
- {
- return $this->events;
- }
- /**
- * Set the event dispatcher instance on the connection.
- *
- * @param \Illuminate\Contracts\Events\Dispatcher $events
- * @return $this
- */
- public function setEventDispatcher(Dispatcher $events)
- {
- $this->events = $events;
- return $this;
- }
- /**
- * Unset the event dispatcher for this connection.
- *
- * @return void
- */
- public function unsetEventDispatcher()
- {
- $this->events = null;
- }
- /**
- * Determine if the connection is in a "dry run".
- *
- * @return bool
- */
- public function pretending()
- {
- return $this->pretending === true;
- }
- /**
- * Get the connection query log.
- *
- * @return array
- */
- public function getQueryLog()
- {
- return $this->queryLog;
- }
- /**
- * Clear the query log.
- *
- * @return void
- */
- public function flushQueryLog()
- {
- $this->queryLog = [];
- }
- /**
- * Enable the query log on the connection.
- *
- * @return void
- */
- public function enableQueryLog()
- {
- $this->loggingQueries = true;
- }
- /**
- * Disable the query log on the connection.
- *
- * @return void
- */
- public function disableQueryLog()
- {
- $this->loggingQueries = false;
- }
- /**
- * Determine whether we're logging queries.
- *
- * @return bool
- */
- public function logging()
- {
- return $this->loggingQueries;
- }
- /**
- * Get the name of the connected database.
- *
- * @return string
- */
- public function getDatabaseName()
- {
- return $this->database;
- }
- /**
- * Set the name of the connected database.
- *
- * @param string $database
- * @return $this
- */
- public function setDatabaseName($database)
- {
- $this->database = $database;
- return $this;
- }
- /**
- * Get the table prefix for the connection.
- *
- * @return string
- */
- public function getTablePrefix()
- {
- return $this->tablePrefix;
- }
- /**
- * Set the table prefix in use by the connection.
- *
- * @param string $prefix
- * @return $this
- */
- public function setTablePrefix($prefix)
- {
- $this->tablePrefix = $prefix;
- $this->getQueryGrammar()->setTablePrefix($prefix);
- return $this;
- }
- /**
- * Set the table prefix and return the grammar.
- *
- * @param \Illuminate\Database\Grammar $grammar
- * @return \Illuminate\Database\Grammar
- */
- public function withTablePrefix(Grammar $grammar)
- {
- $grammar->setTablePrefix($this->tablePrefix);
- return $grammar;
- }
- /**
- * Register a connection resolver.
- *
- * @param string $driver
- * @param \Closure $callback
- * @return void
- */
- public static function resolverFor($driver, Closure $callback)
- {
- static::$resolvers[$driver] = $callback;
- }
- /**
- * Get the connection resolver for the given driver.
- *
- * @param string $driver
- * @return mixed
- */
- public static function getResolver($driver)
- {
- return static::$resolvers[$driver] ?? null;
- }
- }
|