class Connection in Zircon Profile 8.0

SQLite implementation of \Drupal\Core\Database\Connection.

Hierarchy

• class \Drupal\Core\Database\Connection
  • class \Drupal\Core\Database\Driver\sqlite\Connection

3 files declare their use of Connection

MigrateSqlIdMapTest.php in core/modules/migrate/tests/src/Unit/MigrateSqlIdMapTest.php

Contains \Drupal\Tests\migrate\Unit\MigrateSqlIdMapTest.

MigrateTestCase.php in core/modules/migrate/tests/src/Unit/MigrateTestCase.php

Contains \Drupal\Tests\migrate\Unit\MigrateTestCase.

Tasks.php in core/lib/Drupal/Core/Database/Driver/sqlite/Install/Tasks.php

Contains \Drupal\Core\Database\Driver\sqlite\Install\Tasks.

1 string reference to 'Connection'

StreamHandler::createStream in vendor/guzzlehttp/guzzle/src/Handler/StreamHandler.php

File

core/lib/Drupal/Core/Database/Driver/sqlite/Connection.php, line 17

Contains \Drupal\Core\Database\Driver\sqlite\Connection.

Namespace

Drupal\Core\Database\Driver\sqlite

class Connection extends DatabaseConnection {

  /**
   * Error code for "Unable to open database file" error.
   */
  const DATABASE_NOT_FOUND = 14;

  /**
   * Whether or not the active transaction (if any) will be rolled back.
   *
   * @var bool
   */
  protected $willRollback;

  /**
   * All databases attached to the current database. This is used to allow
   * prefixes to be safely handled without locking the table
   *
   * @var array
   */
  protected $attachedDatabases = array();

  /**
   * Whether or not a table has been dropped this request: the destructor will
   * only try to get rid of unnecessary databases if there is potential of them
   * being empty.
   *
   * This variable is set to public because Schema needs to
   * access it. However, it should not be manually set.
   *
   * @var bool
   */
  var $tableDropped = FALSE;

  /**
   * Constructs a \Drupal\Core\Database\Driver\sqlite\Connection object.
   */
  public function __construct(\PDO $connection, array $connection_options) {

    // We don't need a specific PDOStatement class here, we simulate it in
    // static::prepare().
    $this->statementClass = NULL;
    parent::__construct($connection, $connection_options);

    // This driver defaults to transaction support, except if explicitly passed FALSE.
    $this->transactionSupport = $this->transactionalDDLSupport = !isset($connection_options['transactions']) || $connection_options['transactions'] !== FALSE;
    $this->connectionOptions = $connection_options;

    // Attach one database for each registered prefix.
    $prefixes = $this->prefixes;
    foreach ($prefixes as &$prefix) {

      // Empty prefix means query the main database -- no need to attach anything.
      if (!empty($prefix)) {

        // Only attach the database once.
        if (!isset($this->attachedDatabases[$prefix])) {
          $this->attachedDatabases[$prefix] = $prefix;
          if ($connection_options['database'] === ':memory:') {

            // In memory database use ':memory:' as database name. According to
            // http://www.sqlite.org/inmemorydb.html it will open a unique
            // database so attaching it twice is not a problem.
            $this
              ->query('ATTACH DATABASE :database AS :prefix', array(
              ':database' => $connection_options['database'],
              ':prefix' => $prefix,
            ));
          }
          else {
            $this
              ->query('ATTACH DATABASE :database AS :prefix', array(
              ':database' => $connection_options['database'] . '-' . $prefix,
              ':prefix' => $prefix,
            ));
          }
        }

        // Add a ., so queries become prefix.table, which is proper syntax for
        // querying an attached database.
        $prefix .= '.';
      }
    }

    // Regenerate the prefixes replacement table.
    $this
      ->setPrefix($prefixes);
  }

