123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945 |
- <?php
- declare(strict_types=1);
- /**
- * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
- * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
- * SPDX-License-Identifier: AGPL-3.0-only
- */
- namespace OC\DB;
- use Doctrine\Common\EventManager;
- use Doctrine\DBAL\Cache\QueryCacheProfile;
- use Doctrine\DBAL\Configuration;
- use Doctrine\DBAL\Connections\PrimaryReadReplicaConnection;
- use Doctrine\DBAL\Driver;
- use Doctrine\DBAL\Driver\ServerInfoAwareConnection;
- use Doctrine\DBAL\Exception;
- use Doctrine\DBAL\Exception\ConnectionLost;
- use Doctrine\DBAL\Platforms\MySQLPlatform;
- use Doctrine\DBAL\Platforms\OraclePlatform;
- use Doctrine\DBAL\Platforms\PostgreSQLPlatform;
- use Doctrine\DBAL\Platforms\SqlitePlatform;
- use Doctrine\DBAL\Result;
- use Doctrine\DBAL\Schema\Schema;
- use Doctrine\DBAL\Statement;
- use OC\DB\QueryBuilder\Partitioned\PartitionedQueryBuilder;
- use OC\DB\QueryBuilder\Partitioned\PartitionSplit;
- use OC\DB\QueryBuilder\QueryBuilder;
- use OC\DB\QueryBuilder\Sharded\AutoIncrementHandler;
- use OC\DB\QueryBuilder\Sharded\CrossShardMoveHelper;
- use OC\DB\QueryBuilder\Sharded\RoundRobinShardMapper;
- use OC\DB\QueryBuilder\Sharded\ShardConnectionManager;
- use OC\DB\QueryBuilder\Sharded\ShardDefinition;
- use OC\SystemConfig;
- use OCP\DB\QueryBuilder\IQueryBuilder;
- use OCP\DB\QueryBuilder\Sharded\IShardMapper;
- use OCP\Diagnostics\IEventLogger;
- use OCP\ICacheFactory;
- use OCP\IDBConnection;
- use OCP\ILogger;
- use OCP\IRequestId;
- use OCP\PreConditionNotMetException;
- use OCP\Profiler\IProfiler;
- use OCP\Security\ISecureRandom;
- use OCP\Server;
- use Psr\Clock\ClockInterface;
- use Psr\Log\LoggerInterface;
- use function count;
- use function in_array;
- class Connection extends PrimaryReadReplicaConnection {
- /** @var string */
- protected $tablePrefix;
- /** @var \OC\DB\Adapter $adapter */
- protected $adapter;
- /** @var SystemConfig */
- private $systemConfig;
- private ClockInterface $clock;
- private LoggerInterface $logger;
- protected $lockedTable = null;
- /** @var int */
- protected $queriesBuilt = 0;
- /** @var int */
- protected $queriesExecuted = 0;
- /** @var DbDataCollector|null */
- protected $dbDataCollector = null;
- private array $lastConnectionCheck = [];
- protected ?float $transactionActiveSince = null;
- /** @var array<string, int> */
- protected $tableDirtyWrites = [];
- protected bool $logDbException = false;
- private ?array $transactionBacktrace = null;
- protected bool $logRequestId;
- protected string $requestId;
- /** @var array<string, list<string>> */
- protected array $partitions;
- /** @var ShardDefinition[] */
- protected array $shards = [];
- protected ShardConnectionManager $shardConnectionManager;
- protected AutoIncrementHandler $autoIncrementHandler;
- protected bool $isShardingEnabled;
- public const SHARD_PRESETS = [
- 'filecache' => [
- 'companion_keys' => [
- 'file_id',
- ],
- 'companion_tables' => [
- 'filecache_extended',
- 'files_metadata',
- ],
- 'primary_key' => 'fileid',
- 'shard_key' => 'storage',
- 'table' => 'filecache',
- ],
- ];
- /**
- * Initializes a new instance of the Connection class.
- *
- * @throws \Exception
- */
- public function __construct(
- private array $params,
- Driver $driver,
- ?Configuration $config = null,
- ?EventManager $eventManager = null,
- ) {
- if (!isset($params['adapter'])) {
- throw new \Exception('adapter not set');
- }
- if (!isset($params['tablePrefix'])) {
- throw new \Exception('tablePrefix not set');
- }
- /**
- * @psalm-suppress InternalMethod
- */
- parent::__construct($params, $driver, $config, $eventManager);
- $this->adapter = new $params['adapter']($this);
- $this->tablePrefix = $params['tablePrefix'];
- $this->isShardingEnabled = isset($this->params['sharding']) && !empty($this->params['sharding']);
- if ($this->isShardingEnabled) {
- /** @psalm-suppress InvalidArrayOffset */
- $this->shardConnectionManager = $this->params['shard_connection_manager'] ?? Server::get(ShardConnectionManager::class);
- /** @psalm-suppress InvalidArrayOffset */
- $this->autoIncrementHandler = $this->params['auto_increment_handler'] ?? new AutoIncrementHandler(
- Server::get(ICacheFactory::class),
- $this->shardConnectionManager,
- );
- }
- $this->systemConfig = \OC::$server->getSystemConfig();
- $this->clock = Server::get(ClockInterface::class);
- $this->logger = Server::get(LoggerInterface::class);
- $this->logRequestId = $this->systemConfig->getValue('db.log_request_id', false);
- $this->logDbException = $this->systemConfig->getValue('db.log_exceptions', false);
- $this->requestId = Server::get(IRequestId::class)->getId();
- /** @var \OCP\Profiler\IProfiler */
- $profiler = Server::get(IProfiler::class);
- if ($profiler->isEnabled()) {
- $this->dbDataCollector = new DbDataCollector($this);
- $profiler->add($this->dbDataCollector);
- $debugStack = new BacktraceDebugStack();
- $this->dbDataCollector->setDebugStack($debugStack);
- $this->_config->setSQLLogger($debugStack);
- }
- /** @var array<string, array{shards: array[], mapper: ?string}> $shardConfig */
- $shardConfig = $this->params['sharding'] ?? [];
- $shardNames = array_keys($shardConfig);
- $this->shards = array_map(function (array $config, string $name) {
- if (!isset(self::SHARD_PRESETS[$name])) {
- throw new \Exception("Shard preset $name not found");
- }
- $shardMapperClass = $config['mapper'] ?? RoundRobinShardMapper::class;
- $shardMapper = Server::get($shardMapperClass);
- if (!$shardMapper instanceof IShardMapper) {
- throw new \Exception("Invalid shard mapper: $shardMapperClass");
- }
- return new ShardDefinition(
- self::SHARD_PRESETS[$name]['table'],
- self::SHARD_PRESETS[$name]['primary_key'],
- self::SHARD_PRESETS[$name]['companion_keys'],
- self::SHARD_PRESETS[$name]['shard_key'],
- $shardMapper,
- self::SHARD_PRESETS[$name]['companion_tables'],
- $config['shards']
- );
- }, $shardConfig, $shardNames);
- $this->shards = array_combine($shardNames, $this->shards);
- $this->partitions = array_map(function (ShardDefinition $shard) {
- return array_merge([$shard->table], $shard->companionTables);
- }, $this->shards);
- $this->setNestTransactionsWithSavepoints(true);
- }
- /**
- * @return IDBConnection[]
- */
- public function getShardConnections(): array {
- $connections = [];
- if ($this->isShardingEnabled) {
- foreach ($this->shards as $shardDefinition) {
- foreach ($shardDefinition->getAllShards() as $shard) {
- /** @var ConnectionAdapter $connection */
- $connections[] = $this->shardConnectionManager->getConnection($shardDefinition, $shard);
- }
- }
- }
- return $connections;
- }
- /**
- * @throws Exception
- */
- public function connect($connectionName = null) {
- try {
- if ($this->_conn) {
- $this->reconnectIfNeeded();
- /** @psalm-suppress InternalMethod */
- return parent::connect();
- }
- $this->lastConnectionCheck[$this->getConnectionName()] = time();
- // Only trigger the event logger for the initial connect call
- $eventLogger = Server::get(IEventLogger::class);
- $eventLogger->start('connect:db', 'db connection opened');
- /** @psalm-suppress InternalMethod */
- $status = parent::connect();
- $eventLogger->end('connect:db');
- return $status;
- } catch (Exception $e) {
- // throw a new exception to prevent leaking info from the stacktrace
- throw new Exception('Failed to connect to the database: ' . $e->getMessage(), $e->getCode());
- }
- }
- protected function performConnect(?string $connectionName = null): bool {
- if (($connectionName ?? 'replica') === 'replica'
- && count($this->params['replica']) === 1
- && $this->params['primary'] === $this->params['replica'][0]) {
- return parent::performConnect('primary');
- }
- return parent::performConnect($connectionName);
- }
- public function getStats(): array {
- return [
- 'built' => $this->queriesBuilt,
- 'executed' => $this->queriesExecuted,
- ];
- }
- /**
- * Returns a QueryBuilder for the connection.
- */
- public function getQueryBuilder(): IQueryBuilder {
- $this->queriesBuilt++;
- $builder = new QueryBuilder(
- new ConnectionAdapter($this),
- $this->systemConfig,
- $this->logger
- );
- if ($this->isShardingEnabled && count($this->partitions) > 0) {
- $builder = new PartitionedQueryBuilder(
- $builder,
- $this->shards,
- $this->shardConnectionManager,
- $this->autoIncrementHandler,
- );
- foreach ($this->partitions as $name => $tables) {
- $partition = new PartitionSplit($name, $tables);
- $builder->addPartition($partition);
- }
- return $builder;
- } else {
- return $builder;
- }
- }
- /**
- * Gets the QueryBuilder for the connection.
- *
- * @return \Doctrine\DBAL\Query\QueryBuilder
- * @deprecated 8.0.0 please use $this->getQueryBuilder() instead
- */
- public function createQueryBuilder() {
- $backtrace = $this->getCallerBacktrace();
- $this->logger->debug('Doctrine QueryBuilder retrieved in {backtrace}', ['app' => 'core', 'backtrace' => $backtrace]);
- $this->queriesBuilt++;
- return parent::createQueryBuilder();
- }
- /**
- * Gets the ExpressionBuilder for the connection.
- *
- * @return \Doctrine\DBAL\Query\Expression\ExpressionBuilder
- * @deprecated 8.0.0 please use $this->getQueryBuilder()->expr() instead
- */
- public function getExpressionBuilder() {
- $backtrace = $this->getCallerBacktrace();
- $this->logger->debug('Doctrine ExpressionBuilder retrieved in {backtrace}', ['app' => 'core', 'backtrace' => $backtrace]);
- $this->queriesBuilt++;
- return parent::getExpressionBuilder();
- }
- /**
- * Get the file and line that called the method where `getCallerBacktrace()` was used
- *
- * @return string
- */
- protected function getCallerBacktrace() {
- $traces = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
- // 0 is the method where we use `getCallerBacktrace`
- // 1 is the target method which uses the method we want to log
- if (isset($traces[1])) {
- return $traces[1]['file'] . ':' . $traces[1]['line'];
- }
- return '';
- }
- /**
- * @return string
- */
- public function getPrefix() {
- return $this->tablePrefix;
- }
- /**
- * Prepares an SQL statement.
- *
- * @param string $statement The SQL statement to prepare.
- * @param int|null $limit
- * @param int|null $offset
- *
- * @return Statement The prepared statement.
- * @throws Exception
- */
- public function prepare($sql, $limit = null, $offset = null): Statement {
- if ($limit === -1 || $limit === null) {
- $limit = null;
- } else {
- $limit = (int)$limit;
- }
- if ($offset !== null) {
- $offset = (int)$offset;
- }
- if (!is_null($limit)) {
- $platform = $this->getDatabasePlatform();
- $sql = $platform->modifyLimitQuery($sql, $limit, $offset);
- }
- $statement = $this->finishQuery($sql);
- return parent::prepare($statement);
- }
- /**
- * Executes an, optionally parametrized, SQL query.
- *
- * If the query is parametrized, a prepared statement is used.
- * If an SQLLogger is configured, the execution is logged.
- *
- * @param string $sql The SQL query to execute.
- * @param array $params The parameters to bind to the query, if any.
- * @param array $types The types the previous parameters are in.
- * @param \Doctrine\DBAL\Cache\QueryCacheProfile|null $qcp The query cache profile, optional.
- *
- * @return Result The executed statement.
- *
- * @throws \Doctrine\DBAL\Exception
- */
- public function executeQuery(string $sql, array $params = [], $types = [], ?QueryCacheProfile $qcp = null): Result {
- $tables = $this->getQueriedTables($sql);
- $now = $this->clock->now()->getTimestamp();
- $dirtyTableWrites = [];
- foreach ($tables as $table) {
- $lastAccess = $this->tableDirtyWrites[$table] ?? 0;
- // Only very recent writes are considered dirty
- if ($lastAccess >= ($now - 3)) {
- $dirtyTableWrites[] = $table;
- }
- }
- if ($this->isTransactionActive()) {
- // Transacted queries go to the primary. The consistency of the primary guarantees that we can not run
- // into a dirty read.
- } elseif (count($dirtyTableWrites) === 0) {
- // No tables read that could have been written already in the same request and no transaction active
- // so we can switch back to the replica for reading as long as no writes happen that switch back to the primary
- // We cannot log here as this would log too early in the server boot process
- $this->ensureConnectedToReplica();
- } else {
- // Read to a table that has been written to previously
- // While this might not necessarily mean that we did a read after write it is an indication for a code path to check
- $this->logger->log(
- (int)($this->systemConfig->getValue('loglevel_dirty_database_queries', null) ?? 0),
- 'dirty table reads: ' . $sql,
- [
- 'tables' => array_keys($this->tableDirtyWrites),
- 'reads' => $tables,
- 'exception' => new \Exception('dirty table reads: ' . $sql),
- ],
- );
- // To prevent a dirty read on a replica that is slightly out of sync, we
- // switch back to the primary. This is detrimental for performance but
- // safer for consistency.
- $this->ensureConnectedToPrimary();
- }
- $sql = $this->finishQuery($sql);
- $this->queriesExecuted++;
- $this->logQueryToFile($sql);
- try {
- return parent::executeQuery($sql, $params, $types, $qcp);
- } catch (\Exception $e) {
- $this->logDatabaseException($e);
- throw $e;
- }
- }
- /**
- * Helper function to get the list of tables affected by a given query
- * used to track dirty tables that received a write with the current request
- */
- private function getQueriedTables(string $sql): array {
- $re = '/(\*PREFIX\*\w+)/mi';
- preg_match_all($re, $sql, $matches);
- return array_map([$this, 'replaceTablePrefix'], $matches[0] ?? []);
- }
- /**
- * @throws Exception
- */
- public function executeUpdate(string $sql, array $params = [], array $types = []): int {
- return $this->executeStatement($sql, $params, $types);
- }
- /**
- * Executes an SQL INSERT/UPDATE/DELETE query with the given parameters
- * and returns the number of affected rows.
- *
- * This method supports PDO binding types as well as DBAL mapping types.
- *
- * @param string $sql The SQL query.
- * @param array $params The query parameters.
- * @param array $types The parameter types.
- *
- * @return int The number of affected rows.
- *
- * @throws \Doctrine\DBAL\Exception
- */
- public function executeStatement($sql, array $params = [], array $types = []): int {
- $tables = $this->getQueriedTables($sql);
- foreach ($tables as $table) {
- $this->tableDirtyWrites[$table] = $this->clock->now()->getTimestamp();
- }
- $sql = $this->finishQuery($sql);
- $this->queriesExecuted++;
- $this->logQueryToFile($sql);
- try {
- return (int)parent::executeStatement($sql, $params, $types);
- } catch (\Exception $e) {
- $this->logDatabaseException($e);
- throw $e;
- }
- }
- protected function logQueryToFile(string $sql): void {
- $logFile = $this->systemConfig->getValue('query_log_file');
- if ($logFile !== '' && is_writable(dirname($logFile)) && (!file_exists($logFile) || is_writable($logFile))) {
- $prefix = '';
- if ($this->systemConfig->getValue('query_log_file_requestid') === 'yes') {
- $prefix .= Server::get(IRequestId::class)->getId() . "\t";
- }
- $postfix = '';
- if ($this->systemConfig->getValue('query_log_file_backtrace') === 'yes') {
- $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
- array_pop($trace);
- $postfix .= '; ' . json_encode($trace);
- }
- // FIXME: Improve to log the actual target db host
- $isPrimary = $this->connections['primary'] === $this->_conn;
- $prefix .= ' ' . ($isPrimary === true ? 'primary' : 'replica') . ' ';
- $prefix .= ' ' . $this->getTransactionNestingLevel() . ' ';
- file_put_contents(
- $this->systemConfig->getValue('query_log_file', ''),
- $prefix . $sql . $postfix . "\n",
- FILE_APPEND
- );
- }
- }
- /**
- * Returns the ID of the last inserted row, or the last value from a sequence object,
- * depending on the underlying driver.
- *
- * Note: This method may not return a meaningful or consistent result across different drivers,
- * because the underlying database may not even support the notion of AUTO_INCREMENT/IDENTITY
- * columns or sequences.
- *
- * @param string $seqName Name of the sequence object from which the ID should be returned.
- *
- * @return int the last inserted ID.
- * @throws Exception
- */
- public function lastInsertId($name = null): int {
- if ($name) {
- $name = $this->replaceTablePrefix($name);
- }
- return $this->adapter->lastInsertId($name);
- }
- /**
- * @internal
- * @throws Exception
- */
- public function realLastInsertId($seqName = null) {
- return parent::lastInsertId($seqName);
- }
- /**
- * Insert a row if the matching row does not exists. To accomplish proper race condition avoidance
- * it is needed that there is also a unique constraint on the values. Then this method will
- * catch the exception and return 0.
- *
- * @param string $table The table name (will replace *PREFIX* with the actual prefix)
- * @param array $input data that should be inserted into the table (column name => value)
- * @param array|null $compare List of values that should be checked for "if not exists"
- * If this is null or an empty array, all keys of $input will be compared
- * Please note: text fields (clob) must not be used in the compare array
- * @return int number of inserted rows
- * @throws \Doctrine\DBAL\Exception
- * @deprecated 15.0.0 - use unique index and "try { $db->insert() } catch (UniqueConstraintViolationException $e) {}" instead, because it is more reliable and does not have the risk for deadlocks - see https://github.com/nextcloud/server/pull/12371
- */
- public function insertIfNotExist($table, $input, ?array $compare = null) {
- try {
- return $this->adapter->insertIfNotExist($table, $input, $compare);
- } catch (\Exception $e) {
- $this->logDatabaseException($e);
- throw $e;
- }
- }
- public function insertIgnoreConflict(string $table, array $values) : int {
- try {
- return $this->adapter->insertIgnoreConflict($table, $values);
- } catch (\Exception $e) {
- $this->logDatabaseException($e);
- throw $e;
- }
- }
- private function getType($value) {
- if (is_bool($value)) {
- return IQueryBuilder::PARAM_BOOL;
- } elseif (is_int($value)) {
- return IQueryBuilder::PARAM_INT;
- } else {
- return IQueryBuilder::PARAM_STR;
- }
- }
- /**
- * Insert or update a row value
- *
- * @param string $table
- * @param array $keys (column name => value)
- * @param array $values (column name => value)
- * @param array $updatePreconditionValues ensure values match preconditions (column name => value)
- * @return int number of new rows
- * @throws \OCP\DB\Exception
- * @throws PreConditionNotMetException
- */
- public function setValues(string $table, array $keys, array $values, array $updatePreconditionValues = []): int {
- try {
- $insertQb = $this->getQueryBuilder();
- $insertQb->insert($table)
- ->values(
- array_map(function ($value) use ($insertQb) {
- return $insertQb->createNamedParameter($value, $this->getType($value));
- }, array_merge($keys, $values))
- );
- return $insertQb->executeStatement();
- } catch (\OCP\DB\Exception $e) {
- if (!in_array($e->getReason(), [
- \OCP\DB\Exception::REASON_CONSTRAINT_VIOLATION,
- \OCP\DB\Exception::REASON_UNIQUE_CONSTRAINT_VIOLATION,
- ])
- ) {
- throw $e;
- }
- // value already exists, try update
- $updateQb = $this->getQueryBuilder();
- $updateQb->update($table);
- foreach ($values as $name => $value) {
- $updateQb->set($name, $updateQb->createNamedParameter($value, $this->getType($value)));
- }
- $where = [];
- $whereValues = array_merge($keys, $updatePreconditionValues);
- foreach ($whereValues as $name => $value) {
- if ($value === '') {
- $where[] = $updateQb->expr()->emptyString(
- $name
- );
- } else {
- $where[] = $updateQb->expr()->eq(
- $name,
- $updateQb->createNamedParameter($value, $this->getType($value)),
- $this->getType($value)
- );
- }
- }
- $updateQb->where($updateQb->expr()->andX(...$where));
- $affected = $updateQb->executeStatement();
- if ($affected === 0 && !empty($updatePreconditionValues)) {
- throw new PreConditionNotMetException();
- }
- return 0;
- }
- }
- /**
- * Create an exclusive read+write lock on a table
- *
- * @param string $tableName
- *
- * @throws \BadMethodCallException When trying to acquire a second lock
- * @throws Exception
- * @since 9.1.0
- */
- public function lockTable($tableName) {
- if ($this->lockedTable !== null) {
- throw new \BadMethodCallException('Can not lock a new table until the previous lock is released.');
- }
- $tableName = $this->tablePrefix . $tableName;
- $this->lockedTable = $tableName;
- $this->adapter->lockTable($tableName);
- }
- /**
- * Release a previous acquired lock again
- *
- * @throws Exception
- * @since 9.1.0
- */
- public function unlockTable() {
- $this->adapter->unlockTable();
- $this->lockedTable = null;
- }
- /**
- * returns the error code and message as a string for logging
- * works with DoctrineException
- * @return string
- */
- public function getError() {
- $msg = $this->errorCode() . ': ';
- $errorInfo = $this->errorInfo();
- if (!empty($errorInfo)) {
- $msg .= 'SQLSTATE = ' . $errorInfo[0] . ', ';
- $msg .= 'Driver Code = ' . $errorInfo[1] . ', ';
- $msg .= 'Driver Message = ' . $errorInfo[2];
- }
- return $msg;
- }
- public function errorCode() {
- return -1;
- }
- public function errorInfo() {
- return [];
- }
- /**
- * Drop a table from the database if it exists
- *
- * @param string $table table name without the prefix
- *
- * @throws Exception
- */
- public function dropTable($table) {
- $table = $this->tablePrefix . trim($table);
- $schema = $this->createSchemaManager();
- if ($schema->tablesExist([$table])) {
- $schema->dropTable($table);
- }
- }
- /**
- * Check if a table exists
- *
- * @param string $table table name without the prefix
- *
- * @return bool
- * @throws Exception
- */
- public function tableExists($table) {
- $table = $this->tablePrefix . trim($table);
- $schema = $this->createSchemaManager();
- return $schema->tablesExist([$table]);
- }
- protected function finishQuery(string $statement): string {
- $statement = $this->replaceTablePrefix($statement);
- $statement = $this->adapter->fixupStatement($statement);
- if ($this->logRequestId) {
- return $statement . ' /* reqid: ' . $this->requestId . ' */';
- } else {
- return $statement;
- }
- }
- // internal use
- /**
- * @param string $statement
- * @return string
- */
- protected function replaceTablePrefix($statement) {
- return str_replace('*PREFIX*', $this->tablePrefix, $statement);
- }
- /**
- * Check if a transaction is active
- *
- * @return bool
- * @since 8.2.0
- */
- public function inTransaction() {
- return $this->getTransactionNestingLevel() > 0;
- }
- /**
- * Escape a parameter to be used in a LIKE query
- *
- * @param string $param
- * @return string
- */
- public function escapeLikeParameter($param) {
- return addcslashes($param, '\\_%');
- }
- /**
- * Check whether or not the current database support 4byte wide unicode
- *
- * @return bool
- * @since 11.0.0
- */
- public function supports4ByteText() {
- if (!$this->getDatabasePlatform() instanceof MySQLPlatform) {
- return true;
- }
- return $this->getParams()['charset'] === 'utf8mb4';
- }
- /**
- * Create the schema of the connected database
- *
- * @return Schema
- * @throws Exception
- */
- public function createSchema() {
- $migrator = $this->getMigrator();
- return $migrator->createSchema();
- }
- /**
- * Migrate the database to the given schema
- *
- * @param Schema $toSchema
- * @param bool $dryRun If true, will return the sql queries instead of running them.
- *
- * @throws Exception
- *
- * @return string|null Returns a string only if $dryRun is true.
- */
- public function migrateToSchema(Schema $toSchema, bool $dryRun = false) {
- $migrator = $this->getMigrator();
- if ($dryRun) {
- return $migrator->generateChangeScript($toSchema);
- } else {
- $migrator->migrate($toSchema);
- foreach ($this->getShardConnections() as $shardConnection) {
- $shardConnection->migrateToSchema($toSchema);
- }
- }
- }
- private function getMigrator() {
- // TODO properly inject those dependencies
- $random = \OC::$server->get(ISecureRandom::class);
- $platform = $this->getDatabasePlatform();
- $config = \OC::$server->getConfig();
- $dispatcher = Server::get(\OCP\EventDispatcher\IEventDispatcher::class);
- if ($platform instanceof SqlitePlatform) {
- return new SQLiteMigrator($this, $config, $dispatcher);
- } elseif ($platform instanceof OraclePlatform) {
- return new OracleMigrator($this, $config, $dispatcher);
- } else {
- return new Migrator($this, $config, $dispatcher);
- }
- }
- public function beginTransaction() {
- if (!$this->inTransaction()) {
- $this->transactionBacktrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
- $this->transactionActiveSince = microtime(true);
- }
- return parent::beginTransaction();
- }
- public function commit() {
- $result = parent::commit();
- if ($this->getTransactionNestingLevel() === 0) {
- $timeTook = microtime(true) - $this->transactionActiveSince;
- $this->transactionBacktrace = null;
- $this->transactionActiveSince = null;
- if ($timeTook > 1) {
- $logLevel = match (true) {
- $timeTook > 20 * 60 => ILogger::ERROR,
- $timeTook > 5 * 60 => ILogger::WARN,
- $timeTook > 10 => ILogger::INFO,
- default => ILogger::DEBUG,
- };
- $this->logger->log(
- $logLevel,
- 'Transaction took ' . $timeTook . 's',
- [
- 'exception' => new \Exception('Transaction took ' . $timeTook . 's'),
- 'timeSpent' => $timeTook,
- ]
- );
- }
- }
- return $result;
- }
- public function rollBack() {
- $result = parent::rollBack();
- if ($this->getTransactionNestingLevel() === 0) {
- $timeTook = microtime(true) - $this->transactionActiveSince;
- $this->transactionBacktrace = null;
- $this->transactionActiveSince = null;
- if ($timeTook > 1) {
- $logLevel = match (true) {
- $timeTook > 20 * 60 => ILogger::ERROR,
- $timeTook > 5 * 60 => ILogger::WARN,
- $timeTook > 10 => ILogger::INFO,
- default => ILogger::DEBUG,
- };
- $this->logger->log(
- $logLevel,
- 'Transaction rollback took longer than 1s: ' . $timeTook,
- [
- 'exception' => new \Exception('Long running transaction rollback'),
- 'timeSpent' => $timeTook,
- ]
- );
- }
- }
- return $result;
- }
- private function reconnectIfNeeded(): void {
- if (
- !isset($this->lastConnectionCheck[$this->getConnectionName()]) ||
- time() <= $this->lastConnectionCheck[$this->getConnectionName()] + 30 ||
- $this->isTransactionActive()
- ) {
- return;
- }
- try {
- $this->_conn->query($this->getDriver()->getDatabasePlatform()->getDummySelectSQL());
- $this->lastConnectionCheck[$this->getConnectionName()] = time();
- } catch (ConnectionLost|\Exception $e) {
- $this->logger->warning('Exception during connectivity check, closing and reconnecting', ['exception' => $e]);
- $this->close();
- }
- }
- private function getConnectionName(): string {
- return $this->isConnectedToPrimary() ? 'primary' : 'replica';
- }
- /**
- * @return IDBConnection::PLATFORM_MYSQL|IDBConnection::PLATFORM_ORACLE|IDBConnection::PLATFORM_POSTGRES|IDBConnection::PLATFORM_SQLITE
- */
- public function getDatabaseProvider(): string {
- $platform = $this->getDatabasePlatform();
- if ($platform instanceof MySQLPlatform) {
- return IDBConnection::PLATFORM_MYSQL;
- } elseif ($platform instanceof OraclePlatform) {
- return IDBConnection::PLATFORM_ORACLE;
- } elseif ($platform instanceof PostgreSQLPlatform) {
- return IDBConnection::PLATFORM_POSTGRES;
- } elseif ($platform instanceof SqlitePlatform) {
- return IDBConnection::PLATFORM_SQLITE;
- } else {
- throw new \Exception('Database ' . $platform::class . ' not supported');
- }
- }
- /**
- * @internal Should only be used inside the QueryBuilder, ExpressionBuilder and FunctionBuilder
- * All apps and API code should not need this and instead use provided functionality from the above.
- */
- public function getServerVersion(): string {
- /** @var ServerInfoAwareConnection $this->_conn */
- return $this->_conn->getServerVersion();
- }
- /**
- * Log a database exception if enabled
- *
- * @param \Exception $exception
- * @return void
- */
- public function logDatabaseException(\Exception $exception): void {
- if ($this->logDbException) {
- if ($exception instanceof Exception\UniqueConstraintViolationException) {
- $this->logger->info($exception->getMessage(), ['exception' => $exception, 'transaction' => $this->transactionBacktrace]);
- } else {
- $this->logger->error($exception->getMessage(), ['exception' => $exception, 'transaction' => $this->transactionBacktrace]);
- }
- }
- }
- public function getShardDefinition(string $name): ?ShardDefinition {
- return $this->shards[$name] ?? null;
- }
- public function getCrossShardMoveHelper(): CrossShardMoveHelper {
- return new CrossShardMoveHelper($this->shardConnectionManager);
- }
- }
|