1. Documentation
  2. API
  3. Library
  4. Database
  5. Connections
  6. Connection

October\Rain\Database\Connections\Connection

Source: ~/vendor/october/rain/src/Database/Connections/Connection.php

Extends:

  • Illuminate\Database\Connection

Implements:

  • Illuminate\Database\ConnectionInterface

Protected properties

There are no protected properties in the class.

Show inherited protected properties

Inherited protected properties

  • protected PDO|\Closure $pdo - defined in Illuminate\Database\Connection. The active PDO connection.
  • protected PDO|\Closure $readPdo - defined in Illuminate\Database\Connection. The active PDO connection used for reads.
  • protected string $database - defined in Illuminate\Database\Connection. The name of the connected database.
  • protected string $tablePrefix - defined in Illuminate\Database\Connection. The table prefix for the connection.
  • protected array $config - defined in Illuminate\Database\Connection. The database connection configuration options.
  • protected callable $reconnector - defined in Illuminate\Database\Connection. The reconnector instance for the connection.
  • protected Illuminate\Database\Query\Grammars\Grammar $queryGrammar - defined in Illuminate\Database\Connection. The query grammar implementation.
  • protected Illuminate\Database\Schema\Grammars\Grammar $schemaGrammar - defined in Illuminate\Database\Connection. The schema grammar implementation.
  • protected Illuminate\Database\Query\Processors\Processor $postProcessor - defined in Illuminate\Database\Connection. The query post processor implementation.
  • protected Illuminate\Contracts\Events\Dispatcher $events - defined in Illuminate\Database\Connection. The event dispatcher instance.
  • protected int $fetchMode - defined in Illuminate\Database\Connection. The default fetch mode of the connection.
  • protected int $transactions - defined in Illuminate\Database\Connection. The number of active transactions.
  • protected int $recordsModified - defined in Illuminate\Database\Connection. Indicates if changes have been made to the database.
  • protected array $queryLog - defined in Illuminate\Database\Connection. All of the queries run against the connection.
  • protected bool $loggingQueries - defined in Illuminate\Database\Connection. Indicates whether queries are being logged.
  • protected bool $pretending - defined in Illuminate\Database\Connection. Indicates if the connection is in a "dry run".
  • protected Doctrine\DBAL\Connection $doctrineConnection - defined in Illuminate\Database\Connection. The instance of Doctrine connection.
  • protected static array $resolvers - defined in Illuminate\Database\Connection. The connection resolvers.

Public methods

public static void flushDuplicateCache()

Flush the memory cache.

public 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

public October\Rain\Database\QueryBuilder query()

Get a new query builder instance.

Show inherited public methods

Inherited public methods

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

Protected methods

protected void fireConnectionEvent(string $event)

Fire an event for this connection.

Parameters
  • string $event

Show inherited protected methods

Inherited protected methods

  • protected bool causedByDeadlock(Exception $e) - defined in Illuminate\Database\Connection. Determine if the given exception was caused by a deadlock.
  • protected bool causedByLostConnection(Exception $e) - defined in Illuminate\Database\Connection. Determine if the given exception was caused by a lost connection.
  • protected void createSavepoint() - defined in Illuminate\Database\Connection. Create a save point within the database.
  • protected void createTransaction() - defined in Illuminate\Database\Connection. Create a transaction within the database.
  • protected void event(mixed $event) - defined in Illuminate\Database\Connection. Fire the given event if possible.
  • protected Illuminate\Database\Query\Processors\Processor getDefaultPostProcessor() - defined in Illuminate\Database\Connection. Get the default post processor instance.
  • protected Illuminate\Database\Query\Grammars\Grammar getDefaultQueryGrammar() - defined in Illuminate\Database\Connection. Get the default query grammar instance.
  • protected Illuminate\Database\Schema\Grammars\Grammar getDefaultSchemaGrammar() - defined in Illuminate\Database\Connection. Get the default schema grammar instance.
  • protected float getElapsedTime(int $start) - defined in Illuminate\Database\Connection. Get the elapsed time since a given starting point.
  • protected PDO getPdoForSelect(bool $useReadPdo=true) - defined in Illuminate\Database\Connection. Get the PDO connection to use for a select query.
  • protected void handleBeginTransactionException(Exception $e) - defined in Illuminate\Database\Connection. Handle an exception from a transaction beginning.
  • protected mixed handleQueryException(Exception $e, string $query, array $bindings, Closure $callback) - defined in Illuminate\Database\Connection. Handle a query exception.
  • protected void handleTransactionException(Exception $e, int $currentAttempt, int $maxAttempts) - defined in Illuminate\Database\Connection. Handle an exception encountered when running a transacted statement.
  • protected void performRollBack(int $toLevel) - defined in Illuminate\Database\Connection. Perform a rollback within the database.
  • protected PDOStatement prepared(PDOStatement $statement) - defined in Illuminate\Database\Connection. Configure the PDO prepared statement.
  • protected void reconnectIfMissingConnection() - defined in Illuminate\Database\Connection. Reconnect to the database if a PDO connection is missing.
  • protected mixed run(string $query, array $bindings, Closure $callback) - defined in Illuminate\Database\Connection. Run a SQL statement and log its execution context.
  • protected mixed runQueryCallback(string $query, array $bindings, Closure $callback) - defined in Illuminate\Database\Connection. Run a SQL statement.
  • protected mixed tryAgainIfCausedByLostConnection(Illuminate\Database\QueryException $e, string $query, array $bindings, Closure $callback) - defined in Illuminate\Database\Connection. Handle a query exception that occurred during query execution.
  • protected array withFreshQueryLog(Closure $callback) - defined in Illuminate\Database\Connection. Execute the given callback in "dry run" mode.