  /**
   * {@inheritdoc}
   */
  public static function open(array &$connection_options = array()) {

    // Allow PDO options to be overridden.
    $connection_options += array(
      'pdo' => array(),
    );
    $connection_options['pdo'] += array(
      \PDO::ATTR_ERRMODE => \PDO::ERRMODE_EXCEPTION,
      // Convert numeric values to strings when fetching.
      \PDO::ATTR_STRINGIFY_FETCHES => TRUE,
    );
    $pdo = new \PDO('sqlite:' . $connection_options['database'], '', '', $connection_options['pdo']);

    // Create functions needed by SQLite.
    $pdo
      ->sqliteCreateFunction('if', array(
      __CLASS__,
      'sqlFunctionIf',
    ));
    $pdo
      ->sqliteCreateFunction('greatest', array(
      __CLASS__,
      'sqlFunctionGreatest',
    ));
    $pdo
      ->sqliteCreateFunction('pow', 'pow', 2);
    $pdo
      ->sqliteCreateFunction('exp', 'exp', 1);
    $pdo
      ->sqliteCreateFunction('length', 'strlen', 1);
    $pdo
      ->sqliteCreateFunction('md5', 'md5', 1);
    $pdo
      ->sqliteCreateFunction('concat', array(
      __CLASS__,
      'sqlFunctionConcat',
    ));
    $pdo
      ->sqliteCreateFunction('concat_ws', array(
      __CLASS__,
      'sqlFunctionConcatWs',
    ));
    $pdo
      ->sqliteCreateFunction('substring', array(
      __CLASS__,
      'sqlFunctionSubstring',
    ), 3);
    $pdo
      ->sqliteCreateFunction('substring_index', array(
      __CLASS__,
      'sqlFunctionSubstringIndex',
    ), 3);
    $pdo
      ->sqliteCreateFunction('rand', array(
      __CLASS__,
      'sqlFunctionRand',
    ));
    $pdo
      ->sqliteCreateFunction('regexp', array(
      __CLASS__,
      'sqlFunctionRegexp',
    ));

    // SQLite does not support the LIKE BINARY operator, so we overload the
    // non-standard GLOB operator for case-sensitive matching. Another option
    // would have been to override another non-standard operator, MATCH, but
    // that does not support the NOT keyword prefix.
    $pdo
      ->sqliteCreateFunction('glob', array(
      __CLASS__,
      'sqlFunctionLikeBinary',
    ));

    // Create a user-space case-insensitive collation with UTF-8 support.
    $pdo
      ->sqliteCreateCollation('NOCASE_UTF8', array(
      'Drupal\\Component\\Utility\\Unicode',
      'strcasecmp',
    ));

    // Execute sqlite init_commands.
    if (isset($connection_options['init_commands'])) {
      $pdo
        ->exec(implode('; ', $connection_options['init_commands']));
    }
    return $pdo;
  }

  /**
   * Destructor for the SQLite connection.
   *
   * We prune empty databases on destruct, but only if tables have been
   * dropped. This is especially needed when running the test suite, which
   * creates and destroy databases several times in a row.
   */
  public function __destruct() {
    if ($this->tableDropped && !empty($this->attachedDatabases)) {
      foreach ($this->attachedDatabases as $prefix) {

        // Check if the database is now empty, ignore the internal SQLite tables.
        try {
          $count = $this
            ->query('SELECT COUNT(*) FROM ' . $prefix . '.sqlite_master WHERE type = :type AND name NOT LIKE :pattern', array(
            ':type' => 'table',
            ':pattern' => 'sqlite_%',
          ))
            ->fetchField();

          // We can prune the database file if it doesn't have any tables.
          if ($count == 0) {

            // Detaching the database fails at this point, but no other queries
            // are executed after the connection is destructed so we can simply
            // remove the database file.
            unlink($this->connectionOptions['database'] . '-' . $prefix);
          }
        } catch (\Exception $e) {

          // Ignore the exception and continue. There is nothing we can do here
          // to report the error or fail safe.
        }
      }
    }
  }

  /**
   * Gets all the attached databases.
   *
   * @return array
   *   An array of attached database names.
   *
   * @see \Drupal\Core\Database\Driver\sqlite\Connection::__construct()
   */
  public function getAttachedDatabases() {
    return $this->attachedDatabases;
  }

