class Connection in Drupal driver for SQL Server and SQL Azure 8
Same name and namespace in other branches
- 8.2 drivers/lib/Drupal/Driver/Database/sqlsrv/Connection.php \Drupal\Driver\Database\sqlsrv\Connection
- 3.0.x drivers/lib/Drupal/Driver/Database/sqlsrv/Connection.php \Drupal\Driver\Database\sqlsrv\Connection
Temporary tables: temporary table support is done by means of global temporary tables (#) to avoid the use of DIRECT QUERIES. You can enable and disable the use of direct queries with $this->driver_settings->defaultDirectQuery = TRUE|FALSE. http://blogs.msdn.com/b/brian_swan/archive/2010/06/15/ctp2-of-microsoft-...
Hierarchy
- class \Drupal\Core\Database\Connection
- class \Drupal\Driver\Database\sqlsrv\Connection
Expanded class hierarchy of Connection
3 files declare their use of Connection
- IndexManager.php in src/
Indexes/ IndexManager.php - sqlsrv.install in ./
sqlsrv.install - Installation file for sqlsrv module.
- Tasks.php in drivers/
lib/ Drupal/ Driver/ Database/ sqlsrv/ Install/ Tasks.php - Definition of Drupal\Driver\Database\sqlsrv\Tasks
File
- drivers/
lib/ Drupal/ Driver/ Database/ sqlsrv/ Connection.php, line 47 - Definition of Drupal\Driver\Database\sqlsrv\Connection
Namespace
Drupal\Driver\Database\sqlsrvView source
class Connection extends DatabaseConnection {
/**
* Database driver settings.
*
* @var DriverSettings
*/
public $driver_settings = NULL;
/**
* Override of DatabaseConnection::driver().
*
* @status tested
*/
public function driver() {
return 'sqlsrv';
}
/**
* Override of DatabaseConnection::databaseType().
*
* @status tested
*/
public function databaseType() {
return 'sqlsrv';
}
/**
* Error code for Login Failed, usually happens when
* the database does not exist.
*/
const DATABASE_NOT_FOUND = 28000;
/**
* Summary of $cache
*
* @var FastCache
*/
public $cache;
/**
* Constructs a Connection object.
*/
public function __construct(\PDO $connection, array $connection_options) {
// Initialize settings.
$this->driver_settings = DriverSettings::instanceFromSettings();
// Initialize cache.
$this->cache = new FastCache($connection_options['prefix']['default']);
// Needs to happen before parent construct.
$this->statementClass = Statement::class;
parent::__construct($connection, $connection_options);
// This driver defaults to transaction support, except if explicitly passed FALSE.
$this->transactionSupport = !isset($connection_options['transactions']) || $connection_options['transactions'] !== FALSE;
$this->transactionalDDLSupport = $this->transactionSupport;
// Store connection options for future reference.
$this->connectionOptions =& $connection_options;
// Fetch the name of the user-bound schema. It is the schema that SQL Server
// will use for non-qualified tables.
$this
->schema()->defaultSchema = $this
->schema()
->GetDefaultSchema();
}
/**
* {@inheritdoc}
*/
public static function open(array &$connection_options = []) {
// Get driver settings.
$driverSettings = DriverSettings::instanceFromSettings();
// Build the DSN.
$options = [];
$options['Server'] = $connection_options['host'] . (!empty($connection_options['port']) ? ',' . $connection_options['port'] : '');
// We might not have a database in the
// connection options, for example, during
// database creation in Install.
if (!empty($connection_options['database'])) {
$options['Database'] = $connection_options['database'];
}
// Set isolation level if specified.
if ($level = $driverSettings
->GetDefaultIsolationLevel()) {
$options['TransactionIsolation'] = $level;
}
// Build the DSN.
$dsn = 'sqlsrv:';
foreach ($options as $key => $value) {
$dsn .= (empty($key) ? '' : "{$key}=") . $value . ';';
}
// Allow PDO options to be overridden.
$connection_options += [
'pdo' => [],
];
$connection_options['pdo'] += [
\PDO::ATTR_ERRMODE => \PDO::ERRMODE_EXCEPTION,
];
// Set a Statement class, unless the driver opted out.
// $connection_options['pdo'][PDO::ATTR_STATEMENT_CLASS] =
// array(Statement::class, array(Statement::class));.
// Actually instantiate the PDO.
try {
$pdo = new \PDO($dsn, $connection_options['username'], $connection_options['password'], $connection_options['pdo']);
} catch (\Exception $e) {
if ($e
->getCode() == static::DATABASE_NOT_FOUND) {
throw new DatabaseNotFoundException($e
->getMessage(), $e
->getCode(), $e);
}
throw $e;
}
return $pdo;
}
/**
* Prepared PDO statements only makes sense if we cache them...
*
* @var mixed
*/
private $statement_cache = array();
/**
* Temporary override of DatabaseConnection::prepareQuery().
*
* @todo: remove that when DatabaseConnection::prepareQuery() is fixed to call
* $this->prepare() and not parent::prepare().
* https://www.drupal.org/node/2345451
* @status: tested, temporary
*/
public function prepareQuery($query, array $options = array()) {
// Merge default statement options. These options are
// only specific for this preparation and will only override
// the global configuration if set to different than NULL.
$options = array_merge(array(
'insecure' => FALSE,
'statement_caching' => $this->driver_settings
->GetStatementCachingMode(),
'direct_query' => $this->driver_settings
->GetDefaultDirectQueries(),
'prefix_tables' => TRUE,
), $options);
// Prefix tables. There is no global setting for this.
if ($options['prefix_tables'] !== FALSE) {
$query = $this
->prefixTables($query);
}
// The statement caching settings only affect the storage
// in the cache, but if a statement is already available
// why not reuse it!
if (isset($this->statement_cache[$query])) {
return $this->statement_cache[$query];
}
#region PDO Options
$pdo_options = array();
// Set insecure options if requested so.
if ($options['insecure'] === TRUE) {
// We have to log this, prepared statements are a security RISK.
// watchdog('SQL Server Driver', 'An insecure query has been executed against the database. This is not critical, but worth looking into: %query', array('%query' => $query));
// These are defined in class Connection.
// This PDO options are INSECURE, but will overcome the following issues:
// (1) Duplicate placeholders
// (2) > 2100 parameter limit
// (3) Using expressions for group by with parameters are not detected as equal.
// This options are not applied by default, they are just stored in the connection
// options and applied when needed. See {Statement} class.
// We ask PDO to perform the placeholders replacement itself because
// SQL Server is not able to detect duplicated placeholders in
// complex statements.
// E.g. This query is going to fail because SQL Server cannot
// detect that length1 and length2 are equals.
// SELECT SUBSTRING(title, 1, :length1)
// FROM node
// GROUP BY SUBSTRING(title, 1, :length2
// This is only going to work in PDO 3 but doesn't hurt in PDO 2.
// The security of parameterized queries is not in effect when you use PDO::ATTR_EMULATE_PREPARES => true.
// Your application should ensure that the data that is bound to the parameter(s) does not contain malicious
// Transact-SQL code.
// Never use this when you need special column binding.
// THIS ONLY WORKS IF SET AT THE STATEMENT LEVEL.
$pdo_options[PDO::ATTR_EMULATE_PREPARES] = TRUE;
}
// We run the statements in "direct mode" because the way PDO prepares
// statement in non-direct mode cause temporary tables to be destroyed
// at the end of the statement.
// If you are using the PDO_SQLSRV driver and you want to execute a query that
// changes a database setting (e.g. SET NOCOUNT ON), use the PDO::query method with
// the PDO::SQLSRV_ATTR_DIRECT_QUERY attribute.
// http://blogs.iis.net/bswan/archive/2010/12/09/how-to-change-database-settings-with-the-pdo-sqlsrv-driver.aspx
// If a query requires the context that was set in a previous query,
// you should execute your queries with PDO::SQLSRV_ATTR_DIRECT_QUERY set to True.
// For example, if you use temporary tables in your queries, PDO::SQLSRV_ATTR_DIRECT_QUERY must be set
// to True.
if ($this->driver_settings
->GetStatementCachingMode() != 'always' || $options['direct_query'] == TRUE) {
$pdo_options[PDO::SQLSRV_ATTR_DIRECT_QUERY] = TRUE;
}
// It creates a cursor for the query, which allows you to iterate over the result set
// without fetching the whole result at once. A scrollable cursor, specifically, is one that allows
// iterating backwards.
// https://msdn.microsoft.com/en-us/library/hh487158%28v=sql.105%29.aspx
$pdo_options[PDO::ATTR_CURSOR] = PDO::CURSOR_SCROLL;
// Lets you access rows in any order. Creates a client-side cursor query.
$pdo_options[PDO::SQLSRV_ATTR_CURSOR_SCROLL_TYPE] = PDO::SQLSRV_CURSOR_BUFFERED;
#endregion
// Call our overriden prepare.
$stmt = $this
->PDOPrepare($query, $pdo_options);
// If statement caching is enabled, store current statement for reuse.
if ($options['statement_caching'] === TRUE) {
$this->statement_cache[$query] = $stmt;
}
return $stmt;
}
/**
* Internal function: prepare a query by calling PDO directly.
*
* This function has to be public because it is called by other parts of the
* database layer, but do not call it directly, as you risk locking down the
* PHP process.
*/
public function PDOPrepare($query, array $options = array()) {
// Preprocess the query.
if (!$this->driver_settings
->GetDeafultBypassQueryPreprocess()) {
$query = $this
->preprocessQuery($query);
}
// You can set the MSSQL_APPEND_CALLSTACK_COMMENT to TRUE
// to append to each query, in the form of comments, the current
// backtrace plus other details that aid in debugging deadlocks
// or long standing locks. Use in combination with MSSQL profiler.
global $conf;
if ($this->driver_settings
->GetAppendCallstackComment()) {
$oUser = \Drupal::currentUser();
$uid = NULL;
if ($oUser != NULL) {
$uid = $oUser
->getAccount()
->id();
}
$trim = strlen(DRUPAL_ROOT);
$trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
static $request_id;
if (empty($request_id)) {
$request_id = uniqid('', TRUE);
}
// Remove las item (it's alwasy PDOPrepare)
$trace = array_splice($trace, 1);
$comment = PHP_EOL . PHP_EOL;
$comment .= '-- uid:' . ($uid ? $uid : 'NULL') . PHP_EOL;
$uri = isset($_SERVER['REQUEST_URI']) ? $_SERVER['REQUEST_URI'] : 'none';
$uri = preg_replace("/[^a-zA-Z0-9]/i", "_", $uri);
$comment .= '-- url:' . $uri . PHP_EOL;
//$comment .= '-- request_id:' . $request_id . PHP_EOL;
foreach ($trace as $t) {
$function = isset($t['function']) ? $t['function'] : '';
$file = '';
if (isset($t['file'])) {
$len = strlen($t['file']);
if ($len > $trim) {
$file = substr($t['file'], $trim, $len - $trim) . " [{$t['line']}]";
}
}
$comment .= '-- ' . str_pad($function, 35) . ' ' . $file . PHP_EOL;
}
$query = $comment . PHP_EOL . $query;
}
return parent::prepare($query, $options);
}
/**
* This is the original replacement regexp from Microsoft.
*
* We could probably simplify it a lot because queries only contain
* placeholders when we modify them.
*
* NOTE: removed 'escape' from the list, because it explodes
* with LIKE xxx ESCAPE yyy syntax.
*/
const RESERVED_REGEXP = '/\\G
# Everything that follows a boundary that is not : or _.
\\b(?<![:\\[_])(?:
# Any reserved words, followed by a boundary that is not an opening parenthesis.
(action|admin|alias|any|are|array|at|begin|boolean|class|commit|contains|current|data|date|day|depth|domain|external|file|full|function|get|go|host|input|language|last|less|local|map|min|module|new|no|object|old|open|operation|parameter|parameters|path|plan|prefix|proc|public|ref|result|returns|role|row|rule|save|search|second|section|session|size|state|statistics|temporary|than|time|timestamp|tran|translate|translation|trim|user|value|variable|view|without)
(?!\\()
|
# Or a normal word.
([a-z]+)
)\\b
|
\\b(
[^a-z\'"\\\\]+
)\\b
|
(?=[\'"])
(
" [^\\\\"] * (?: \\\\. [^\\\\"] *) * "
|
\' [^\\\\\']* (?: \\\\. [^\\\\\']*) * \'
)
/Six';
/**
* This method gets called between 3,000 and 10,000 times
* on cold caches. Make sure it is simple and fast.
*
* @param mixed $matches
* @return mixed
*/
protected function replaceReservedCallback($matches) {
if ($matches[1] !== '') {
// Replace reserved words. We are not calling
// quoteIdentifier() on purpose.
return '[' . $matches[1] . ']';
}
// Let other value passthru.
// by the logic of the regex above, this will always be the last match.
return end($matches);
}
/**
* {@inheritdoc}
*/
public function quoteIdentifier($identifier) {
return '[' . $identifier . ']';
}
/**
* {@inheritdoc}
*/
public function escapeField($field) {
// TODO: Not really clear if using a cache here is really useful as the uncached implementation
// is fast out of the box anyways. Needs profiling.
if ($cache = $this->cache
->get($field, 'schema_escapeField')) {
return $cache->data;
}
if (strlen($field) > 0) {
$result = implode('.', array_map(array(
$this,
'quoteIdentifier',
), explode('.', preg_replace('/[^A-Za-z0-9_.]+/', '', $field))));
}
else {
$result = '';
}
$this->cache
->set($field, $result, 'schema_escapeField');
return $result;
}
/**
* {@inheritdoc}
*/
public function quoteIdentifiers($identifiers) {
return array_map(array(
$this,
'quoteIdentifier',
), $identifiers);
}
/**
* {@inheritdoc}
*/
public function escapeLike($string) {
return preg_replace('/([\\[\\]%_])/', '[$1]', $string);
}
/**
* {@inheritdoc}
*/
public function queryRange($query, $from, $count, array $args = array(), array $options = array()) {
$query = $this
->addRangeToQuery($query, $from, $count);
return $this
->query($query, $args, $options);
}
/**
* Generates a temporary table name. Because we are using
* global temporary tables, these are visible between
* connections so we need to make sure that their
* names are as unique as possible to prevent collisions.
*
* @return string
* A table name.
*/
protected function generateTemporaryTableName() {
static $temp_key;
if (!isset($temp_key)) {
$temp_key = strtoupper(md5(uniqid(rand(), true)));
}
return "db_temp_" . $this->temporaryNameIndex++ . '_' . $temp_key;
}
/**
* {@inheritdoc}
*/
public function queryTemporary($query, array $args = array(), array $options = array()) {
// Generate a new GLOBAL temporary table name and protect it from prefixing.
// SQL Server requires that temporary tables to be non-qualified.
$tablename = '##' . $this
->generateTemporaryTableName();
// Temporary tables cannot be introspected so using them is limited on some scenarios.
if ($options['real_table'] === TRUE) {
$tablename = trim($tablename, "#");
}
$prefixes = $this->prefixes;
$prefixes[$tablename] = '';
$this
->setPrefix($prefixes);
// Having comments in the query can be tricky and break the SELECT FROM -> SELECT INTO conversion
$query = $this
->schema()
->removeSQLComments($query);
// Replace SELECT xxx FROM table by SELECT xxx INTO #table FROM table.
$query = preg_replace('/^SELECT(.*?)FROM/is', 'SELECT$1 INTO ' . $tablename . ' FROM', $query);
$this
->query($query, $args, $options);
return $tablename;
}
/**
* {@inheritdoc}
*
* This method is overriden to manage the insecure (EMULATE_PREPARE)
* behaviour to prevent some compatibility issues with SQL Server.
*/
public function query($query, array $args = array(), $options = array()) {
// Use default values if not already set.
$options += $this
->defaultOptions();
$stmt = NULL;
try {
// We allow either a pre-bound statement object or a literal string.
// In either case, we want to end up with an executed statement object,
// which we pass to PDOStatement::execute.
if ($query instanceof StatementInterface) {
$stmt = $query;
$stmt
->execute(NULL, $options);
}
else {
$this
->expandArguments($query, $args);
$insecure = isset($options['insecure']) ? $options['insecure'] : FALSE;
// Try to detect duplicate place holders, this check's performance
// is not a good addition to the driver, but does a good job preventing
// duplicate placeholder errors.
$argcount = count($args);
if ($insecure === TRUE || $argcount >= 2100 || $argcount != substr_count($query, ':')) {
$insecure = TRUE;
}
$stmt = $this
->prepareQuery($query, array(
'insecure' => $insecure,
));
$stmt
->execute($args, $options);
}
// Depending on the type of query we may need to return a different value.
// See DatabaseConnection::defaultOptions() for a description of each
// value.
switch ($options['return']) {
case Database::RETURN_STATEMENT:
return $stmt;
case Database::RETURN_AFFECTED:
$stmt->allowRowCount = TRUE;
return $stmt
->rowCount();
case Database::RETURN_INSERT_ID:
return $this->connection
->lastInsertId();
case Database::RETURN_NULL:
return NULL;
default:
throw new \PDOException('Invalid return directive: ' . $options['return']);
}
} catch (\PDOException $e) {
// Most database drivers will return NULL here, but some of them
// (e.g. the SQLite driver) may need to re-run the query, so the return
// value will be the same as for static::query().
return $this
->handleQueryException($e, $query, $args, $options);
}
}
/**
* Wraps and re-throws any PDO exception thrown by static::query().
*
* @param \PDOException $e
* The exception thrown by static::query().
* @param $query
* The query executed by static::query().
* @param array $args
* An array of arguments for the prepared statement.
* @param array $options
* An associative array of options to control how the query is run.
*
* @return \Drupal\Core\Database\StatementInterface|int|null
* Most database drivers will return NULL when a PDO exception is thrown for
* a query, but some of them may need to re-run the query, so they can also
* return a \Drupal\Core\Database\StatementInterface object or an integer.
*
* @throws \Drupal\Core\Database\DatabaseExceptionWrapper
* @throws \Drupal\Core\Database\IntegrityConstraintViolationException
*/
public function handleQueryException(\PDOException $e, $query, array $args = array(), $options = array()) {
if ($options['throw_exception']) {
// Wrap the exception in another exception, because PHP does not allow
// overriding Exception::getMessage(). Its message is the extra database
// debug information.
if ($query instanceof StatementInterface) {
$query_string = $query
->getQueryString();
}
else {
$query_string = $query;
}
$message = $e
->getMessage() . ": " . $query_string . "; " . print_r($args, TRUE);
// Match all SQLSTATE 23xxx errors.
if (substr($e
->getCode(), -6, -3) == '23') {
$exception = new IntegrityConstraintViolationException($message, $e
->getCode(), $e);
}
else {
$exception = new DatabaseExceptionWrapper($message, 0, $e);
}
$exception->query_string = $query_string;
$exception->args = $args;
throw $exception;
}
return NULL;
}
/**
* Like query but with no insecure detection or query preprocessing.
* The caller is sure that his query is MS SQL compatible! Used internally
* from the schema class, but could be called from anywhere.
*
* @param mixed $query
* @param array $args
* @param mixed $options
* @throws PDOException
* @return mixed
*/
public function query_direct($query, array $args = array(), $options = array()) {
// Use default values if not already set.
$options += $this
->defaultOptions();
$stmt = NULL;
try {
// Bypass query preprocessing and use direct queries.
$ctx = new DatabaseContext($this, TRUE, TRUE);
$stmt = $this
->prepareQuery($query, $options);
$stmt
->execute($args, $options);
// Reset the context settings.
unset($ctx);
// Depending on the type of query we may need to return a different value.
// See DatabaseConnection::defaultOptions() for a description of each
// value.
switch ($options['return']) {
case Database::RETURN_STATEMENT:
return $stmt;
case Database::RETURN_AFFECTED:
$stmt->allowRowCount = TRUE;
return $stmt
->rowCount();
case Database::RETURN_INSERT_ID:
return $this->connection
->lastInsertId();
case Database::RETURN_NULL:
return NULL;
default:
throw new \PDOException('Invalid return directive: ' . $options['return']);
}
} catch (\PDOException $e) {
// Most database drivers will return NULL here, but some of them
// (e.g. the SQLite driver) may need to re-run the query, so the return
// value will be the same as for static::query().
return $this
->handleQueryException($e, $query, $args, $options);
}
}
/**
* Internal function: massage a query to make it compliant with SQL Server.
*/
public function preprocessQuery($query) {
// Generate a cache signature for this query.
$query_signature = 'query_cache_' . md5($query);
// Drill through everything...
$success = FALSE;
$cache = '';
if (extension_loaded('wincache')) {
$cache = wincache_ucache_get($query_signature, $success);
}
elseif (extension_loaded('apcu') && (PHP_SAPI !== 'cli' || (bool) ini_get('apc.enable_cli'))) {
$cache = apcu_fetch($query_signature, $success);
}
if ($success) {
return $cache;
}
// Force quotes around some SQL Server reserved keywords.
if (preg_match('/^SELECT/i', $query)) {
$query = preg_replace_callback(self::RESERVED_REGEXP, array(
$this,
'replaceReservedCallback',
), $query);
}
// Last chance to modify some SQL Server-specific syntax.
$replacements = array();
// Add prefixes to Drupal-specific functions.
$defaultSchema = $this
->schema()
->GetDefaultSchema();
foreach ($this
->schema()
->DrupalSpecificFunctions() as $function) {
$replacements['/\\b(?<![:.])(' . preg_quote($function) . ')\\(/i'] = "{$defaultSchema}.\$1(";
}
// Rename some functions.
$funcs = array(
'LENGTH' => 'LEN',
'POW' => 'POWER',
);
foreach ($funcs as $function => $replacement) {
$replacements['/\\b(?<![:.])(' . preg_quote($function) . ')\\(/i'] = $replacement . '(';
}
// Replace the ANSI concatenation operator with SQL Server poor one.
$replacements['/\\|\\|/'] = '+';
// Now do all the replacements at once.
$query = preg_replace(array_keys($replacements), array_values($replacements), $query);
// Store the processed query, and make sure we expire it some time
// so that scarcely used queries don't stay in the cache forever.
if (extension_loaded('wincache')) {
wincache_ucache_set($query_signature, $query, rand(600, 3600));
}
elseif (extension_loaded('apcu') && (PHP_SAPI !== 'cli' || (bool) ini_get('apc.enable_cli'))) {
apcu_store($query_signature, $query, rand(600, 3600));
}
return $query;
}
/**
* Internal function: add range options to a query.
*
* This cannot be set protected because it is used in other parts of the
* database engine.
*
* @status tested
*/
public function addRangeToQuery($query, $from, $count) {
if ($from == 0) {
// Easy case: just use a TOP query if we don't have to skip any rows.
$query = preg_replace('/^\\s*SELECT(\\s*DISTINCT)?/Dsi', 'SELECT$1 TOP(' . $count . ')', $query);
}
else {
if ($this
->schema()
->EngineVersionNumber() >= 11) {
// As of SQL Server 2012 there is an easy (and faster!) way to page results.
$query = $query .= " OFFSET {$from} ROWS FETCH NEXT {$count} ROWS ONLY";
}
else {
// More complex case: use a TOP query to retrieve $from + $count rows, and
// filter out the first $from rows using a window function.
$query = preg_replace('/^\\s*SELECT(\\s*DISTINCT)?/Dsi', 'SELECT$1 TOP(' . ($from + $count) . ') ', $query);
$query = '
SELECT * FROM (
SELECT sub2.*, ROW_NUMBER() OVER(ORDER BY sub2.__line2) AS __line3 FROM (
SELECT sub1.*, 1 AS __line2 FROM (' . $query . ') AS sub1
) as sub2
) AS sub3
WHERE __line3 BETWEEN ' . ($from + 1) . ' AND ' . ($from + $count);
}
}
return $query;
}
/**
* A map of condition operators to sqlsrv operators.
*
* SQL Server doesn't need special escaping for the \ character in a string
* literal, because it uses '' to escape the single quote, not \'.
*
* @var array
*/
protected static $sqlsrvConditionOperatorMap = [
// These can be changed to 'LIKE' => ['postfix' => " ESCAPE '\\'"],
// if https://bugs.php.net/bug.php?id=79276 is fixed.
'LIKE' => [],
'NOT LIKE' => [],
'LIKE BINARY' => [
'operator' => 'LIKE',
],
];
/**
* {@inheritdoc}
*/
public function mapConditionOperator($operator) {
return isset(static::$sqlsrvConditionOperatorMap[$operator]) ? static::$sqlsrvConditionOperatorMap[$operator] : NULL;
}
/**
* Override of DatabaseConnection::nextId().
*
* @status tested
*/
public function nextId($existing = 0) {
// If an exiting value is passed, for its insertion into the sequence table.
if ($existing > 0) {
try {
$this
->query_direct('SET IDENTITY_INSERT {sequences} ON; INSERT INTO {sequences} (value) VALUES(:existing); SET IDENTITY_INSERT {sequences} OFF', array(
':existing' => $existing,
));
} catch (Exception $e) {
// Doesn't matter if this fails, it just means that this value is already
// present in the table.
}
}
// Refactored to use OUTPUT because under high concurrency LAST_INSERTED_ID does not work properly.
return $this
->query_direct('INSERT INTO {sequences} OUTPUT (Inserted.[value]) DEFAULT VALUES')
->fetchField();
}
/**
* Override DatabaseConnection::escapeTable().
*
* @status needswork
*/
public function escapeTable($table) {
// A static cache is better suited for this.
static $tables = array();
if (isset($tables[$table])) {
return $tables[$table];
}
// Rescue the # prefix from the escaping.
$is_temporary = $table[0] == '#';
$is_temporary_global = $is_temporary && isset($table[1]) && $table[1] == '#';
// Any temporary table prefix will be removed.
$result = preg_replace('/[^A-Za-z0-9_.]+/', '', $table);
// Restore the temporary prefix.
if ($is_temporary) {
if ($is_temporary_global) {
$result = '##' . $result;
}
else {
$result = '#' . $result;
}
}
$tables[$table] = $result;
return $result;
}
#region Transactions
/**
* Overriden to allow transaction settings.
*/
public function startTransaction($name = '', DatabaseTransactionSettings $settings = NULL) {
if ($settings == NULL) {
$settings = DatabaseTransactionSettings::GetDefaults();
}
return new Transaction($this, $name, $settings);
}
/**
* Overriden.
*/
public function rollback($savepoint_name = 'drupal_transaction') {
if (!$this
->supportsTransactions()) {
return;
}
if (!$this
->inTransaction()) {
throw new DatabaseTransactionNoActiveException();
}
// A previous rollback to an earlier savepoint may mean that the savepoint
// in question has already been accidentally committed.
if (!isset($this->transactionLayers[$savepoint_name])) {
throw new DatabaseTransactionNoActiveException();
}
// We need to find the point we're rolling back to, all other savepoints
// before are no longer needed. If we rolled back other active savepoints,
// we need to throw an exception.
$rolled_back_other_active_savepoints = FALSE;
while ($savepoint = array_pop($this->transactionLayers)) {
if ($savepoint['name'] == $savepoint_name) {
// If it is the last the transaction in the stack, then it is not a
// savepoint, it is the transaction itself so we will need to roll back
// the transaction rather than a savepoint.
if (empty($this->transactionLayers)) {
break;
}
if ($savepoint['started'] == TRUE) {
$this
->query_direct('ROLLBACK TRANSACTION ' . $savepoint['name']);
}
$this
->popCommittableTransactions();
if ($rolled_back_other_active_savepoints) {
throw new DatabaseTransactionOutOfOrderException();
}
return;
}
else {
$rolled_back_other_active_savepoints = TRUE;
}
}
$this->connection
->rollBack();
// Restore original transaction isolation level
if ($level = $this->driver_settings
->GetDefaultTransactionIsolationLevelInStatement()) {
if ($savepoint['settings']
->Get_IsolationLevel() != DatabaseTransactionIsolationLevel::Ignore()) {
if ($level != $savepoint['settings']
->Get_IsolationLevel()) {
$this
->query_direct("SET TRANSACTION ISOLATION LEVEL {$level}");
}
}
}
if ($rolled_back_other_active_savepoints) {
throw new DatabaseTransactionOutOfOrderException();
}
}
/**
* Summary of pushTransaction
* @param string $name
* @param DatabaseTransactionSettings $settings
* @throws DatabaseTransactionNameNonUniqueException
* @return void
*/
public function pushTransaction($name, $settings = NULL) {
if ($settings == NULL) {
$settings = DatabaseTransactionSettings::GetBetterDefaults();
}
if (!$this
->supportsTransactions()) {
return;
}
if (isset($this->transactionLayers[$name])) {
throw new DatabaseTransactionNameNonUniqueException($name . " is already in use.");
}
$started = FALSE;
// If we're already in a transaction.
// TODO: Transaction scope Options is not working properly
// for first level transactions. It assumes that - always - a first level
// transaction must be started.
if ($this
->inTransaction()) {
switch ($settings
->Get_ScopeOption()) {
case DatabaseTransactionScopeOption::RequiresNew():
$this
->query_direct('SAVE TRANSACTION ' . $name);
$started = TRUE;
break;
case DatabaseTransactionScopeOption::Required():
// We are already in a transaction, do nothing.
break;
case DatabaseTransactionScopeOption::Supress():
// The only way to supress the ambient transaction is to use a new connection
// during the scope of this transaction, a bit messy to implement.
throw new Exception('DatabaseTransactionScopeOption::Supress not implemented.');
}
}
else {
if ($settings
->Get_IsolationLevel() != DatabaseTransactionIsolationLevel::Ignore()) {
$current_isolation_level = strtoupper($this
->schema()
->UserOptions()['isolation level']);
// Se what isolation level was requested.
$level = $settings
->Get_IsolationLevel()
->__toString();
if (strcasecmp($current_isolation_level, $level) !== 0) {
$this
->query_direct("SET TRANSACTION ISOLATION LEVEL {$level}");
}
}
// In order to start a transaction current statement cursors
// must be closed.
foreach ($this->statement_cache as $statement) {
$statement
->closeCursor();
}
$this->connection
->beginTransaction();
}
// Store the name and settings in the stack.
$this->transactionLayers[$name] = array(
'settings' => $settings,
'active' => TRUE,
'name' => $name,
'started' => $started,
);
}
/**
* Decreases the depth of transaction nesting.
*
* If we pop off the last transaction layer, then we either commit or roll
* back the transaction as necessary. If no transaction is active, we return
* because the transaction may have manually been rolled back.
*
* @param $name
* The name of the savepoint
*
* @throws DatabaseTransactionNoActiveException
* @throws DatabaseTransactionCommitFailedException
*
* @see DatabaseTransaction
*/
public function popTransaction($name) {
if (!$this
->supportsTransactions()) {
return;
}
// The transaction has already been committed earlier. There is nothing we
// need to do. If this transaction was part of an earlier out-of-order
// rollback, an exception would already have been thrown by
// Database::rollback().
if (!isset($this->transactionLayers[$name])) {
return;
}
// Mark this layer as committable.
$this->transactionLayers[$name]['active'] = FALSE;
$this
->popCommittableTransactions();
}
/**
* Internal function: commit all the transaction layers that can commit.
*/
protected function popCommittableTransactions() {
// Commit all the committable layers.
foreach (array_reverse($this->transactionLayers) as $name => $state) {
// Stop once we found an active transaction.
if ($state['active']) {
break;
}
// If there are no more layers left then we should commit.
unset($this->transactionLayers[$name]);
if (empty($this->transactionLayers)) {
try {
// PDO::commit() can either return FALSE or throw an exception itself
if (!$this->connection
->commit()) {
throw new DatabaseTransactionCommitFailedException();
}
} finally {
// Restore original transaction isolation level
if ($level = $this->driver_settings
->GetDefaultTransactionIsolationLevelInStatement()) {
if ($state['settings']
->Get_IsolationLevel() != DatabaseTransactionIsolationLevel::Ignore()) {
if ($level != $state['settings']
->Get_IsolationLevel()
->__toString()) {
$this
->query_direct("SET TRANSACTION ISOLATION LEVEL {$level}");
}
}
}
}
}
else {
// Savepoints cannot be commited, only rolled back.
}
}
}
#endregion
/**
* 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) {
// Escape the database name.
$database = Database::getConnection()
->escapeDatabase($database);
try {
// Create the database and set it as active.
$this->connection
->exec("CREATE DATABASE {$database} COLLATE " . Schema::DEFAULT_COLLATION_CI);
} catch (DatabaseException $e) {
throw new DatabaseNotFoundException($e
->getMessage());
}
}
}Members
Name |
Modifiers | Type | Description | Overrides |
|---|---|---|---|---|
|
Connection:: |
public | property | Summary of $cache | |
|
Connection:: |
protected | property | The actual PDO connection. | |
|
Connection:: |
protected | property | The connection information for this connection object. | |
|
Connection:: |
protected | property | Index of what driver-specific class to use for various operations. | |
|
Connection:: |
public | property | Database driver settings. | |
|
Connection:: |
protected | property | List of escaped aliases names, keyed by unescaped aliases. | |
|
Connection:: |
protected | property | List of escaped database, table, and field names, keyed by unescaped names. | |
|
Connection:: |
protected | property | The key representing this connection. | |
|
Connection:: |
protected | property | The current database logging object for this connection. | |
|
Connection:: |
protected | property | The prefixes used by this database connection. | |
|
Connection:: |
protected | property | List of replacement values for use in prefixTables(). | |
|
Connection:: |
protected | property | List of search values for use in prefixTables(). | |
|
Connection:: |
protected | property | Post-root (non-nested) transaction commit callbacks. | |
|
Connection:: |
protected | property | The schema object for this connection. | |
|
Connection:: |
protected static | property | A map of condition operators to sqlsrv operators. | |
|
Connection:: |
protected | property | The name of the Statement class for this connection. | |
|
Connection:: |
private | property | Prepared PDO statements only makes sense if we cache them... | |
|
Connection:: |
protected | property | The database target this connection is for. | |
|
Connection:: |
protected | property | An index used to generate unique temporary table names. | |
|
Connection:: |
protected | property | Whether this database connection supports transactional DDL. | |
|
Connection:: |
protected | property | Tracks the number of "layers" of transactions currently active. | |
|
Connection:: |
protected | property | Whether this database connection supports transactions. | |
|
Connection:: |
protected | property | List of un-prefixed table names, keyed by prefixed table names. | |
|
Connection:: |
public | function | Internal function: add range options to a query. | |
|
Connection:: |
public | function | Adds a root transaction end callback. | |
|
Connection:: |
public | function | Returns the version of the database client. | |
|
Connection:: |
public | function | Throws an exception to deny direct access to transaction commits. | |
|
Connection:: |
public | function | Prepares and returns a CONDITION query object. | |
|
Connection:: |
public static | function | Creates an array of database connection options from a URL. | 1 |
|
Connection:: |
public | function |
Overrides \Drupal\Core\Database\Connection::createDatabase(). Overrides Connection:: |
|
|
Connection:: |
public static | function | Creates a URL from an array of database connection options. | 1 |
|
Connection:: |
public | function |
Override of DatabaseConnection::databaseType(). Overrides Connection:: |
|
|
Connection:: |
constant | Error code for Login Failed, usually happens when the database does not exist. | ||
|
Connection:: |
protected | function | Returns the default query options for any given query. | |
|
Connection:: |
public | function | Prepares and returns a DELETE query object. | |
|
Connection:: |
public | function | Destroys this Connection object. | |
|
Connection:: |
protected | function | Do the actual commit, invoke post-commit callbacks. | |
|
Connection:: |
public | function |
Override of DatabaseConnection::driver(). Overrides Connection:: |
|
|
Connection:: |
public | function | Escapes an alias name string. | 2 |
|
Connection:: |
public | function | Escapes a database name string. | |
|
Connection:: |
public | function |
Escapes a field name string. Overrides Connection:: |
|
|
Connection:: |
public | function |
Escapes characters that work as wildcard characters in a LIKE pattern. Overrides Connection:: |
|
|
Connection:: |
public | function |
Override DatabaseConnection::escapeTable(). Overrides Connection:: |
|
|
Connection:: |
protected | function | Expands out shorthand placeholders. | |
|
Connection:: |
protected | function | Sanitize a query comment string. | |
|
Connection:: |
protected | function |
Generates a temporary table name. Because we are using
global temporary tables, these are visible between
connections so we need to make sure that their
names are as unique as possible to prevent collisions. Overrides Connection:: |
|
|
Connection:: |
public | function | Returns the connection information for this connection object. | |
|
Connection:: |
public | function | Gets the driver-specific override class if any for the specified class. | |
|
Connection:: |
public | function | Get a fully qualified table name. | 2 |
|
Connection:: |
public | function | Returns the key this connection is associated with. | |
|
Connection:: |
public | function | Gets the current logging object for this connection. | |
|
Connection:: |
protected static | function | Extracts the SQLSTATE error from the PDOException. | |
|
Connection:: |
public | function | Returns the target this connection is associated with. | |
|
Connection:: |
public | function | Gets a list of individually prefixed table names. | |
|
Connection:: |
public | function |
Wraps and re-throws any PDO exception thrown by static::query(). Overrides Connection:: |
|
|
Connection:: |
public | function | Prepares and returns an INSERT query object. | |
|
Connection:: |
public | function | Determines if there is an active transaction open. | |
|
Connection:: |
public | function | Flatten an array of query comments into a single comment string. | |
|
Connection:: |
public | function | Creates the appropriate sequence name for a given table and serial field. | |
|
Connection:: |
public | function |
Gets any special processing requirements for the condition operator. Overrides Connection:: |
|
|
Connection:: |
public | function | Prepares and returns a MERGE query object. | |
|
Connection:: |
public | function |
Override of DatabaseConnection::nextId(). Overrides Connection:: |
|
|
Connection:: |
public static | function |
Opens a PDO connection. Overrides Connection:: |
|
|
Connection:: |
public | function | Internal function: prepare a query by calling PDO directly. | |
|
Connection:: |
protected | function |
Internal function: commit all the transaction layers that can commit. Overrides Connection:: |
|
|
Connection:: |
public | function |
Decreases the depth of transaction nesting. Overrides Connection:: |
|
|
Connection:: |
public | function | Appends a database prefix to all tables in a query. | |
|
Connection:: |
public | function | Prepares a statement for execution and returns a statement object | 1 |
|
Connection:: |
public | function |
Temporary override of DatabaseConnection::prepareQuery(). Overrides Connection:: |
|
|
Connection:: |
public | function | Internal function: massage a query to make it compliant with SQL Server. | |
|
Connection:: |
public | function |
Summary of pushTransaction Overrides Connection:: |
|
|
Connection:: |
public | function |
This method is overriden to manage the insecure (EMULATE_PREPARE)
behaviour to prevent some compatibility issues with SQL Server. Overrides Connection:: |
|
|
Connection:: |
public | function |
Runs a limited-range query on this database object. Overrides Connection:: |
|
|
Connection:: |
public | function |
Runs a SELECT query and stores its results in a temporary table. Overrides Connection:: |
|
|
Connection:: |
public | function | Like query but with no insecure detection or query preprocessing. The caller is sure that his query is MS SQL compatible! Used internally from the schema class, but could be called from anywhere. | |
|
Connection:: |
public | function | Quotes a string for use in a query. | |
|
Connection:: |
public | function | ||
|
Connection:: |
public | function | ||
|
Connection:: |
protected | function | This method gets called between 3,000 and 10,000 times on cold caches. Make sure it is simple and fast. | |
|
Connection:: |
constant | This is the original replacement regexp from Microsoft. | ||
|
Connection:: |
public | function | Overriden. | |
|
Connection:: |
public | function | Rolls back the transaction entirely or to a named savepoint. | |
|
Connection:: |
public | function | Returns a DatabaseSchema object for manipulating the schema. | |
|
Connection:: |
public | function | Prepares and returns a SELECT query object. | |
|
Connection:: |
public | function | Tells this connection object what its key is. | |
|
Connection:: |
public | function | Associates a logging object with this connection. | |
|
Connection:: |
protected | function | Set the list of prefixes used by this database connection. | |
|
Connection:: |
public | function | Tells this connection object what its target value is. | |
|
Connection:: |
public | function |
Overriden to allow transaction settings. Overrides Connection:: |
|
|
Connection:: |
public | function | Determines if this driver supports transactional DDL. | |
|
Connection:: |
public | function | Determines if this driver supports transactions. | |
|
Connection:: |
public | function | Find the prefix for a table. | |
|
Connection:: |
public | function | Determines the current transaction depth. | |
|
Connection:: |
public | function | Prepares and returns a TRUNCATE query object. | |
|
Connection:: |
public | function | Prepares and returns an UPDATE query object. | |
|
Connection:: |
public | function | Prepares and returns an UPSERT query object. | 1 |
|
Connection:: |
public | function | Returns the version of the database server. | 1 |
|
Connection:: |
public | function |
Constructs a Connection object. Overrides Connection:: |
|
|
Connection:: |
public | function | Prevents the database connection from being serialized. |