  /**
   * SQLite compatibility implementation for the IF() SQL function.
   */
  public static function sqlFunctionIf($condition, $expr1, $expr2 = NULL) {
    return $condition ? $expr1 : $expr2;
  }

  /**
   * SQLite compatibility implementation for the GREATEST() SQL function.
   */
  public static function sqlFunctionGreatest() {
    $args = func_get_args();
    foreach ($args as $v) {
      if (!isset($v)) {
        unset($args);
      }
    }
    if (count($args)) {
      return max($args);
    }
    else {
      return NULL;
    }
  }

  /**
   * SQLite compatibility implementation for the CONCAT() SQL function.
   */
  public static function sqlFunctionConcat() {
    $args = func_get_args();
    return implode('', $args);
  }

  /**
   * SQLite compatibility implementation for the CONCAT_WS() SQL function.
   *
   * @see http://dev.mysql.com/doc/refman/5.6/en/string-functions.html#function_concat-ws
   */
  public static function sqlFunctionConcatWs() {
    $args = func_get_args();
    $separator = array_shift($args);

    // If the separator is NULL, the result is NULL.
    if ($separator === FALSE || is_null($separator)) {
      return NULL;
    }

    // Skip any NULL values after the separator argument.
    $args = array_filter($args, function ($value) {
      return !is_null($value);
    });
    return implode($separator, $args);
  }

  /**
   * SQLite compatibility implementation for the SUBSTRING() SQL function.
   */
  public static function sqlFunctionSubstring($string, $from, $length) {
    return substr($string, $from - 1, $length);
  }

  /**
   * SQLite compatibility implementation for the SUBSTRING_INDEX() SQL function.
   */
  public static function sqlFunctionSubstringIndex($string, $delimiter, $count) {

    // If string is empty, simply return an empty string.
    if (empty($string)) {
      return '';
    }
    $end = 0;
    for ($i = 0; $i < $count; $i++) {
      $end = strpos($string, $delimiter, $end + 1);
      if ($end === FALSE) {
        $end = strlen($string);
      }
    }
    return substr($string, 0, $end);
  }

  /**
   * SQLite compatibility implementation for the RAND() SQL function.
   */
  public static function sqlFunctionRand($seed = NULL) {
    if (isset($seed)) {
      mt_srand($seed);
    }
    return mt_rand() / mt_getrandmax();
  }

  /**
   * SQLite compatibility implementation for the REGEXP SQL operator.
   *
   * The REGEXP operator is natively known, but not implemented by default.
   *
   * @see http://www.sqlite.org/lang_expr.html#regexp
   */
  public static function sqlFunctionRegexp($pattern, $subject) {

    // preg_quote() cannot be used here, since $pattern may contain reserved
    // regular expression characters already (such as ^, $, etc). Therefore,
    // use a rare character as PCRE delimiter.
    $pattern = '#' . addcslashes($pattern, '#') . '#i';
    return preg_match($pattern, $subject);
  }

  /**
   * SQLite compatibility implementation for the LIKE BINARY SQL operator.
   *
   * SQLite supports case-sensitive LIKE operations through the
   * 'case_sensitive_like' PRAGMA statement, but only for ASCII characters, so
   * we have to provide our own implementation with UTF-8 support.
   *
   * @see https://sqlite.org/pragma.html#pragma_case_sensitive_like
   * @see https://sqlite.org/lang_expr.html#like
   */
  public static function sqlFunctionLikeBinary($pattern, $subject) {

    // Replace the SQL LIKE wildcard meta-characters with the equivalent regular
    // expression meta-characters and escape the delimiter that will be used for
    // matching.
    $pattern = str_replace(array(
      '%',
      '_',
    ), array(
      '.*?',
      '.',
    ), preg_quote($pattern, '/'));
    return preg_match('/^' . $pattern . '$/', $subject);
  }

  /**
   * {@inheritdoc}
   */
  public function prepare($statement, array $driver_options = array()) {
    return new Statement($this->connection, $this, $statement, $driver_options);
  }

  /**
   * {@inheritdoc}
   */
  protected function handleQueryException(\PDOException $e, $query, array $args = array(), $options = array()) {

    // The database schema might be changed by another process in between the
    // time that the statement was prepared and the time the statement was run
    // (e.g. usually happens when running tests). In this case, we need to
    // re-run the query.
    // @see http://www.sqlite.org/faq.html#q15
    // @see http://www.sqlite.org/rescode.html#schema
    if (!empty($e->errorInfo[1]) && $e->errorInfo[1] === 17) {
      return $this
        ->query($query, $args, $options);
    }
    parent::handleQueryException($e, $query, $args, $options);
  }
  public function queryRange($query, $from, $count, array $args = array(), array $options = array()) {
    return $this
      ->query($query . ' LIMIT ' . (int) $from . ', ' . (int) $count, $args, $options);
  }
  public function queryTemporary($query, array $args = array(), array $options = array()) {

    // Generate a new temporary table name and protect it from prefixing.
    // SQLite requires that temporary tables to be non-qualified.
    $tablename = $this
      ->generateTemporaryTableName();
    $prefixes = $this->prefixes;
    $prefixes[$tablename] = '';
    $this
      ->setPrefix($prefixes);
    $this
      ->query('CREATE TEMPORARY TABLE ' . $tablename . ' AS ' . $query, $args, $options);
    return $tablename;
  }
  public function driver() {
    return 'sqlite';
  }
  public function databaseType() {
    return 'sqlite';
  }

  /**
   * Overrides \Drupal\Core\Database\Connection::createDatabase().
   *
   * @param string $database
   *   The name of the database to create.
   *
   * @throws \Drupal\Core\Database\DatabaseNotFoundException
   */
  public function createDatabase($database) {

    // Verify the database is writable.
    $db_directory = new \SplFileInfo(dirname($database));
    if (!$db_directory
      ->isDir() && !drupal_mkdir($db_directory
      ->getPathName(), 0755, TRUE)) {
      throw new DatabaseNotFoundException('Unable to create database directory ' . $db_directory
        ->getPathName());
    }
  }
  public function mapConditionOperator($operator) {

    // We don't want to override any of the defaults.
    static $specials = array(
      'LIKE' => array(
        'postfix' => " ESCAPE '\\'",
      ),
      'NOT LIKE' => array(
        'postfix' => " ESCAPE '\\'",
      ),
      'LIKE BINARY' => array(
        'postfix' => " ESCAPE '\\'",
        'operator' => 'GLOB',
      ),
      'NOT LIKE BINARY' => array(
        'postfix' => " ESCAPE '\\'",
        'operator' => 'NOT GLOB',
      ),
    );
    return isset($specials[$operator]) ? $specials[$operator] : NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function prepareQuery($query) {
    return $this
      ->prepare($this
      ->prefixTables($query));
  }
  public function nextId($existing_id = 0) {
    $this
      ->startTransaction();

    // We can safely use literal queries here instead of the slower query
    // builder because if a given database breaks here then it can simply
    // override nextId. However, this is unlikely as we deal with short strings
    // and integers and no known databases require special handling for those
    // simple cases. If another transaction wants to write the same row, it will
    // wait until this transaction commits. Also, the return value needs to be
    // set to RETURN_AFFECTED as if it were a real update() query otherwise it
    // is not possible to get the row count properly.
    $affected = $this
      ->query('UPDATE {sequences} SET value = GREATEST(value, :existing_id) + 1', array(
      ':existing_id' => $existing_id,
    ), array(
      'return' => Database::RETURN_AFFECTED,
    ));
    if (!$affected) {
      $this
        ->query('INSERT INTO {sequences} (value) VALUES (:existing_id + 1)', array(
        ':existing_id' => $existing_id,
      ));
    }

    // The transaction gets committed when the transaction object gets destroyed
    // because it gets out of scope.
    return $this
      ->query('SELECT value FROM {sequences}')
      ->fetchField();
  }

  /**
   * {@inheritdoc}
   */
  public function getFullQualifiedTableName($table) {
    $prefix = $this
      ->tablePrefix($table);

    // Don't include the SQLite database file name as part of the table name.
    return $prefix . $table;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Connection::$attachedDatabases	protected	property	All databases attached to the current database. This is used to allow prefixes to be safely handled without locking the table
Connection::$connection	protected	property	The actual PDO connection.
Connection::$connectionOptions	protected	property	The connection information for this connection object.
Connection::$driverClasses	protected	property	Index of what driver-specific class to use for various operations.
Connection::$key	protected	property	The key representing this connection.
Connection::$logger	protected	property	The current database logging object for this connection.
Connection::$prefixes	protected	property	The prefixes used by this database connection.
Connection::$prefixReplace	protected	property	List of replacement values for use in prefixTables().
Connection::$prefixSearch	protected	property	List of search values for use in prefixTables().
Connection::$schema	protected	property	The schema object for this connection.
Connection::$statementClass	protected	property	The name of the Statement class for this connection.
Connection::$tableDropped		property	Whether or not a table has been dropped this request: the destructor will only try to get rid of unnecessary databases if there is potential of them being empty.
Connection::$target	protected	property	The database target this connection is for.
Connection::$temporaryNameIndex	protected	property	An index used to generate unique temporary table names.
Connection::$transactionalDDLSupport	protected	property	Whether this database connection supports transactional DDL.
Connection::$transactionLayers	protected	property	Tracks the number of "layers" of transactions currently active.
Connection::$transactionSupport	protected	property	Whether this database connection supports transactions.
Connection::$unprefixedTablesMap	protected	property	List of un-prefixed table names, keyed by prefixed table names.
Connection::$willRollback	protected	property	Whether or not the active transaction (if any) will be rolled back.
Connection::clientVersion	public	function	Returns the version of the database client.
Connection::commit	public	function	Throws an exception to deny direct access to transaction commits.
Connection::createDatabase	public	function	Overrides \Drupal\Core\Database\Connection::createDatabase(). Overrides Connection::createDatabase
Connection::databaseType	public	function	Returns the name of the PDO driver for this connection. Overrides Connection::databaseType
Connection::DATABASE_NOT_FOUND		constant	Error code for "Unable to open database file" error.
Connection::defaultOptions	protected	function	Returns the default query options for any given query.
Connection::delete	public	function	Prepares and returns a DELETE query object.
Connection::destroy	public	function	Destroys this Connection object.
Connection::driver	public	function	Returns the type of database driver. Overrides Connection::driver
Connection::escapeAlias	public	function	Escapes an alias name string.	1
Connection::escapeDatabase	public	function	Escapes a database name string.
Connection::escapeField	public	function	Escapes a field name string.	1
Connection::escapeLike	public	function	Escapes characters that work as wildcard characters in a LIKE pattern.
Connection::escapeTable	public	function	Escapes a table name string.	1
Connection::expandArguments	protected	function	Expands out shorthand placeholders.
Connection::filterComment	protected	function	Sanitize a query comment string.
Connection::generateTemporaryTableName	protected	function	Generates a temporary table name.
Connection::getAttachedDatabases	public	function	Gets all the attached databases.
Connection::getConnectionOptions	public	function	Returns the connection information for this connection object.
Connection::getDriverClass	public	function	Gets the driver-specific override class if any for the specified class.
Connection::getFullQualifiedTableName	public	function	Get a fully qualified table name. Overrides Connection::getFullQualifiedTableName
Connection::getKey	public	function	Returns the key this connection is associated with.
Connection::getLogger	public	function	Gets the current logging object for this connection.
Connection::getTarget	public	function	Returns the target this connection is associated with.
Connection::getUnprefixedTablesMap	public	function	Gets a list of individually prefixed table names.
Connection::handleQueryException	protected	function	Wraps and re-throws any PDO exception thrown by static::query(). Overrides Connection::handleQueryException
Connection::insert	public	function	Prepares and returns an INSERT query object.
Connection::inTransaction	public	function	Determines if there is an active transaction open.
Connection::makeComment	public	function	Flatten an array of query comments into a single comment string.
Connection::makeSequenceName	public	function	Creates the appropriate sequence name for a given table and serial field.
Connection::mapConditionOperator	public	function	Gets any special processing requirements for the condition operator. Overrides Connection::mapConditionOperator
Connection::merge	public	function	Prepares and returns a MERGE query object.
Connection::nextId	public	function	Retrieves an unique ID from a given sequence. Overrides Connection::nextId
Connection::open	public static	function	Opens a PDO connection. Overrides Connection::open
Connection::popCommittableTransactions	protected	function	Internal function: commit all the transaction layers that can commit.	1
Connection::popTransaction	public	function	Decreases the depth of transaction nesting.
Connection::prefixTables	public	function	Appends a database prefix to all tables in a query.
Connection::prepare	public	function	Prepares a statement for execution and returns a statement object Overrides Connection::prepare
Connection::prepareQuery	public	function	Prepares a query string and returns the prepared statement. Overrides Connection::prepareQuery
Connection::pushTransaction	public	function	Increases the depth of transaction nesting.
Connection::query	public	function	Executes a query string against the database.	2
Connection::queryRange	public	function	Runs a limited-range query on this database object. Overrides Connection::queryRange
Connection::queryTemporary	public	function	Runs a SELECT query and stores its results in a temporary table. Overrides Connection::queryTemporary
Connection::quote	public	function	Quotes a string for use in a query.
Connection::rollback	public	function	Rolls back the transaction entirely or to a named savepoint.
Connection::schema	public	function	Returns a DatabaseSchema object for manipulating the schema.
Connection::select	public	function	Prepares and returns a SELECT query object.
Connection::setKey	public	function	Tells this connection object what its key is.
Connection::setLogger	public	function	Associates a logging object with this connection.
Connection::setPrefix	protected	function	Set the list of prefixes used by this database connection.
Connection::setTarget	public	function	Tells this connection object what its target value is.
Connection::sqlFunctionConcat	public static	function	SQLite compatibility implementation for the CONCAT() SQL function.
Connection::sqlFunctionConcatWs	public static	function	SQLite compatibility implementation for the CONCAT_WS() SQL function.
Connection::sqlFunctionGreatest	public static	function	SQLite compatibility implementation for the GREATEST() SQL function.
Connection::sqlFunctionIf	public static	function	SQLite compatibility implementation for the IF() SQL function.
Connection::sqlFunctionLikeBinary	public static	function	SQLite compatibility implementation for the LIKE BINARY SQL operator.
Connection::sqlFunctionRand	public static	function	SQLite compatibility implementation for the RAND() SQL function.
Connection::sqlFunctionRegexp	public static	function	SQLite compatibility implementation for the REGEXP SQL operator.
Connection::sqlFunctionSubstring	public static	function	SQLite compatibility implementation for the SUBSTRING() SQL function.
Connection::sqlFunctionSubstringIndex	public static	function	SQLite compatibility implementation for the SUBSTRING_INDEX() SQL function.
Connection::startTransaction	public	function	Returns a new DatabaseTransaction object on this connection.
Connection::supportsTransactionalDDL	public	function	Determines if this driver supports transactional DDL.
Connection::supportsTransactions	public	function	Determines if this driver supports transactions.
Connection::tablePrefix	public	function	Find the prefix for a table.
Connection::transactionDepth	public	function	Determines the current transaction depth.
Connection::truncate	public	function	Prepares and returns a TRUNCATE query object.
Connection::update	public	function	Prepares and returns an UPDATE query object.
Connection::upsert	public	function	Prepares and returns an UPSERT query object.	1
Connection::version	public	function	Returns the version of the database server.
Connection::__construct	public	function	Constructs a \Drupal\Core\Database\Driver\sqlite\Connection object. Overrides Connection::__construct
Connection::__destruct	public	function	Destructor for the SQLite connection.
Connection::__sleep	public	function	Prevents the database connection from being serialized.