nextcloud / server

lib/public/IDBConnection.php

Indentation +291 added lines, -291 removed lines

@@ -51,295 +51,295 @@
  * @since 6.0.0
  */
 interface IDBConnection {
-	public const ADD_MISSING_INDEXES_EVENT = self::class . '::ADD_MISSING_INDEXES';
-	public const CHECK_MISSING_INDEXES_EVENT = self::class . '::CHECK_MISSING_INDEXES';
-	public const ADD_MISSING_PRIMARY_KEYS_EVENT = self::class . '::ADD_MISSING_PRIMARY_KEYS';
-	public const CHECK_MISSING_PRIMARY_KEYS_EVENT = self::class . '::CHECK_MISSING_PRIMARY_KEYS';
-	public const ADD_MISSING_COLUMNS_EVENT = self::class . '::ADD_MISSING_COLUMNS';
-	public const CHECK_MISSING_COLUMNS_EVENT = self::class . '::CHECK_MISSING_COLUMNS';
-
-	/**
-	 * Gets the QueryBuilder for the connection.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder
-	 * @since 8.2.0
-	 */
-	public function getQueryBuilder();
-
-	/**
-	 * Used to abstract the ownCloud database access away
-	 * @param string $sql the sql query with ? placeholder for params
-	 * @param int $limit the maximum number of rows
-	 * @param int $offset from which row we want to start
-	 * @return IPreparedStatement The prepared statement.
-	 * @since 6.0.0
-	 * @throws Exception since 21.0.0
-	 */
-	public function prepare($sql, $limit = null, $offset = null): IPreparedStatement;
-
-	/**
-	 * Executes an, optionally parameterized, SQL query.
-	 *
-	 * If the query is parameterized, a prepared statement is used.
-	 * If an SQLLogger is configured, the execution is logged.
-	 *
-	 * @param string $sql The SQL query to execute.
-	 * @param string[] $params The parameters to bind to the query, if any.
-	 * @param array $types The types the previous parameters are in.
-	 * @return IResult The executed statement.
-	 * @since 8.0.0
-	 * @throws Exception since 21.0.0
-	 */
-	public function executeQuery(string $sql, array $params = [], $types = []): IResult;
-
-	/**
-	 * 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.
-	 * @since 8.0.0
-	 * @throws Exception since 21.0.0
-	 *
-	 * @deprecated 21.0.0 use executeStatement
-	 */
-	public function executeUpdate(string $sql, array $params = [], array $types = []): int;
-
-	/**
-	 * 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.
-	 * @since 21.0.0
-	 * @throws Exception since 21.0.0
-	 */
-	public function executeStatement($sql, array $params = [], array $types = []): int;
-
-	/**
-	 * Used to get the id of the just inserted element
-	 * @param string $table the name of the table where we inserted the item
-	 * @return int the id of the inserted element
-	 * @since 6.0.0
-	 * @throws Exception since 21.0.0
-	 * @deprecated 21.0.0 use \OCP\DB\QueryBuilder\IQueryBuilder::getLastInsertId
-	 */
-	public function lastInsertId(string $table): int;
-
-	/**
-	 * 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 Exception used to be the removed dbal exception, since 21.0.0 it's \OCP\DB\Exception
-	 * @since 6.0.0 - parameter $compare was added in 8.1.0, return type changed from boolean in 8.1.0
-	 * @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(string $table, array $input, array $compare = null);
-
-
-	/**
-	 *
-	 * Insert a row if the row does not exist. Eventual conflicts during insert will be ignored.
-	 *
-	 * Implementation is not fully finished and should not be used!
-	 *
-	 * @param string $table The table name (will replace *PREFIX* with the actual prefix)
-	 * @param array $values data that should be inserted into the table  (column name => value)
-	 * @return int number of inserted rows
-	 * @since 16.0.0
-	 */
-	public function insertIgnoreConflict(string $table,array $values) : int;
-
-	/**
-	 * 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 Exception used to be the removed dbal exception, since 21.0.0 it's \OCP\DB\Exception
-	 * @throws PreconditionNotMetException
-	 * @since 9.0.0
-	 */
-	public function setValues($table, array $keys, array $values, array $updatePreconditionValues = []): int;
-
-	/**
-	 * Create an exclusive read+write lock on a table
-	 *
-	 * Important Note: Due to the nature how locks work on different DBs, it is
-	 * only possible to lock one table at a time. You should also NOT start a
-	 * transaction while holding a lock.
-	 *
-	 * @param string $tableName
-	 * @throws Exception since 21.0.0
-	 * @since 9.1.0
-	 */
-	public function lockTable($tableName): void;
-
-	/**
-	 * Release a previous acquired lock again
-	 *
-	 * @throws Exception since 21.0.0
-	 * @since 9.1.0
-	 */
-	public function unlockTable(): void;
-
-	/**
-	 * Start a transaction
-	 * @since 6.0.0
-	 * @throws Exception since 21.0.0
-	 */
-	public function beginTransaction(): void;
-
-	/**
-	 * Check if a transaction is active
-	 *
-	 * @return bool
-	 * @since 8.2.0
-	 */
-	public function inTransaction(): bool;
-
-	/**
-	 * Commit the database changes done during a transaction that is in progress
-	 * @since 6.0.0
-	 * @throws Exception since 21.0.0
-	 */
-	public function commit(): void;
-
-	/**
-	 * Rollback the database changes done during a transaction that is in progress
-	 * @since 6.0.0
-	 * @throws Exception since 21.0.0
-	 */
-	public function rollBack(): void;
-
-	/**
-	 * Gets the error code and message as a string for logging
-	 * @return string
-	 * @since 6.0.0
-	 * @deprecated 21.0.0 doesn't return anything meaningful
-	 */
-	public function getError(): string;
-
-	/**
-	 * Fetch the SQLSTATE associated with the last database operation.
-	 *
-	 * @return integer The last error code.
-	 * @since 8.0.0
-	 * @deprecated 21.0.0 doesn't return anything anymore
-	 */
-	public function errorCode();
-
-	/**
-	 * Fetch extended error information associated with the last database operation.
-	 *
-	 * @return array The last error information.
-	 * @since 8.0.0
-	 * @deprecated 21.0.0 doesn't return anything anymore
-	 */
-	public function errorInfo();
-
-	/**
-	 * Establishes the connection with the database.
-	 *
-	 * @return bool
-	 * @throws Exception since 21.0.0
-	 * @since 8.0.0
-	 */
-	public function connect(): bool;
-
-	/**
-	 * Close the database connection
-	 * @since 8.0.0
-	 */
-	public function close(): void;
-
-	/**
-	 * Quotes a given input parameter.
-	 *
-	 * @param mixed $input Parameter to be quoted.
-	 * @param int $type Type of the parameter.
-	 * @return mixed The quoted parameter.
-	 * @since 8.0.0
-	 */
-	public function quote($input, $type = IQueryBuilder::PARAM_STR);
-
-	/**
-	 * Gets the DatabasePlatform instance that provides all the metadata about
-	 * the platform this driver connects to.
-	 *
-	 * @return \Doctrine\DBAL\Platforms\AbstractPlatform The database platform.
-	 * @since 8.0.0
-	 */
-	public function getDatabasePlatform();
-
-	/**
-	 * Drop a table from the database if it exists
-	 *
-	 * @param string $table table name without the prefix
-	 * @throws Exception since 21.0.0
-	 * @since 8.0.0
-	 */
-	public function dropTable(string $table): void;
-
-	/**
-	 * Check if a table exists
-	 *
-	 * @param string $table table name without the prefix
-	 * @return bool
-	 * @throws Exception since 21.0.0
-	 * @since 8.0.0
-	 */
-	public function tableExists(string $table): bool;
-
-	/**
-	 * Escape a parameter to be used in a LIKE query
-	 *
-	 * @param string $param
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function escapeLikeParameter(string $param): string;
-
-	/**
-	 * Check whether or not the current database support 4byte wide unicode
-	 *
-	 * @return bool
-	 * @since 11.0.0
-	 */
-	public function supports4ByteText(): bool;
-
-	/**
-	 * Create the schema of the connected database
-	 *
-	 * @return Schema
-	 * @throws Exception since 21.0.0
-	 * @since 13.0.0
-	 */
-	public function createSchema(): Schema;
-
-	/**
-	 * Migrate the database to the given schema
-	 *
-	 * @param Schema $toSchema
-	 * @throws Exception since 21.0.0
-	 * @since 13.0.0
-	 */
-	public function migrateToSchema(Schema $toSchema): void;
+    public const ADD_MISSING_INDEXES_EVENT = self::class . '::ADD_MISSING_INDEXES';
+    public const CHECK_MISSING_INDEXES_EVENT = self::class . '::CHECK_MISSING_INDEXES';
+    public const ADD_MISSING_PRIMARY_KEYS_EVENT = self::class . '::ADD_MISSING_PRIMARY_KEYS';
+    public const CHECK_MISSING_PRIMARY_KEYS_EVENT = self::class . '::CHECK_MISSING_PRIMARY_KEYS';
+    public const ADD_MISSING_COLUMNS_EVENT = self::class . '::ADD_MISSING_COLUMNS';
+    public const CHECK_MISSING_COLUMNS_EVENT = self::class . '::CHECK_MISSING_COLUMNS';
+
+    /**
+     * Gets the QueryBuilder for the connection.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder
+     * @since 8.2.0
+     */
+    public function getQueryBuilder();
+
+    /**
+     * Used to abstract the ownCloud database access away
+     * @param string $sql the sql query with ? placeholder for params
+     * @param int $limit the maximum number of rows
+     * @param int $offset from which row we want to start
+     * @return IPreparedStatement The prepared statement.
+     * @since 6.0.0
+     * @throws Exception since 21.0.0
+     */
+    public function prepare($sql, $limit = null, $offset = null): IPreparedStatement;
+
+    /**
+     * Executes an, optionally parameterized, SQL query.
+     *
+     * If the query is parameterized, a prepared statement is used.
+     * If an SQLLogger is configured, the execution is logged.
+     *
+     * @param string $sql The SQL query to execute.
+     * @param string[] $params The parameters to bind to the query, if any.
+     * @param array $types The types the previous parameters are in.
+     * @return IResult The executed statement.
+     * @since 8.0.0
+     * @throws Exception since 21.0.0
+     */
+    public function executeQuery(string $sql, array $params = [], $types = []): IResult;
+
+    /**
+     * 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.
+     * @since 8.0.0
+     * @throws Exception since 21.0.0
+     *
+     * @deprecated 21.0.0 use executeStatement
+     */
+    public function executeUpdate(string $sql, array $params = [], array $types = []): int;
+
+    /**
+     * 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.
+     * @since 21.0.0
+     * @throws Exception since 21.0.0
+     */
+    public function executeStatement($sql, array $params = [], array $types = []): int;
+
+    /**
+     * Used to get the id of the just inserted element
+     * @param string $table the name of the table where we inserted the item
+     * @return int the id of the inserted element
+     * @since 6.0.0
+     * @throws Exception since 21.0.0
+     * @deprecated 21.0.0 use \OCP\DB\QueryBuilder\IQueryBuilder::getLastInsertId
+     */
+    public function lastInsertId(string $table): int;
+
+    /**
+     * 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 Exception used to be the removed dbal exception, since 21.0.0 it's \OCP\DB\Exception
+     * @since 6.0.0 - parameter $compare was added in 8.1.0, return type changed from boolean in 8.1.0
+     * @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(string $table, array $input, array $compare = null);
+
+
+    /**
+     *
+     * Insert a row if the row does not exist. Eventual conflicts during insert will be ignored.
+     *
+     * Implementation is not fully finished and should not be used!
+     *
+     * @param string $table The table name (will replace *PREFIX* with the actual prefix)
+     * @param array $values data that should be inserted into the table  (column name => value)
+     * @return int number of inserted rows
+     * @since 16.0.0
+     */
+    public function insertIgnoreConflict(string $table,array $values) : int;
+
+    /**
+     * 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 Exception used to be the removed dbal exception, since 21.0.0 it's \OCP\DB\Exception
+     * @throws PreconditionNotMetException
+     * @since 9.0.0
+     */
+    public function setValues($table, array $keys, array $values, array $updatePreconditionValues = []): int;
+
+    /**
+     * Create an exclusive read+write lock on a table
+     *
+     * Important Note: Due to the nature how locks work on different DBs, it is
+     * only possible to lock one table at a time. You should also NOT start a
+     * transaction while holding a lock.
+     *
+     * @param string $tableName
+     * @throws Exception since 21.0.0
+     * @since 9.1.0
+     */
+    public function lockTable($tableName): void;
+
+    /**
+     * Release a previous acquired lock again
+     *
+     * @throws Exception since 21.0.0
+     * @since 9.1.0
+     */
+    public function unlockTable(): void;
+
+    /**
+     * Start a transaction
+     * @since 6.0.0
+     * @throws Exception since 21.0.0
+     */
+    public function beginTransaction(): void;
+
+    /**
+     * Check if a transaction is active
+     *
+     * @return bool
+     * @since 8.2.0
+     */
+    public function inTransaction(): bool;
+
+    /**
+     * Commit the database changes done during a transaction that is in progress
+     * @since 6.0.0
+     * @throws Exception since 21.0.0
+     */
+    public function commit(): void;
+
+    /**
+     * Rollback the database changes done during a transaction that is in progress
+     * @since 6.0.0
+     * @throws Exception since 21.0.0
+     */
+    public function rollBack(): void;
+
+    /**
+     * Gets the error code and message as a string for logging
+     * @return string
+     * @since 6.0.0
+     * @deprecated 21.0.0 doesn't return anything meaningful
+     */
+    public function getError(): string;
+
+    /**
+     * Fetch the SQLSTATE associated with the last database operation.
+     *
+     * @return integer The last error code.
+     * @since 8.0.0
+     * @deprecated 21.0.0 doesn't return anything anymore
+     */
+    public function errorCode();
+
+    /**
+     * Fetch extended error information associated with the last database operation.
+     *
+     * @return array The last error information.
+     * @since 8.0.0
+     * @deprecated 21.0.0 doesn't return anything anymore
+     */
+    public function errorInfo();
+
+    /**
+     * Establishes the connection with the database.
+     *
+     * @return bool
+     * @throws Exception since 21.0.0
+     * @since 8.0.0
+     */
+    public function connect(): bool;
+
+    /**
+     * Close the database connection
+     * @since 8.0.0
+     */
+    public function close(): void;
+
+    /**
+     * Quotes a given input parameter.
+     *
+     * @param mixed $input Parameter to be quoted.
+     * @param int $type Type of the parameter.
+     * @return mixed The quoted parameter.
+     * @since 8.0.0
+     */
+    public function quote($input, $type = IQueryBuilder::PARAM_STR);
+
+    /**
+     * Gets the DatabasePlatform instance that provides all the metadata about
+     * the platform this driver connects to.
+     *
+     * @return \Doctrine\DBAL\Platforms\AbstractPlatform The database platform.
+     * @since 8.0.0
+     */
+    public function getDatabasePlatform();
+
+    /**
+     * Drop a table from the database if it exists
+     *
+     * @param string $table table name without the prefix
+     * @throws Exception since 21.0.0
+     * @since 8.0.0
+     */
+    public function dropTable(string $table): void;
+
+    /**
+     * Check if a table exists
+     *
+     * @param string $table table name without the prefix
+     * @return bool
+     * @throws Exception since 21.0.0
+     * @since 8.0.0
+     */
+    public function tableExists(string $table): bool;
+
+    /**
+     * Escape a parameter to be used in a LIKE query
+     *
+     * @param string $param
+     * @return string
+     * @since 9.0.0
+     */
+    public function escapeLikeParameter(string $param): string;
+
+    /**
+     * Check whether or not the current database support 4byte wide unicode
+     *
+     * @return bool
+     * @since 11.0.0
+     */
+    public function supports4ByteText(): bool;
+
+    /**
+     * Create the schema of the connected database
+     *
+     * @return Schema
+     * @throws Exception since 21.0.0
+     * @since 13.0.0
+     */
+    public function createSchema(): Schema;
+
+    /**
+     * Migrate the database to the given schema
+     *
+     * @param Schema $toSchema
+     * @throws Exception since 21.0.0
+     * @since 13.0.0
+     */
+    public function migrateToSchema(Schema $toSchema): void;
 }

lib/public/DB/QueryBuilder/IQueryBuilder.php

Indentation +872 added lines, -872 removed lines

@@ -38,876 +38,876 @@
  */
 interface IQueryBuilder {
 
-	/**
-	 * @since 9.0.0
-	 */
-	public const PARAM_NULL = \PDO::PARAM_NULL;
-	/**
-	 * @since 9.0.0
-	 */
-	public const PARAM_BOOL = \PDO::PARAM_BOOL;
-	/**
-	 * @since 9.0.0
-	 */
-	public const PARAM_INT = \PDO::PARAM_INT;
-	/**
-	 * @since 9.0.0
-	 */
-	public const PARAM_STR = \PDO::PARAM_STR;
-	/**
-	 * @since 9.0.0
-	 */
-	public const PARAM_LOB = \PDO::PARAM_LOB;
-	/**
-	 * @since 9.0.0
-	 */
-	public const PARAM_DATE = 'datetime';
-
-	/**
-	 * @since 9.0.0
-	 */
-	public const PARAM_INT_ARRAY = Connection::PARAM_INT_ARRAY;
-	/**
-	 * @since 9.0.0
-	 */
-	public const PARAM_STR_ARRAY = Connection::PARAM_STR_ARRAY;
-
-
-	/**
-	 * Enable/disable automatic prefixing of table names with the oc_ prefix
-	 *
-	 * @param bool $enabled If set to true table names will be prefixed with the
-	 * owncloud database prefix automatically.
-	 * @since 8.2.0
-	 */
-	public function automaticTablePrefix($enabled);
-
-	/**
-	 * Gets an ExpressionBuilder used for object-oriented construction of query expressions.
-	 * This producer method is intended for convenient inline usage. Example:
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u')
-	 *         ->from('users', 'u')
-	 *         ->where($qb->expr()->eq('u.id', 1));
-	 * </code>
-	 *
-	 * For more complex expression construction, consider storing the expression
-	 * builder object in a local variable.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IExpressionBuilder
-	 * @since 8.2.0
-	 */
-	public function expr();
-
-	/**
-	 * Gets an FunctionBuilder used for object-oriented construction of query functions.
-	 * This producer method is intended for convenient inline usage. Example:
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u')
-	 *         ->from('users', 'u')
-	 *         ->where($qb->fun()->md5('u.id'));
-	 * </code>
-	 *
-	 * For more complex function construction, consider storing the function
-	 * builder object in a local variable.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IFunctionBuilder
-	 * @since 12.0.0
-	 */
-	public function func();
-
-	/**
-	 * Gets the type of the currently built query.
-	 *
-	 * @return integer
-	 * @since 8.2.0
-	 */
-	public function getType();
-
-	/**
-	 * Gets the associated DBAL Connection for this query builder.
-	 *
-	 * @return \OCP\IDBConnection
-	 * @since 8.2.0
-	 */
-	public function getConnection();
-
-	/**
-	 * Gets the state of this query builder instance.
-	 *
-	 * @return integer Either QueryBuilder::STATE_DIRTY or QueryBuilder::STATE_CLEAN.
-	 * @since 8.2.0
-	 */
-	public function getState();
-
-	/**
-	 * Executes this query using the bound parameters and their types.
-	 *
-	 * Uses {@see Connection::executeQuery} for select statements and {@see Connection::executeUpdate}
-	 * for insert, update and delete statements.
-	 *
-	 * Warning: until Nextcloud 20, this method could return a \Doctrine\DBAL\Driver\Statement but since
-	 *          that interface changed in a breaking way the adapter \OCP\DB\QueryBuilder\IStatement is returned
-	 *          to bridge old code to the new API
-	 *
-	 * @return IResult|int
-	 * @throws Exception since 21.0.0
-	 * @since 8.2.0
-	 */
-	public function execute();
-
-	/**
-	 * Gets the complete SQL string formed by the current specifications of this QueryBuilder.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u')
-	 *         ->from('User', 'u')
-	 *     echo $qb->getSQL(); // SELECT u FROM User u
-	 * </code>
-	 *
-	 * @return string The SQL query string.
-	 * @since 8.2.0
-	 */
-	public function getSQL();
-
-	/**
-	 * Sets a query parameter for the query being constructed.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u')
-	 *         ->from('users', 'u')
-	 *         ->where('u.id = :user_id')
-	 *         ->setParameter(':user_id', 1);
-	 * </code>
-	 *
-	 * @param string|integer $key The parameter position or name.
-	 * @param mixed $value The parameter value.
-	 * @param string|null|int $type One of the IQueryBuilder::PARAM_* constants.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function setParameter($key, $value, $type = null);
-
-	/**
-	 * Sets a collection of query parameters for the query being constructed.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u')
-	 *         ->from('users', 'u')
-	 *         ->where('u.id = :user_id1 OR u.id = :user_id2')
-	 *         ->setParameters(array(
-	 *             ':user_id1' => 1,
-	 *             ':user_id2' => 2
-	 *         ));
-	 * </code>
-	 *
-	 * @param array $params The query parameters to set.
-	 * @param array $types The query parameters types to set.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function setParameters(array $params, array $types = []);
-
-	/**
-	 * Gets all defined query parameters for the query being constructed indexed by parameter index or name.
-	 *
-	 * @return array The currently defined query parameters indexed by parameter index or name.
-	 * @since 8.2.0
-	 */
-	public function getParameters();
-
-	/**
-	 * Gets a (previously set) query parameter of the query being constructed.
-	 *
-	 * @param mixed $key The key (index or name) of the bound parameter.
-	 *
-	 * @return mixed The value of the bound parameter.
-	 * @since 8.2.0
-	 */
-	public function getParameter($key);
-
-	/**
-	 * Gets all defined query parameter types for the query being constructed indexed by parameter index or name.
-	 *
-	 * @return array The currently defined query parameter types indexed by parameter index or name.
-	 * @since 8.2.0
-	 */
-	public function getParameterTypes();
-
-	/**
-	 * Gets a (previously set) query parameter type of the query being constructed.
-	 *
-	 * @param mixed $key The key (index or name) of the bound parameter type.
-	 *
-	 * @return mixed The value of the bound parameter type.
-	 * @since 8.2.0
-	 */
-	public function getParameterType($key);
-
-	/**
-	 * Sets the position of the first result to retrieve (the "offset").
-	 *
-	 * @param integer $firstResult The first result to return.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function setFirstResult($firstResult);
-
-	/**
-	 * Gets the position of the first result the query object was set to retrieve (the "offset").
-	 * Returns NULL if {@link setFirstResult} was not applied to this QueryBuilder.
-	 *
-	 * @return integer The position of the first result.
-	 * @since 8.2.0
-	 */
-	public function getFirstResult();
-
-	/**
-	 * Sets the maximum number of results to retrieve (the "limit").
-	 *
-	 * @param integer $maxResults The maximum number of results to retrieve.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function setMaxResults($maxResults);
-
-	/**
-	 * Gets the maximum number of results the query object was set to retrieve (the "limit").
-	 * Returns NULL if {@link setMaxResults} was not applied to this query builder.
-	 *
-	 * @return int|null The maximum number of results.
-	 * @since 8.2.0
-	 */
-	public function getMaxResults();
-
-	/**
-	 * Specifies an item that is to be returned in the query result.
-	 * Replaces any previously specified selections, if any.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.id', 'p.id')
-	 *         ->from('users', 'u')
-	 *         ->leftJoin('u', 'phonenumbers', 'p', 'u.id = p.user_id');
-	 * </code>
-	 *
-	 * @param mixed ...$selects The selection expressions.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function select(...$selects);
-
-	/**
-	 * Specifies an item that is to be returned with a different name in the query result.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->selectAlias('u.id', 'user_id')
-	 *         ->from('users', 'u')
-	 *         ->leftJoin('u', 'phonenumbers', 'p', 'u.id = p.user_id');
-	 * </code>
-	 *
-	 * @param mixed $select The selection expressions.
-	 * @param string $alias The column alias used in the constructed query.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.1
-	 */
-	public function selectAlias($select, $alias);
-
-	/**
-	 * Specifies an item that is to be returned uniquely in the query result.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->selectDistinct('type')
-	 *         ->from('users');
-	 * </code>
-	 *
-	 * @param mixed $select The selection expressions.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 9.0.0
-	 */
-	public function selectDistinct($select);
-
-	/**
-	 * Adds an item that is to be returned in the query result.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.id')
-	 *         ->addSelect('p.id')
-	 *         ->from('users', 'u')
-	 *         ->leftJoin('u', 'phonenumbers', 'u.id = p.user_id');
-	 * </code>
-	 *
-	 * @param mixed ...$select The selection expression.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function addSelect(...$select);
-
-	/**
-	 * Turns the query being built into a bulk delete query that ranges over
-	 * a certain table.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->delete('users', 'u')
-	 *         ->where('u.id = :user_id');
-	 *         ->setParameter(':user_id', 1);
-	 * </code>
-	 *
-	 * @param string $delete The table whose rows are subject to the deletion.
-	 * @param string $alias The table alias used in the constructed query.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function delete($delete = null, $alias = null);
-
-	/**
-	 * Turns the query being built into a bulk update query that ranges over
-	 * a certain table
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->update('users', 'u')
-	 *         ->set('u.password', md5('password'))
-	 *         ->where('u.id = ?');
-	 * </code>
-	 *
-	 * @param string $update The table whose rows are subject to the update.
-	 * @param string $alias The table alias used in the constructed query.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function update($update = null, $alias = null);
-
-	/**
-	 * Turns the query being built into an insert query that inserts into
-	 * a certain table
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->insert('users')
-	 *         ->values(
-	 *             array(
-	 *                 'name' => '?',
-	 *                 'password' => '?'
-	 *             )
-	 *         );
-	 * </code>
-	 *
-	 * @param string $insert The table into which the rows should be inserted.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function insert($insert = null);
-
-	/**
-	 * Creates and adds a query root corresponding to the table identified by the
-	 * given alias, forming a cartesian product with any existing query roots.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.id')
-	 *         ->from('users', 'u')
-	 * </code>
-	 *
-	 * @param string $from The table.
-	 * @param string|null $alias The alias of the table.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function from($from, $alias = null);
-
-	/**
-	 * Creates and adds a join to the query.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.name')
-	 *         ->from('users', 'u')
-	 *         ->join('u', 'phonenumbers', 'p', 'p.is_primary = 1');
-	 * </code>
-	 *
-	 * @param string $fromAlias The alias that points to a from clause.
-	 * @param string $join The table name to join.
-	 * @param string $alias The alias of the join table.
-	 * @param string $condition The condition for the join.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function join($fromAlias, $join, $alias, $condition = null);
-
-	/**
-	 * Creates and adds a join to the query.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.name')
-	 *         ->from('users', 'u')
-	 *         ->innerJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');
-	 * </code>
-	 *
-	 * @param string $fromAlias The alias that points to a from clause.
-	 * @param string $join The table name to join.
-	 * @param string $alias The alias of the join table.
-	 * @param string $condition The condition for the join.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function innerJoin($fromAlias, $join, $alias, $condition = null);
-
-	/**
-	 * Creates and adds a left join to the query.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.name')
-	 *         ->from('users', 'u')
-	 *         ->leftJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');
-	 * </code>
-	 *
-	 * @param string $fromAlias The alias that points to a from clause.
-	 * @param string $join The table name to join.
-	 * @param string $alias The alias of the join table.
-	 * @param string $condition The condition for the join.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function leftJoin($fromAlias, $join, $alias, $condition = null);
-
-	/**
-	 * Creates and adds a right join to the query.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.name')
-	 *         ->from('users', 'u')
-	 *         ->rightJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');
-	 * </code>
-	 *
-	 * @param string $fromAlias The alias that points to a from clause.
-	 * @param string $join The table name to join.
-	 * @param string $alias The alias of the join table.
-	 * @param string $condition The condition for the join.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function rightJoin($fromAlias, $join, $alias, $condition = null);
-
-	/**
-	 * Sets a new value for a column in a bulk update query.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->update('users', 'u')
-	 *         ->set('u.password', md5('password'))
-	 *         ->where('u.id = ?');
-	 * </code>
-	 *
-	 * @param string $key The column to set.
-	 * @param ILiteral|IParameter|IQueryFunction|string $value The value, expression, placeholder, etc.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function set($key, $value);
-
-	/**
-	 * Specifies one or more restrictions to the query result.
-	 * Replaces any previously specified restrictions, if any.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.name')
-	 *         ->from('users', 'u')
-	 *         ->where('u.id = ?');
-	 *
-	 *     // You can optionally programatically build and/or expressions
-	 *     $qb = $conn->getQueryBuilder();
-	 *
-	 *     $or = $qb->expr()->orx();
-	 *     $or->add($qb->expr()->eq('u.id', 1));
-	 *     $or->add($qb->expr()->eq('u.id', 2));
-	 *
-	 *     $qb->update('users', 'u')
-	 *         ->set('u.password', md5('password'))
-	 *         ->where($or);
-	 * </code>
-	 *
-	 * @param mixed $predicates The restriction predicates.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function where(...$predicates);
-
-	/**
-	 * Adds one or more restrictions to the query results, forming a logical
-	 * conjunction with any previously specified restrictions.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u')
-	 *         ->from('users', 'u')
-	 *         ->where('u.username LIKE ?')
-	 *         ->andWhere('u.is_active = 1');
-	 * </code>
-	 *
-	 * @param mixed ...$where The query restrictions.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 *
-	 * @see where()
-	 * @since 8.2.0
-	 */
-	public function andWhere(...$where);
-
-	/**
-	 * Adds one or more restrictions to the query results, forming a logical
-	 * disjunction with any previously specified restrictions.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.name')
-	 *         ->from('users', 'u')
-	 *         ->where('u.id = 1')
-	 *         ->orWhere('u.id = 2');
-	 * </code>
-	 *
-	 * @param mixed ...$where The WHERE statement.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 *
-	 * @see where()
-	 * @since 8.2.0
-	 */
-	public function orWhere(...$where);
-
-	/**
-	 * Specifies a grouping over the results of the query.
-	 * Replaces any previously specified groupings, if any.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.name')
-	 *         ->from('users', 'u')
-	 *         ->groupBy('u.id');
-	 * </code>
-	 *
-	 * @param mixed ...$groupBys The grouping expression.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function groupBy(...$groupBys);
-
-	/**
-	 * Adds a grouping expression to the query.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.name')
-	 *         ->from('users', 'u')
-	 *         ->groupBy('u.lastLogin');
-	 *         ->addGroupBy('u.createdAt')
-	 * </code>
-	 *
-	 * @param mixed ...$groupBy The grouping expression.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function addGroupBy(...$groupBy);
-
-	/**
-	 * Sets a value for a column in an insert query.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->insert('users')
-	 *         ->values(
-	 *             array(
-	 *                 'name' => '?'
-	 *             )
-	 *         )
-	 *         ->setValue('password', '?');
-	 * </code>
-	 *
-	 * @param string $column The column into which the value should be inserted.
-	 * @param IParameter|string $value The value that should be inserted into the column.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function setValue($column, $value);
-
-	/**
-	 * Specifies values for an insert query indexed by column names.
-	 * Replaces any previous values, if any.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->insert('users')
-	 *         ->values(
-	 *             array(
-	 *                 'name' => '?',
-	 *                 'password' => '?'
-	 *             )
-	 *         );
-	 * </code>
-	 *
-	 * @param array $values The values to specify for the insert query indexed by column names.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function values(array $values);
-
-	/**
-	 * Specifies a restriction over the groups of the query.
-	 * Replaces any previous having restrictions, if any.
-	 *
-	 * @param mixed ...$having The restriction over the groups.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function having(...$having);
-
-	/**
-	 * Adds a restriction over the groups of the query, forming a logical
-	 * conjunction with any existing having restrictions.
-	 *
-	 * @param mixed ...$having The restriction to append.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function andHaving(...$having);
-
-	/**
-	 * Adds a restriction over the groups of the query, forming a logical
-	 * disjunction with any existing having restrictions.
-	 *
-	 * @param mixed ...$having The restriction to add.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function orHaving(...$having);
-
-	/**
-	 * Specifies an ordering for the query results.
-	 * Replaces any previously specified orderings, if any.
-	 *
-	 * @param string $sort The ordering expression.
-	 * @param string $order The ordering direction.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function orderBy($sort, $order = null);
-
-	/**
-	 * Adds an ordering to the query results.
-	 *
-	 * @param string $sort The ordering expression.
-	 * @param string $order The ordering direction.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function addOrderBy($sort, $order = null);
-
-	/**
-	 * Gets a query part by its name.
-	 *
-	 * @param string $queryPartName
-	 *
-	 * @return mixed
-	 * @since 8.2.0
-	 */
-	public function getQueryPart($queryPartName);
-
-	/**
-	 * Gets all query parts.
-	 *
-	 * @return array
-	 * @since 8.2.0
-	 */
-	public function getQueryParts();
-
-	/**
-	 * Resets SQL parts.
-	 *
-	 * @param array|null $queryPartNames
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function resetQueryParts($queryPartNames = null);
-
-	/**
-	 * Resets a single SQL part.
-	 *
-	 * @param string $queryPartName
-	 *
-	 * @return $this This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function resetQueryPart($queryPartName);
-
-	/**
-	 * Creates a new named parameter and bind the value $value to it.
-	 *
-	 * This method provides a shortcut for PDOStatement::bindValue
-	 * when using prepared statements.
-	 *
-	 * The parameter $value specifies the value that you want to bind. If
-	 * $placeholder is not provided bindValue() will automatically create a
-	 * placeholder for you. An automatic placeholder will be of the name
-	 * ':dcValue1', ':dcValue2' etc.
-	 *
-	 * For more information see {@link https://www.php.net/pdostatement-bindparam}
-	 *
-	 * Example:
-	 * <code>
-	 * $value = 2;
-	 * $q->eq( 'id', $q->bindValue( $value ) );
-	 * $stmt = $q->executeQuery(); // executed with 'id = 2'
-	 * </code>
-	 *
-	 * @license New BSD License
-	 * @link http://www.zetacomponents.org
-	 *
-	 * @param mixed $value
-	 * @param mixed $type
-	 * @param string $placeHolder The name to bind with. The string must start with a colon ':'.
-	 *
-	 * @return IParameter
-	 * @since 8.2.0
-	 */
-	public function createNamedParameter($value, $type = self::PARAM_STR, $placeHolder = null);
-
-	/**
-	 * Creates a new positional parameter and bind the given value to it.
-	 *
-	 * Attention: If you are using positional parameters with the query builder you have
-	 * to be very careful to bind all parameters in the order they appear in the SQL
-	 * statement , otherwise they get bound in the wrong order which can lead to serious
-	 * bugs in your code.
-	 *
-	 * Example:
-	 * <code>
-	 *  $qb = $conn->getQueryBuilder();
-	 *  $qb->select('u.*')
-	 *     ->from('users', 'u')
-	 *     ->where('u.username = ' . $qb->createPositionalParameter('Foo', IQueryBuilder::PARAM_STR))
-	 *     ->orWhere('u.username = ' . $qb->createPositionalParameter('Bar', IQueryBuilder::PARAM_STR))
-	 * </code>
-	 *
-	 * @param mixed $value
-	 * @param integer $type
-	 *
-	 * @return IParameter
-	 * @since 8.2.0
-	 */
-	public function createPositionalParameter($value, $type = self::PARAM_STR);
-
-	/**
-	 * Creates a new parameter
-	 *
-	 * Example:
-	 * <code>
-	 *  $qb = $conn->getQueryBuilder();
-	 *  $qb->select('u.*')
-	 *     ->from('users', 'u')
-	 *     ->where('u.username = ' . $qb->createParameter('name'))
-	 *     ->setParameter('name', 'Bar', IQueryBuilder::PARAM_STR))
-	 * </code>
-	 *
-	 * @param string $name
-	 *
-	 * @return IParameter
-	 * @since 8.2.0
-	 */
-	public function createParameter($name);
-
-	/**
-	 * Creates a new function
-	 *
-	 * Attention: Column names inside the call have to be quoted before hand
-	 *
-	 * Example:
-	 * <code>
-	 *  $qb = $conn->getQueryBuilder();
-	 *  $qb->select($qb->createFunction('COUNT(*)'))
-	 *     ->from('users', 'u')
-	 *  echo $qb->getSQL(); // SELECT COUNT(*) FROM `users` u
-	 * </code>
-	 * <code>
-	 *  $qb = $conn->getQueryBuilder();
-	 *  $qb->select($qb->createFunction('COUNT(`column`)'))
-	 *     ->from('users', 'u')
-	 *  echo $qb->getSQL(); // SELECT COUNT(`column`) FROM `users` u
-	 * </code>
-	 *
-	 * @param string $call
-	 *
-	 * @return IQueryFunction
-	 * @since 8.2.0
-	 */
-	public function createFunction($call);
-
-	/**
-	 * Used to get the id of the last inserted element
-	 * @return int
-	 * @throws \BadMethodCallException When being called before an insert query has been run.
-	 * @since 9.0.0
-	 */
-	public function getLastInsertId();
-
-	/**
-	 * Returns the table name quoted and with database prefix as needed by the implementation
-	 *
-	 * @param string $table
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getTableName($table);
-
-	/**
-	 * Returns the column name quoted and with table alias prefix as needed by the implementation
-	 *
-	 * @param string $column
-	 * @param string $tableAlias
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getColumnName($column, $tableAlias = '');
+    /**
+     * @since 9.0.0
+     */
+    public const PARAM_NULL = \PDO::PARAM_NULL;
+    /**
+     * @since 9.0.0
+     */
+    public const PARAM_BOOL = \PDO::PARAM_BOOL;
+    /**
+     * @since 9.0.0
+     */
+    public const PARAM_INT = \PDO::PARAM_INT;
+    /**
+     * @since 9.0.0
+     */
+    public const PARAM_STR = \PDO::PARAM_STR;
+    /**
+     * @since 9.0.0
+     */
+    public const PARAM_LOB = \PDO::PARAM_LOB;
+    /**
+     * @since 9.0.0
+     */
+    public const PARAM_DATE = 'datetime';
+
+    /**
+     * @since 9.0.0
+     */
+    public const PARAM_INT_ARRAY = Connection::PARAM_INT_ARRAY;
+    /**
+     * @since 9.0.0
+     */
+    public const PARAM_STR_ARRAY = Connection::PARAM_STR_ARRAY;
+
+
+    /**
+     * Enable/disable automatic prefixing of table names with the oc_ prefix
+     *
+     * @param bool $enabled If set to true table names will be prefixed with the
+     * owncloud database prefix automatically.
+     * @since 8.2.0
+     */
+    public function automaticTablePrefix($enabled);
+
+    /**
+     * Gets an ExpressionBuilder used for object-oriented construction of query expressions.
+     * This producer method is intended for convenient inline usage. Example:
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u')
+     *         ->from('users', 'u')
+     *         ->where($qb->expr()->eq('u.id', 1));
+     * </code>
+     *
+     * For more complex expression construction, consider storing the expression
+     * builder object in a local variable.
+     *
+     * @return \OCP\DB\QueryBuilder\IExpressionBuilder
+     * @since 8.2.0
+     */
+    public function expr();
+
+    /**
+     * Gets an FunctionBuilder used for object-oriented construction of query functions.
+     * This producer method is intended for convenient inline usage. Example:
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u')
+     *         ->from('users', 'u')
+     *         ->where($qb->fun()->md5('u.id'));
+     * </code>
+     *
+     * For more complex function construction, consider storing the function
+     * builder object in a local variable.
+     *
+     * @return \OCP\DB\QueryBuilder\IFunctionBuilder
+     * @since 12.0.0
+     */
+    public function func();
+
+    /**
+     * Gets the type of the currently built query.
+     *
+     * @return integer
+     * @since 8.2.0
+     */
+    public function getType();
+
+    /**
+     * Gets the associated DBAL Connection for this query builder.
+     *
+     * @return \OCP\IDBConnection
+     * @since 8.2.0
+     */
+    public function getConnection();
+
+    /**
+     * Gets the state of this query builder instance.
+     *
+     * @return integer Either QueryBuilder::STATE_DIRTY or QueryBuilder::STATE_CLEAN.
+     * @since 8.2.0
+     */
+    public function getState();
+
+    /**
+     * Executes this query using the bound parameters and their types.
+     *
+     * Uses {@see Connection::executeQuery} for select statements and {@see Connection::executeUpdate}
+     * for insert, update and delete statements.
+     *
+     * Warning: until Nextcloud 20, this method could return a \Doctrine\DBAL\Driver\Statement but since
+     *          that interface changed in a breaking way the adapter \OCP\DB\QueryBuilder\IStatement is returned
+     *          to bridge old code to the new API
+     *
+     * @return IResult|int
+     * @throws Exception since 21.0.0
+     * @since 8.2.0
+     */
+    public function execute();
+
+    /**
+     * Gets the complete SQL string formed by the current specifications of this QueryBuilder.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u')
+     *         ->from('User', 'u')
+     *     echo $qb->getSQL(); // SELECT u FROM User u
+     * </code>
+     *
+     * @return string The SQL query string.
+     * @since 8.2.0
+     */
+    public function getSQL();
+
+    /**
+     * Sets a query parameter for the query being constructed.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u')
+     *         ->from('users', 'u')
+     *         ->where('u.id = :user_id')
+     *         ->setParameter(':user_id', 1);
+     * </code>
+     *
+     * @param string|integer $key The parameter position or name.
+     * @param mixed $value The parameter value.
+     * @param string|null|int $type One of the IQueryBuilder::PARAM_* constants.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function setParameter($key, $value, $type = null);
+
+    /**
+     * Sets a collection of query parameters for the query being constructed.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u')
+     *         ->from('users', 'u')
+     *         ->where('u.id = :user_id1 OR u.id = :user_id2')
+     *         ->setParameters(array(
+     *             ':user_id1' => 1,
+     *             ':user_id2' => 2
+     *         ));
+     * </code>
+     *
+     * @param array $params The query parameters to set.
+     * @param array $types The query parameters types to set.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function setParameters(array $params, array $types = []);
+
+    /**
+     * Gets all defined query parameters for the query being constructed indexed by parameter index or name.
+     *
+     * @return array The currently defined query parameters indexed by parameter index or name.
+     * @since 8.2.0
+     */
+    public function getParameters();
+
+    /**
+     * Gets a (previously set) query parameter of the query being constructed.
+     *
+     * @param mixed $key The key (index or name) of the bound parameter.
+     *
+     * @return mixed The value of the bound parameter.
+     * @since 8.2.0
+     */
+    public function getParameter($key);
+
+    /**
+     * Gets all defined query parameter types for the query being constructed indexed by parameter index or name.
+     *
+     * @return array The currently defined query parameter types indexed by parameter index or name.
+     * @since 8.2.0
+     */
+    public function getParameterTypes();
+
+    /**
+     * Gets a (previously set) query parameter type of the query being constructed.
+     *
+     * @param mixed $key The key (index or name) of the bound parameter type.
+     *
+     * @return mixed The value of the bound parameter type.
+     * @since 8.2.0
+     */
+    public function getParameterType($key);
+
+    /**
+     * Sets the position of the first result to retrieve (the "offset").
+     *
+     * @param integer $firstResult The first result to return.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function setFirstResult($firstResult);
+
+    /**
+     * Gets the position of the first result the query object was set to retrieve (the "offset").
+     * Returns NULL if {@link setFirstResult} was not applied to this QueryBuilder.
+     *
+     * @return integer The position of the first result.
+     * @since 8.2.0
+     */
+    public function getFirstResult();
+
+    /**
+     * Sets the maximum number of results to retrieve (the "limit").
+     *
+     * @param integer $maxResults The maximum number of results to retrieve.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function setMaxResults($maxResults);
+
+    /**
+     * Gets the maximum number of results the query object was set to retrieve (the "limit").
+     * Returns NULL if {@link setMaxResults} was not applied to this query builder.
+     *
+     * @return int|null The maximum number of results.
+     * @since 8.2.0
+     */
+    public function getMaxResults();
+
+    /**
+     * Specifies an item that is to be returned in the query result.
+     * Replaces any previously specified selections, if any.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.id', 'p.id')
+     *         ->from('users', 'u')
+     *         ->leftJoin('u', 'phonenumbers', 'p', 'u.id = p.user_id');
+     * </code>
+     *
+     * @param mixed ...$selects The selection expressions.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function select(...$selects);
+
+    /**
+     * Specifies an item that is to be returned with a different name in the query result.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->selectAlias('u.id', 'user_id')
+     *         ->from('users', 'u')
+     *         ->leftJoin('u', 'phonenumbers', 'p', 'u.id = p.user_id');
+     * </code>
+     *
+     * @param mixed $select The selection expressions.
+     * @param string $alias The column alias used in the constructed query.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.1
+     */
+    public function selectAlias($select, $alias);
+
+    /**
+     * Specifies an item that is to be returned uniquely in the query result.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->selectDistinct('type')
+     *         ->from('users');
+     * </code>
+     *
+     * @param mixed $select The selection expressions.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 9.0.0
+     */
+    public function selectDistinct($select);
+
+    /**
+     * Adds an item that is to be returned in the query result.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.id')
+     *         ->addSelect('p.id')
+     *         ->from('users', 'u')
+     *         ->leftJoin('u', 'phonenumbers', 'u.id = p.user_id');
+     * </code>
+     *
+     * @param mixed ...$select The selection expression.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function addSelect(...$select);
+
+    /**
+     * Turns the query being built into a bulk delete query that ranges over
+     * a certain table.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->delete('users', 'u')
+     *         ->where('u.id = :user_id');
+     *         ->setParameter(':user_id', 1);
+     * </code>
+     *
+     * @param string $delete The table whose rows are subject to the deletion.
+     * @param string $alias The table alias used in the constructed query.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function delete($delete = null, $alias = null);
+
+    /**
+     * Turns the query being built into a bulk update query that ranges over
+     * a certain table
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->update('users', 'u')
+     *         ->set('u.password', md5('password'))
+     *         ->where('u.id = ?');
+     * </code>
+     *
+     * @param string $update The table whose rows are subject to the update.
+     * @param string $alias The table alias used in the constructed query.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function update($update = null, $alias = null);
+
+    /**
+     * Turns the query being built into an insert query that inserts into
+     * a certain table
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->insert('users')
+     *         ->values(
+     *             array(
+     *                 'name' => '?',
+     *                 'password' => '?'
+     *             )
+     *         );
+     * </code>
+     *
+     * @param string $insert The table into which the rows should be inserted.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function insert($insert = null);
+
+    /**
+     * Creates and adds a query root corresponding to the table identified by the
+     * given alias, forming a cartesian product with any existing query roots.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.id')
+     *         ->from('users', 'u')
+     * </code>
+     *
+     * @param string $from The table.
+     * @param string|null $alias The alias of the table.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function from($from, $alias = null);
+
+    /**
+     * Creates and adds a join to the query.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.name')
+     *         ->from('users', 'u')
+     *         ->join('u', 'phonenumbers', 'p', 'p.is_primary = 1');
+     * </code>
+     *
+     * @param string $fromAlias The alias that points to a from clause.
+     * @param string $join The table name to join.
+     * @param string $alias The alias of the join table.
+     * @param string $condition The condition for the join.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function join($fromAlias, $join, $alias, $condition = null);
+
+    /**
+     * Creates and adds a join to the query.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.name')
+     *         ->from('users', 'u')
+     *         ->innerJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');
+     * </code>
+     *
+     * @param string $fromAlias The alias that points to a from clause.
+     * @param string $join The table name to join.
+     * @param string $alias The alias of the join table.
+     * @param string $condition The condition for the join.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function innerJoin($fromAlias, $join, $alias, $condition = null);
+
+    /**
+     * Creates and adds a left join to the query.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.name')
+     *         ->from('users', 'u')
+     *         ->leftJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');
+     * </code>
+     *
+     * @param string $fromAlias The alias that points to a from clause.
+     * @param string $join The table name to join.
+     * @param string $alias The alias of the join table.
+     * @param string $condition The condition for the join.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function leftJoin($fromAlias, $join, $alias, $condition = null);
+
+    /**
+     * Creates and adds a right join to the query.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.name')
+     *         ->from('users', 'u')
+     *         ->rightJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');
+     * </code>
+     *
+     * @param string $fromAlias The alias that points to a from clause.
+     * @param string $join The table name to join.
+     * @param string $alias The alias of the join table.
+     * @param string $condition The condition for the join.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function rightJoin($fromAlias, $join, $alias, $condition = null);
+
+    /**
+     * Sets a new value for a column in a bulk update query.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->update('users', 'u')
+     *         ->set('u.password', md5('password'))
+     *         ->where('u.id = ?');
+     * </code>
+     *
+     * @param string $key The column to set.
+     * @param ILiteral|IParameter|IQueryFunction|string $value The value, expression, placeholder, etc.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function set($key, $value);
+
+    /**
+     * Specifies one or more restrictions to the query result.
+     * Replaces any previously specified restrictions, if any.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.name')
+     *         ->from('users', 'u')
+     *         ->where('u.id = ?');
+     *
+     *     // You can optionally programatically build and/or expressions
+     *     $qb = $conn->getQueryBuilder();
+     *
+     *     $or = $qb->expr()->orx();
+     *     $or->add($qb->expr()->eq('u.id', 1));
+     *     $or->add($qb->expr()->eq('u.id', 2));
+     *
+     *     $qb->update('users', 'u')
+     *         ->set('u.password', md5('password'))
+     *         ->where($or);
+     * </code>
+     *
+     * @param mixed $predicates The restriction predicates.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function where(...$predicates);
+
+    /**
+     * Adds one or more restrictions to the query results, forming a logical
+     * conjunction with any previously specified restrictions.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u')
+     *         ->from('users', 'u')
+     *         ->where('u.username LIKE ?')
+     *         ->andWhere('u.is_active = 1');
+     * </code>
+     *
+     * @param mixed ...$where The query restrictions.
+     *
+     * @return $this This QueryBuilder instance.
+     *
+     * @see where()
+     * @since 8.2.0
+     */
+    public function andWhere(...$where);
+
+    /**
+     * Adds one or more restrictions to the query results, forming a logical
+     * disjunction with any previously specified restrictions.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.name')
+     *         ->from('users', 'u')
+     *         ->where('u.id = 1')
+     *         ->orWhere('u.id = 2');
+     * </code>
+     *
+     * @param mixed ...$where The WHERE statement.
+     *
+     * @return $this This QueryBuilder instance.
+     *
+     * @see where()
+     * @since 8.2.0
+     */
+    public function orWhere(...$where);
+
+    /**
+     * Specifies a grouping over the results of the query.
+     * Replaces any previously specified groupings, if any.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.name')
+     *         ->from('users', 'u')
+     *         ->groupBy('u.id');
+     * </code>
+     *
+     * @param mixed ...$groupBys The grouping expression.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function groupBy(...$groupBys);
+
+    /**
+     * Adds a grouping expression to the query.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.name')
+     *         ->from('users', 'u')
+     *         ->groupBy('u.lastLogin');
+     *         ->addGroupBy('u.createdAt')
+     * </code>
+     *
+     * @param mixed ...$groupBy The grouping expression.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function addGroupBy(...$groupBy);
+
+    /**
+     * Sets a value for a column in an insert query.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->insert('users')
+     *         ->values(
+     *             array(
+     *                 'name' => '?'
+     *             )
+     *         )
+     *         ->setValue('password', '?');
+     * </code>
+     *
+     * @param string $column The column into which the value should be inserted.
+     * @param IParameter|string $value The value that should be inserted into the column.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function setValue($column, $value);
+
+    /**
+     * Specifies values for an insert query indexed by column names.
+     * Replaces any previous values, if any.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->insert('users')
+     *         ->values(
+     *             array(
+     *                 'name' => '?',
+     *                 'password' => '?'
+     *             )
+     *         );
+     * </code>
+     *
+     * @param array $values The values to specify for the insert query indexed by column names.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function values(array $values);
+
+    /**
+     * Specifies a restriction over the groups of the query.
+     * Replaces any previous having restrictions, if any.
+     *
+     * @param mixed ...$having The restriction over the groups.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function having(...$having);
+
+    /**
+     * Adds a restriction over the groups of the query, forming a logical
+     * conjunction with any existing having restrictions.
+     *
+     * @param mixed ...$having The restriction to append.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function andHaving(...$having);
+
+    /**
+     * Adds a restriction over the groups of the query, forming a logical
+     * disjunction with any existing having restrictions.
+     *
+     * @param mixed ...$having The restriction to add.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function orHaving(...$having);
+
+    /**
+     * Specifies an ordering for the query results.
+     * Replaces any previously specified orderings, if any.
+     *
+     * @param string $sort The ordering expression.
+     * @param string $order The ordering direction.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function orderBy($sort, $order = null);
+
+    /**
+     * Adds an ordering to the query results.
+     *
+     * @param string $sort The ordering expression.
+     * @param string $order The ordering direction.
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function addOrderBy($sort, $order = null);
+
+    /**
+     * Gets a query part by its name.
+     *
+     * @param string $queryPartName
+     *
+     * @return mixed
+     * @since 8.2.0
+     */
+    public function getQueryPart($queryPartName);
+
+    /**
+     * Gets all query parts.
+     *
+     * @return array
+     * @since 8.2.0
+     */
+    public function getQueryParts();
+
+    /**
+     * Resets SQL parts.
+     *
+     * @param array|null $queryPartNames
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function resetQueryParts($queryPartNames = null);
+
+    /**
+     * Resets a single SQL part.
+     *
+     * @param string $queryPartName
+     *
+     * @return $this This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function resetQueryPart($queryPartName);
+
+    /**
+     * Creates a new named parameter and bind the value $value to it.
+     *
+     * This method provides a shortcut for PDOStatement::bindValue
+     * when using prepared statements.
+     *
+     * The parameter $value specifies the value that you want to bind. If
+     * $placeholder is not provided bindValue() will automatically create a
+     * placeholder for you. An automatic placeholder will be of the name
+     * ':dcValue1', ':dcValue2' etc.
+     *
+     * For more information see {@link https://www.php.net/pdostatement-bindparam}
+     *
+     * Example:
+     * <code>
+     * $value = 2;
+     * $q->eq( 'id', $q->bindValue( $value ) );
+     * $stmt = $q->executeQuery(); // executed with 'id = 2'
+     * </code>
+     *
+     * @license New BSD License
+     * @link http://www.zetacomponents.org
+     *
+     * @param mixed $value
+     * @param mixed $type
+     * @param string $placeHolder The name to bind with. The string must start with a colon ':'.
+     *
+     * @return IParameter
+     * @since 8.2.0
+     */
+    public function createNamedParameter($value, $type = self::PARAM_STR, $placeHolder = null);
+
+    /**
+     * Creates a new positional parameter and bind the given value to it.
+     *
+     * Attention: If you are using positional parameters with the query builder you have
+     * to be very careful to bind all parameters in the order they appear in the SQL
+     * statement , otherwise they get bound in the wrong order which can lead to serious
+     * bugs in your code.
+     *
+     * Example:
+     * <code>
+     *  $qb = $conn->getQueryBuilder();
+     *  $qb->select('u.*')
+     *     ->from('users', 'u')
+     *     ->where('u.username = ' . $qb->createPositionalParameter('Foo', IQueryBuilder::PARAM_STR))
+     *     ->orWhere('u.username = ' . $qb->createPositionalParameter('Bar', IQueryBuilder::PARAM_STR))
+     * </code>
+     *
+     * @param mixed $value
+     * @param integer $type
+     *
+     * @return IParameter
+     * @since 8.2.0
+     */
+    public function createPositionalParameter($value, $type = self::PARAM_STR);
+
+    /**
+     * Creates a new parameter
+     *
+     * Example:
+     * <code>
+     *  $qb = $conn->getQueryBuilder();
+     *  $qb->select('u.*')
+     *     ->from('users', 'u')
+     *     ->where('u.username = ' . $qb->createParameter('name'))
+     *     ->setParameter('name', 'Bar', IQueryBuilder::PARAM_STR))
+     * </code>
+     *
+     * @param string $name
+     *
+     * @return IParameter
+     * @since 8.2.0
+     */
+    public function createParameter($name);
+
+    /**
+     * Creates a new function
+     *
+     * Attention: Column names inside the call have to be quoted before hand
+     *
+     * Example:
+     * <code>
+     *  $qb = $conn->getQueryBuilder();
+     *  $qb->select($qb->createFunction('COUNT(*)'))
+     *     ->from('users', 'u')
+     *  echo $qb->getSQL(); // SELECT COUNT(*) FROM `users` u
+     * </code>
+     * <code>
+     *  $qb = $conn->getQueryBuilder();
+     *  $qb->select($qb->createFunction('COUNT(`column`)'))
+     *     ->from('users', 'u')
+     *  echo $qb->getSQL(); // SELECT COUNT(`column`) FROM `users` u
+     * </code>
+     *
+     * @param string $call
+     *
+     * @return IQueryFunction
+     * @since 8.2.0
+     */
+    public function createFunction($call);
+
+    /**
+     * Used to get the id of the last inserted element
+     * @return int
+     * @throws \BadMethodCallException When being called before an insert query has been run.
+     * @since 9.0.0
+     */
+    public function getLastInsertId();
+
+    /**
+     * Returns the table name quoted and with database prefix as needed by the implementation
+     *
+     * @param string $table
+     * @return string
+     * @since 9.0.0
+     */
+    public function getTableName($table);
+
+    /**
+     * Returns the column name quoted and with table alias prefix as needed by the implementation
+     *
+     * @param string $column
+     * @param string $tableAlias
+     * @return string
+     * @since 9.0.0
+     */
+    public function getColumnName($column, $tableAlias = '');
 }

lib/public/DB/Exception.php

Indentation +106 added lines, -106 removed lines

@@ -40,110 +40,110 @@
  */
 class Exception extends BaseException {
 
-	/**
-	 * Nextcloud lost connection to the database
-	 *
-	 * @since 21.0.0
-	 */
-	public const REASON_CONNECTION_LOST = 1;
-
-	/**
-	 * A database constraint was violated
-	 *
-	 * @since 21.0.0
-	 */
-	public const REASON_CONSTRAINT_VIOLATION = 2;
-
-	/**
-	 * A database object (table, column, index) already exists
-	 *
-	 * @since 21.0.0
-	 */
-	public const REASON_DATABASE_OBJECT_EXISTS = 3;
-
-	/**
-	 * A database object (table, column, index) can't be found
-	 *
-	 * @since 21.0.0
-	 */
-	public const REASON_DATABASE_OBJECT_NOT_FOUND = 4;
-
-	/**
-	 * The database ran into a deadlock
-	 *
-	 * @since 21.0.0
-	 */
-	public const REASON_DEADLOCK = 5;
-
-	/**
-	 * The database driver encountered an issue
-	 *
-	 * @since 21.0.0
-	 */
-	public const REASON_DRIVER = 6;
-
-	/**
-	 * A foreign key constraint was violated
-	 *
-	 * @since 21.0.0
-	 */
-	public const REASON_FOREIGN_KEY_VIOLATION = 7;
-
-	/**
-	 * An invalid argument was passed to the database abstraction
-	 *
-	 * @since 21.0.0
-	 */
-	public const REASON_INVALID_ARGUMENT = 8;
-
-	/**
-	 * A field name was invalid
-	 *
-	 * @since 21.0.0
-	 */
-	public const REASON_INVALID_FIELD_NAME = 9;
-
-	/**
-	 * A name in the query was ambiguous
-	 *
-	 * @since 21.0.0
-	 */
-	public const REASON_NON_UNIQUE_FIELD_NAME = 10;
-
-	/**
-	 * A not null contraint was violated
-	 *
-	 * @since 21.0.0
-	 */
-	public const REASON_NOT_NULL_CONSTRAINT_VIOLATION = 11;
-
-	/**
-	 * A generic server error was encountered
-	 *
-	 * @since 21.0.0
-	 */
-	public const REASON_SERVER = 12;
-
-	/**
-	 * A syntax error was reported by the server
-	 *
-	 * @since 21.0.0
-	 */
-	public const REASON_SYNTAX_ERROR = 13;
-
-	/**
-	 * A unique constraint was violated
-	 *
-	 * @since 21.0.0
-	 */
-	public const REASON_UNIQUE_CONSTRAINT_VIOLATION = 14;
-
-	/**
-	 * @return int|null
-	 * @psalm-return Exception::REASON_*
-	 * @since 21.0.0
-	 */
-	public function getReason(): ?int {
-		return null;
-	}
+    /**
+     * Nextcloud lost connection to the database
+     *
+     * @since 21.0.0
+     */
+    public const REASON_CONNECTION_LOST = 1;
+
+    /**
+     * A database constraint was violated
+     *
+     * @since 21.0.0
+     */
+    public const REASON_CONSTRAINT_VIOLATION = 2;
+
+    /**
+     * A database object (table, column, index) already exists
+     *
+     * @since 21.0.0
+     */
+    public const REASON_DATABASE_OBJECT_EXISTS = 3;
+
+    /**
+     * A database object (table, column, index) can't be found
+     *
+     * @since 21.0.0
+     */
+    public const REASON_DATABASE_OBJECT_NOT_FOUND = 4;
+
+    /**
+     * The database ran into a deadlock
+     *
+     * @since 21.0.0
+     */
+    public const REASON_DEADLOCK = 5;
+
+    /**
+     * The database driver encountered an issue
+     *
+     * @since 21.0.0
+     */
+    public const REASON_DRIVER = 6;
+
+    /**
+     * A foreign key constraint was violated
+     *
+     * @since 21.0.0
+     */
+    public const REASON_FOREIGN_KEY_VIOLATION = 7;
+
+    /**
+     * An invalid argument was passed to the database abstraction
+     *
+     * @since 21.0.0
+     */
+    public const REASON_INVALID_ARGUMENT = 8;
+
+    /**
+     * A field name was invalid
+     *
+     * @since 21.0.0
+     */
+    public const REASON_INVALID_FIELD_NAME = 9;
+
+    /**
+     * A name in the query was ambiguous
+     *
+     * @since 21.0.0
+     */
+    public const REASON_NON_UNIQUE_FIELD_NAME = 10;
+
+    /**
+     * A not null contraint was violated
+     *
+     * @since 21.0.0
+     */
+    public const REASON_NOT_NULL_CONSTRAINT_VIOLATION = 11;
+
+    /**
+     * A generic server error was encountered
+     *
+     * @since 21.0.0
+     */
+    public const REASON_SERVER = 12;
+
+    /**
+     * A syntax error was reported by the server
+     *
+     * @since 21.0.0
+     */
+    public const REASON_SYNTAX_ERROR = 13;
+
+    /**
+     * A unique constraint was violated
+     *
+     * @since 21.0.0
+     */
+    public const REASON_UNIQUE_CONSTRAINT_VIOLATION = 14;
+
+    /**
+     * @return int|null
+     * @psalm-return Exception::REASON_*
+     * @since 21.0.0
+     */
+    public function getReason(): ?int {
+        return null;
+    }
 }

lib/private/DB/Connection.php

Indentation +469 added lines, -469 removed lines

@@ -54,473 +54,473 @@
 use OCP\PreConditionNotMetException;
 
 class Connection extends ReconnectWrapper {
-	/** @var string */
-	protected $tablePrefix;
-
-	/** @var \OC\DB\Adapter $adapter */
-	protected $adapter;
-
-	/** @var SystemConfig */
-	private $systemConfig;
-
-	/** @var ILogger */
-	private $logger;
-
-	protected $lockedTable = null;
-
-	/** @var int */
-	protected $queriesBuilt = 0;
-
-	/** @var int */
-	protected $queriesExecuted = 0;
-
-	/**
-	 * @throws Exception
-	 */
-	public function connect() {
-		try {
-			return parent::connect();
-		} 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());
-		}
-	}
-
-	public function getStats(): array {
-		return [
-			'built' => $this->queriesBuilt,
-			'executed' => $this->queriesExecuted,
-		];
-	}
-
-	/**
-	 * Returns a QueryBuilder for the connection.
-	 */
-	public function getQueryBuilder(): IQueryBuilder {
-		$this->queriesBuilt++;
-		return new QueryBuilder(
-			new ConnectionAdapter($this),
-			$this->systemConfig,
-			$this->logger
-		);
-	}
-
-	/**
-	 * Gets the QueryBuilder for the connection.
-	 *
-	 * @return \Doctrine\DBAL\Query\QueryBuilder
-	 * @deprecated please use $this->getQueryBuilder() instead
-	 */
-	public function createQueryBuilder() {
-		$backtrace = $this->getCallerBacktrace();
-		\OC::$server->getLogger()->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 please use $this->getQueryBuilder()->expr() instead
-	 */
-	public function getExpressionBuilder() {
-		$backtrace = $this->getCallerBacktrace();
-		\OC::$server->getLogger()->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;
-	}
-
-	/**
-	 * Initializes a new instance of the Connection class.
-	 *
-	 * @param array $params  The connection parameters.
-	 * @param \Doctrine\DBAL\Driver $driver
-	 * @param \Doctrine\DBAL\Configuration $config
-	 * @param \Doctrine\Common\EventManager $eventManager
-	 * @throws \Exception
-	 */
-	public function __construct(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');
-		}
-		parent::__construct($params, $driver, $config, $eventManager);
-		$this->adapter = new $params['adapter']($this);
-		$this->tablePrefix = $params['tablePrefix'];
-
-		$this->systemConfig = \OC::$server->getSystemConfig();
-		$this->logger = \OC::$server->getLogger();
-	}
-
-	/**
-	 * Prepares an SQL statement.
-	 *
-	 * @param string $statement The SQL statement to prepare.
-	 * @param int $limit
-	 * @param int $offset
-	 *
-	 * @return Statement The prepared statement.
-	 * @throws Exception
-	 */
-	public function prepare($statement, $limit = null, $offset = null): Statement {
-		if ($limit === -1) {
-			$limit = null;
-		}
-		if (!is_null($limit)) {
-			$platform = $this->getDatabasePlatform();
-			$statement = $platform->modifyLimitQuery($statement, $limit, $offset);
-		}
-		$statement = $this->replaceTablePrefix($statement);
-		$statement = $this->adapter->fixupStatement($statement);
-
-		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 {
-		$sql = $this->replaceTablePrefix($sql);
-		$sql = $this->adapter->fixupStatement($sql);
-		$this->queriesExecuted++;
-		return parent::executeQuery($sql, $params, $types, $qcp);
-	}
-
-	/**
-	 * @throws Exception
-	 */
-	public function executeUpdate(string $sql, array $params = [], array $types = []): int {
-		$sql = $this->replaceTablePrefix($sql);
-		$sql = $this->adapter->fixupStatement($sql);
-		$this->queriesExecuted++;
-		return parent::executeUpdate($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 {
-		$sql = $this->replaceTablePrefix($sql);
-		$sql = $this->adapter->fixupStatement($sql);
-		$this->queriesExecuted++;
-		return parent::executeStatement($sql, $params, $types);
-	}
-
-	/**
-	 * 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 string the last inserted ID.
-	 * @throws Exception
-	 */
-	public function lastInsertId($seqName = null) {
-		if ($seqName) {
-			$seqName = $this->replaceTablePrefix($seqName);
-		}
-		return $this->adapter->lastInsertId($seqName);
-	}
-
-	/**
-	 * @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) {
-		return $this->adapter->insertIfNotExist($table, $input, $compare);
-	}
-
-	public function insertIgnoreConflict(string $table, array $values) : int {
-		return $this->adapter->insertIgnoreConflict($table, $values);
-	}
-
-	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 \Doctrine\DBAL\Exception
-	 * @throws PreConditionNotMetException
-	 */
-	public function setValues($table, array $keys, array $values, array $updatePreconditionValues = []) {
-		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->execute();
-		} catch (NotNullConstraintViolationException $e) {
-			throw $e;
-		} catch (ConstraintViolationException $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 = $updateQb->expr()->andX();
-			$whereValues = array_merge($keys, $updatePreconditionValues);
-			foreach ($whereValues as $name => $value) {
-				if ($value === '') {
-					$where->add($updateQb->expr()->emptyString(
-						$name
-					));
-				} else {
-					$where->add($updateQb->expr()->eq(
-						$name,
-						$updateQb->createNamedParameter($value, $this->getType($value)),
-						$this->getType($value)
-					));
-				}
-			}
-			$updateQb->where($where);
-			$affected = $updateQb->execute();
-
-			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->getSchemaManager();
-		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->getSchemaManager();
-		return $schema->tablesExist([$table]);
-	}
-
-	// 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() {
-		$schemaManager = new MDB2SchemaManager($this);
-		$migrator = $schemaManager->getMigrator();
-		return $migrator->createSchema();
-	}
-
-	/**
-	 * Migrate the database to the given schema
-	 *
-	 * @param Schema $toSchema
-	 *
-	 * @throws Exception
-	 */
-	public function migrateToSchema(Schema $toSchema) {
-		$schemaManager = new MDB2SchemaManager($this);
-		$migrator = $schemaManager->getMigrator();
-		$migrator->migrate($toSchema);
-	}
+    /** @var string */
+    protected $tablePrefix;
+
+    /** @var \OC\DB\Adapter $adapter */
+    protected $adapter;
+
+    /** @var SystemConfig */
+    private $systemConfig;
+
+    /** @var ILogger */
+    private $logger;
+
+    protected $lockedTable = null;
+
+    /** @var int */
+    protected $queriesBuilt = 0;
+
+    /** @var int */
+    protected $queriesExecuted = 0;
+
+    /**
+     * @throws Exception
+     */
+    public function connect() {
+        try {
+            return parent::connect();
+        } 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());
+        }
+    }
+
+    public function getStats(): array {
+        return [
+            'built' => $this->queriesBuilt,
+            'executed' => $this->queriesExecuted,
+        ];
+    }
+
+    /**
+     * Returns a QueryBuilder for the connection.
+     */
+    public function getQueryBuilder(): IQueryBuilder {
+        $this->queriesBuilt++;
+        return new QueryBuilder(
+            new ConnectionAdapter($this),
+            $this->systemConfig,
+            $this->logger
+        );
+    }
+
+    /**
+     * Gets the QueryBuilder for the connection.
+     *
+     * @return \Doctrine\DBAL\Query\QueryBuilder
+     * @deprecated please use $this->getQueryBuilder() instead
+     */
+    public function createQueryBuilder() {
+        $backtrace = $this->getCallerBacktrace();
+        \OC::$server->getLogger()->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 please use $this->getQueryBuilder()->expr() instead
+     */
+    public function getExpressionBuilder() {
+        $backtrace = $this->getCallerBacktrace();
+        \OC::$server->getLogger()->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;
+    }
+
+    /**
+     * Initializes a new instance of the Connection class.
+     *
+     * @param array $params  The connection parameters.
+     * @param \Doctrine\DBAL\Driver $driver
+     * @param \Doctrine\DBAL\Configuration $config
+     * @param \Doctrine\Common\EventManager $eventManager
+     * @throws \Exception
+     */
+    public function __construct(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');
+        }
+        parent::__construct($params, $driver, $config, $eventManager);
+        $this->adapter = new $params['adapter']($this);
+        $this->tablePrefix = $params['tablePrefix'];
+
+        $this->systemConfig = \OC::$server->getSystemConfig();
+        $this->logger = \OC::$server->getLogger();
+    }
+
+    /**
+     * Prepares an SQL statement.
+     *
+     * @param string $statement The SQL statement to prepare.
+     * @param int $limit
+     * @param int $offset
+     *
+     * @return Statement The prepared statement.
+     * @throws Exception
+     */
+    public function prepare($statement, $limit = null, $offset = null): Statement {
+        if ($limit === -1) {
+            $limit = null;
+        }
+        if (!is_null($limit)) {
+            $platform = $this->getDatabasePlatform();
+            $statement = $platform->modifyLimitQuery($statement, $limit, $offset);
+        }
+        $statement = $this->replaceTablePrefix($statement);
+        $statement = $this->adapter->fixupStatement($statement);
+
+        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 {
+        $sql = $this->replaceTablePrefix($sql);
+        $sql = $this->adapter->fixupStatement($sql);
+        $this->queriesExecuted++;
+        return parent::executeQuery($sql, $params, $types, $qcp);
+    }
+
+    /**
+     * @throws Exception
+     */
+    public function executeUpdate(string $sql, array $params = [], array $types = []): int {
+        $sql = $this->replaceTablePrefix($sql);
+        $sql = $this->adapter->fixupStatement($sql);
+        $this->queriesExecuted++;
+        return parent::executeUpdate($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 {
+        $sql = $this->replaceTablePrefix($sql);
+        $sql = $this->adapter->fixupStatement($sql);
+        $this->queriesExecuted++;
+        return parent::executeStatement($sql, $params, $types);
+    }
+
+    /**
+     * 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 string the last inserted ID.
+     * @throws Exception
+     */
+    public function lastInsertId($seqName = null) {
+        if ($seqName) {
+            $seqName = $this->replaceTablePrefix($seqName);
+        }
+        return $this->adapter->lastInsertId($seqName);
+    }
+
+    /**
+     * @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) {
+        return $this->adapter->insertIfNotExist($table, $input, $compare);
+    }
+
+    public function insertIgnoreConflict(string $table, array $values) : int {
+        return $this->adapter->insertIgnoreConflict($table, $values);
+    }
+
+    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 \Doctrine\DBAL\Exception
+     * @throws PreConditionNotMetException
+     */
+    public function setValues($table, array $keys, array $values, array $updatePreconditionValues = []) {
+        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->execute();
+        } catch (NotNullConstraintViolationException $e) {
+            throw $e;
+        } catch (ConstraintViolationException $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 = $updateQb->expr()->andX();
+            $whereValues = array_merge($keys, $updatePreconditionValues);
+            foreach ($whereValues as $name => $value) {
+                if ($value === '') {
+                    $where->add($updateQb->expr()->emptyString(
+                        $name
+                    ));
+                } else {
+                    $where->add($updateQb->expr()->eq(
+                        $name,
+                        $updateQb->createNamedParameter($value, $this->getType($value)),
+                        $this->getType($value)
+                    ));
+                }
+            }
+            $updateQb->where($where);
+            $affected = $updateQb->execute();
+
+            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->getSchemaManager();
+        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->getSchemaManager();
+        return $schema->tablesExist([$table]);
+    }
+
+    // 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() {
+        $schemaManager = new MDB2SchemaManager($this);
+        $migrator = $schemaManager->getMigrator();
+        return $migrator->createSchema();
+    }
+
+    /**
+     * Migrate the database to the given schema
+     *
+     * @param Schema $toSchema
+     *
+     * @throws Exception
+     */
+    public function migrateToSchema(Schema $toSchema) {
+        $schemaManager = new MDB2SchemaManager($this);
+        $migrator = $schemaManager->getMigrator();
+        $migrator->migrate($toSchema);
+    }
 }

Spacing +9 added lines, -9 removed lines

@@ -82,7 +82,7 @@ 
 			return parent::connect();
 		} 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());
+			throw new Exception('Failed to connect to the database: '.$e->getMessage(), $e->getCode());
 		}
 	}
 
@@ -142,7 +142,7 @@ 
 		// 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 $traces[1]['file'].':'.$traces[1]['line'];
 		}
 
 		return '';
@@ -333,7 +333,7 @@ 
 			$insertQb = $this->getQueryBuilder();
 			$insertQb->insert($table)
 				->values(
-					array_map(function ($value) use ($insertQb) {
+					array_map(function($value) use ($insertQb) {
 						return $insertQb->createNamedParameter($value, $this->getType($value));
 					}, array_merge($keys, $values))
 				);
@@ -387,7 +387,7 @@ 
 			throw new \BadMethodCallException('Can not lock a new table until the previous lock is released.');
 		}
 
-		$tableName = $this->tablePrefix . $tableName;
+		$tableName = $this->tablePrefix.$tableName;
 		$this->lockedTable = $tableName;
 		$this->adapter->lockTable($tableName);
 	}
@@ -409,11 +409,11 @@ 
 	 * @return string
 	 */
 	public function getError() {
-		$msg = $this->errorCode() . ': ';
+		$msg = $this->errorCode().': ';
 		$errorInfo = $this->errorInfo();
 		if (!empty($errorInfo)) {
-			$msg .= 'SQLSTATE = '.$errorInfo[0] . ', ';
-			$msg .= 'Driver Code = '.$errorInfo[1] . ', ';
+			$msg .= 'SQLSTATE = '.$errorInfo[0].', ';
+			$msg .= 'Driver Code = '.$errorInfo[1].', ';
 			$msg .= 'Driver Message = '.$errorInfo[2];
 		}
 		return $msg;
@@ -435,7 +435,7 @@ 
 	 * @throws Exception
 	 */
 	public function dropTable($table) {
-		$table = $this->tablePrefix . trim($table);
+		$table = $this->tablePrefix.trim($table);
 		$schema = $this->getSchemaManager();
 		if ($schema->tablesExist([$table])) {
 			$schema->dropTable($table);
@@ -451,7 +451,7 @@ 
 	 * @throws Exception
 	 */
 	public function tableExists($table) {
-		$table = $this->tablePrefix . trim($table);
+		$table = $this->tablePrefix.trim($table);
 		$schema = $this->getSchemaManager();
 		return $schema->tablesExist([$table]);
 	}

lib/private/DB/Adapter.php

Indentation +102 added lines, -102 removed lines

@@ -39,115 +39,115 @@
  */
 class Adapter {
 
-	/**
-	 * @var \OC\DB\Connection $conn
-	 */
-	protected $conn;
+    /**
+     * @var \OC\DB\Connection $conn
+     */
+    protected $conn;
 
-	public function __construct($conn) {
-		$this->conn = $conn;
-	}
+    public function __construct($conn) {
+        $this->conn = $conn;
+    }
 
-	/**
-	 * @param string $table name
-	 *
-	 * @return int id of last insert statement
-	 * @throws Exception
-	 */
-	public function lastInsertId($table) {
-		return (int) $this->conn->realLastInsertId($table);
-	}
+    /**
+     * @param string $table name
+     *
+     * @return int id of last insert statement
+     * @throws Exception
+     */
+    public function lastInsertId($table) {
+        return (int) $this->conn->realLastInsertId($table);
+    }
 
-	/**
-	 * @param string $statement that needs to be changed so the db can handle it
-	 * @return string changed statement
-	 */
-	public function fixupStatement($statement) {
-		return $statement;
-	}
+    /**
+     * @param string $statement that needs to be changed so the db can handle it
+     * @return string changed statement
+     */
+    public function fixupStatement($statement) {
+        return $statement;
+    }
 
-	/**
-	 * Create an exclusive read+write lock on a table
-	 *
-	 * @param string $tableName
-	 * @throws Exception
-	 * @since 9.1.0
-	 */
-	public function lockTable($tableName) {
-		$this->conn->beginTransaction();
-		$this->conn->executeUpdate('LOCK TABLE `' .$tableName . '` IN EXCLUSIVE MODE');
-	}
+    /**
+     * Create an exclusive read+write lock on a table
+     *
+     * @param string $tableName
+     * @throws Exception
+     * @since 9.1.0
+     */
+    public function lockTable($tableName) {
+        $this->conn->beginTransaction();
+        $this->conn->executeUpdate('LOCK TABLE `' .$tableName . '` IN EXCLUSIVE MODE');
+    }
 
-	/**
-	 * Release a previous acquired lock again
-	 *
-	 * @throws Exception
-	 * @since 9.1.0
-	 */
-	public function unlockTable() {
-		$this->conn->commit();
-	}
+    /**
+     * Release a previous acquired lock again
+     *
+     * @throws Exception
+     * @since 9.1.0
+     */
+    public function unlockTable() {
+        $this->conn->commit();
+    }
 
-	/**
-	 * 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 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) {
-		if (empty($compare)) {
-			$compare = array_keys($input);
-		}
-		$query = 'INSERT INTO `' .$table . '` (`'
-			. implode('`,`', array_keys($input)) . '`) SELECT '
-			. str_repeat('?,', count($input) - 1).'? ' // Is there a prettier alternative?
-			. 'FROM `' . $table . '` WHERE ';
+    /**
+     * 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 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) {
+        if (empty($compare)) {
+            $compare = array_keys($input);
+        }
+        $query = 'INSERT INTO `' .$table . '` (`'
+            . implode('`,`', array_keys($input)) . '`) SELECT '
+            . str_repeat('?,', count($input) - 1).'? ' // Is there a prettier alternative?
+            . 'FROM `' . $table . '` WHERE ';
 
-		$inserts = array_values($input);
-		foreach ($compare as $key) {
-			$query .= '`' . $key . '`';
-			if (is_null($input[$key])) {
-				$query .= ' IS NULL AND ';
-			} else {
-				$inserts[] = $input[$key];
-				$query .= ' = ? AND ';
-			}
-		}
-		$query = substr($query, 0, -5);
-		$query .= ' HAVING COUNT(*) = 0';
+        $inserts = array_values($input);
+        foreach ($compare as $key) {
+            $query .= '`' . $key . '`';
+            if (is_null($input[$key])) {
+                $query .= ' IS NULL AND ';
+            } else {
+                $inserts[] = $input[$key];
+                $query .= ' = ? AND ';
+            }
+        }
+        $query = substr($query, 0, -5);
+        $query .= ' HAVING COUNT(*) = 0';
 
-		try {
-			return $this->conn->executeUpdate($query, $inserts);
-		} catch (UniqueConstraintViolationException $e) {
-			// if this is thrown then a concurrent insert happened between the insert and the sub-select in the insert, that should have avoided it
-			// it's fine to ignore this then
-			//
-			// more discussions about this can be found at https://github.com/nextcloud/server/pull/12315
-			return 0;
-		}
-	}
+        try {
+            return $this->conn->executeUpdate($query, $inserts);
+        } catch (UniqueConstraintViolationException $e) {
+            // if this is thrown then a concurrent insert happened between the insert and the sub-select in the insert, that should have avoided it
+            // it's fine to ignore this then
+            //
+            // more discussions about this can be found at https://github.com/nextcloud/server/pull/12315
+            return 0;
+        }
+    }
 
-	/**
-	 * @throws \OCP\DB\Exception
-	 */
-	public function insertIgnoreConflict(string $table,array $values) : int {
-		try {
-			$builder = $this->conn->getQueryBuilder();
-			$builder->insert($table);
-			foreach ($values as $key => $value) {
-				$builder->setValue($key, $builder->createNamedParameter($value));
-			}
-			return $builder->execute();
-		} catch (UniqueConstraintViolationException $e) {
-			return 0;
-		}
-	}
+    /**
+     * @throws \OCP\DB\Exception
+     */
+    public function insertIgnoreConflict(string $table,array $values) : int {
+        try {
+            $builder = $this->conn->getQueryBuilder();
+            $builder->insert($table);
+            foreach ($values as $key => $value) {
+                $builder->setValue($key, $builder->createNamedParameter($value));
+            }
+            return $builder->execute();
+        } catch (UniqueConstraintViolationException $e) {
+            return 0;
+        }
+    }
 }

Spacing +6 added lines, -6 removed lines

@@ -75,7 +75,7 @@ 
 	 */
 	public function lockTable($tableName) {
 		$this->conn->beginTransaction();
-		$this->conn->executeUpdate('LOCK TABLE `' .$tableName . '` IN EXCLUSIVE MODE');
+		$this->conn->executeUpdate('LOCK TABLE `'.$tableName.'` IN EXCLUSIVE MODE');
 	}
 
 	/**
@@ -106,14 +106,14 @@ 
 		if (empty($compare)) {
 			$compare = array_keys($input);
 		}
-		$query = 'INSERT INTO `' .$table . '` (`'
-			. implode('`,`', array_keys($input)) . '`) SELECT '
+		$query = 'INSERT INTO `'.$table.'` (`'
+			. implode('`,`', array_keys($input)).'`) SELECT '
 			. str_repeat('?,', count($input) - 1).'? ' // Is there a prettier alternative?
-			. 'FROM `' . $table . '` WHERE ';
+			. 'FROM `'.$table.'` WHERE ';
 
 		$inserts = array_values($input);
 		foreach ($compare as $key) {
-			$query .= '`' . $key . '`';
+			$query .= '`'.$key.'`';
 			if (is_null($input[$key])) {
 				$query .= ' IS NULL AND ';
 			} else {
@@ -138,7 +138,7 @@ 
 	/**
 	 * @throws \OCP\DB\Exception
 	 */
-	public function insertIgnoreConflict(string $table,array $values) : int {
+	public function insertIgnoreConflict(string $table, array $values) : int {
 		try {
 			$builder = $this->conn->getQueryBuilder();
 			$builder->insert($table);

lib/private/DB/Migrator.php

Indentation +261 added lines, -261 removed lines

@@ -49,265 +49,265 @@
 
 class Migrator {
 
-	/** @var \Doctrine\DBAL\Connection */
-	protected $connection;
-
-	/** @var ISecureRandom */
-	private $random;
-
-	/** @var IConfig */
-	protected $config;
-
-	/** @var EventDispatcherInterface  */
-	private $dispatcher;
-
-	/** @var bool */
-	private $noEmit = false;
-
-	/**
-	 * @param \Doctrine\DBAL\Connection $connection
-	 * @param ISecureRandom $random
-	 * @param IConfig $config
-	 * @param EventDispatcherInterface $dispatcher
-	 */
-	public function __construct(\Doctrine\DBAL\Connection $connection,
-								ISecureRandom $random,
-								IConfig $config,
-								EventDispatcherInterface $dispatcher = null) {
-		$this->connection = $connection;
-		$this->random = $random;
-		$this->config = $config;
-		$this->dispatcher = $dispatcher;
-	}
-
-	/**
-	 * @param \Doctrine\DBAL\Schema\Schema $targetSchema
-	 *
-	 * @throws Exception
-	 */
-	public function migrate(Schema $targetSchema) {
-		$this->noEmit = true;
-		$this->applySchema($targetSchema);
-	}
-
-	/**
-	 * @param \Doctrine\DBAL\Schema\Schema $targetSchema
-	 * @return string
-	 */
-	public function generateChangeScript(Schema $targetSchema) {
-		$schemaDiff = $this->getDiff($targetSchema, $this->connection);
-
-		$script = '';
-		$sqls = $schemaDiff->toSql($this->connection->getDatabasePlatform());
-		foreach ($sqls as $sql) {
-			$script .= $this->convertStatementToScript($sql);
-		}
-
-		return $script;
-	}
-
-	/**
-	 * Create a unique name for the temporary table
-	 *
-	 * @param string $name
-	 * @return string
-	 */
-	protected function generateTemporaryTableName($name) {
-		return $this->config->getSystemValue('dbtableprefix', 'oc_') . $name . '_' . $this->random->generate(13, ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_DIGITS);
-	}
-
-	/**
-	 * Check the migration of a table on a copy so we can detect errors before messing with the real table
-	 *
-	 * @param \Doctrine\DBAL\Schema\Table $table
-	 * @throws \OC\DB\MigrationException
-	 */
-	protected function checkTableMigrate(Table $table) {
-		$name = $table->getName();
-		$tmpName = $this->generateTemporaryTableName($name);
-
-		$this->copyTable($name, $tmpName);
-
-		//create the migration schema for the temporary table
-		$tmpTable = $this->renameTableSchema($table, $tmpName);
-		$schemaConfig = new SchemaConfig();
-		$schemaConfig->setName($this->connection->getDatabase());
-		$schema = new Schema([$tmpTable], [], $schemaConfig);
-
-		try {
-			$this->applySchema($schema);
-			$this->dropTable($tmpName);
-		} catch (Exception $e) {
-			// pgsql needs to commit it's failed transaction before doing anything else
-			if ($this->connection->isTransactionActive()) {
-				$this->connection->commit();
-			}
-			$this->dropTable($tmpName);
-			throw new MigrationException($table->getName(), $e->getMessage());
-		}
-	}
-
-	/**
-	 * @param \Doctrine\DBAL\Schema\Table $table
-	 * @param string $newName
-	 * @return \Doctrine\DBAL\Schema\Table
-	 */
-	protected function renameTableSchema(Table $table, $newName) {
-		/**
-		 * @var \Doctrine\DBAL\Schema\Index[] $indexes
-		 */
-		$indexes = $table->getIndexes();
-		$newIndexes = [];
-		foreach ($indexes as $index) {
-			if ($index->isPrimary()) {
-				// do not rename primary key
-				$indexName = $index->getName();
-			} else {
-				// avoid conflicts in index names
-				$indexName = $this->config->getSystemValue('dbtableprefix', 'oc_') . $this->random->generate(13, ISecureRandom::CHAR_LOWER);
-			}
-			$newIndexes[] = new Index($indexName, $index->getColumns(), $index->isUnique(), $index->isPrimary());
-		}
-
-		// foreign keys are not supported so we just set it to an empty array
-		return new Table($newName, $table->getColumns(), $newIndexes, [], [], $table->getOptions());
-	}
-
-	/**
-	 * @throws Exception
-	 */
-	public function createSchema() {
-		$this->connection->getConfiguration()->setSchemaAssetsFilter(function ($asset) {
-			/** @var string|AbstractAsset $asset */
-			$filterExpression = $this->getFilterExpression();
-			if ($asset instanceof AbstractAsset) {
-				return preg_match($filterExpression, $asset->getName()) !== false;
-			}
-			return preg_match($filterExpression, $asset) !== false;
-		});
-		return $this->connection->getSchemaManager()->createSchema();
-	}
-
-	/**
-	 * @param Schema $targetSchema
-	 * @param \Doctrine\DBAL\Connection $connection
-	 * @return \Doctrine\DBAL\Schema\SchemaDiff
-	 */
-	protected function getDiff(Schema $targetSchema, \Doctrine\DBAL\Connection $connection) {
-		// adjust varchar columns with a length higher then getVarcharMaxLength to clob
-		foreach ($targetSchema->getTables() as $table) {
-			foreach ($table->getColumns() as $column) {
-				if ($column->getType() instanceof StringType) {
-					if ($column->getLength() > $connection->getDatabasePlatform()->getVarcharMaxLength()) {
-						$column->setType(Type::getType('text'));
-						$column->setLength(null);
-					}
-				}
-			}
-		}
-
-		$this->connection->getConfiguration()->setSchemaAssetsFilter(function ($asset) {
-			/** @var string|AbstractAsset $asset */
-			$filterExpression = $this->getFilterExpression();
-			if ($asset instanceof AbstractAsset) {
-				return preg_match($filterExpression, $asset->getName()) !== false;
-			}
-			return preg_match($filterExpression, $asset) !== false;
-		});
-		$sourceSchema = $connection->getSchemaManager()->createSchema();
-
-		// remove tables we don't know about
-		foreach ($sourceSchema->getTables() as $table) {
-			if (!$targetSchema->hasTable($table->getName())) {
-				$sourceSchema->dropTable($table->getName());
-			}
-		}
-		// remove sequences we don't know about
-		foreach ($sourceSchema->getSequences() as $table) {
-			if (!$targetSchema->hasSequence($table->getName())) {
-				$sourceSchema->dropSequence($table->getName());
-			}
-		}
-
-		$comparator = new Comparator();
-		return $comparator->compare($sourceSchema, $targetSchema);
-	}
-
-	/**
-	 * @param \Doctrine\DBAL\Schema\Schema $targetSchema
-	 * @param \Doctrine\DBAL\Connection $connection
-	 *
-	 * @throws Exception
-	 */
-	protected function applySchema(Schema $targetSchema, \Doctrine\DBAL\Connection $connection = null) {
-		if (is_null($connection)) {
-			$connection = $this->connection;
-		}
-
-		$schemaDiff = $this->getDiff($targetSchema, $connection);
-
-		if (!$connection->getDatabasePlatform() instanceof MySQLPlatform) {
-			$connection->beginTransaction();
-		}
-		$sqls = $schemaDiff->toSql($connection->getDatabasePlatform());
-		$step = 0;
-		foreach ($sqls as $sql) {
-			$this->emit($sql, $step++, count($sqls));
-			$connection->query($sql);
-		}
-		if (!$connection->getDatabasePlatform() instanceof MySQLPlatform) {
-			$connection->commit();
-		}
-	}
-
-	/**
-	 * @param string $sourceName
-	 * @param string $targetName
-	 */
-	protected function copyTable($sourceName, $targetName) {
-		$quotedSource = $this->connection->quoteIdentifier($sourceName);
-		$quotedTarget = $this->connection->quoteIdentifier($targetName);
-
-		$this->connection->exec('CREATE TABLE ' . $quotedTarget . ' (LIKE ' . $quotedSource . ')');
-		$this->connection->exec('INSERT INTO ' . $quotedTarget . ' SELECT * FROM ' . $quotedSource);
-	}
-
-	/**
-	 * @param string $name
-	 */
-	protected function dropTable($name) {
-		$this->connection->exec('DROP TABLE ' . $this->connection->quoteIdentifier($name));
-	}
-
-	/**
-	 * @param $statement
-	 * @return string
-	 */
-	protected function convertStatementToScript($statement) {
-		$script = $statement . ';';
-		$script .= PHP_EOL;
-		$script .= PHP_EOL;
-		return $script;
-	}
-
-	protected function getFilterExpression() {
-		return '/^' . preg_quote($this->config->getSystemValue('dbtableprefix', 'oc_')) . '/';
-	}
-
-	protected function emit($sql, $step, $max) {
-		if ($this->noEmit) {
-			return;
-		}
-		if (is_null($this->dispatcher)) {
-			return;
-		}
-		$this->dispatcher->dispatch('\OC\DB\Migrator::executeSql', new GenericEvent($sql, [$step + 1, $max]));
-	}
-
-	private function emitCheckStep($tableName, $step, $max) {
-		if (is_null($this->dispatcher)) {
-			return;
-		}
-		$this->dispatcher->dispatch('\OC\DB\Migrator::checkTable', new GenericEvent($tableName, [$step + 1, $max]));
-	}
+    /** @var \Doctrine\DBAL\Connection */
+    protected $connection;
+
+    /** @var ISecureRandom */
+    private $random;
+
+    /** @var IConfig */
+    protected $config;
+
+    /** @var EventDispatcherInterface  */
+    private $dispatcher;
+
+    /** @var bool */
+    private $noEmit = false;
+
+    /**
+     * @param \Doctrine\DBAL\Connection $connection
+     * @param ISecureRandom $random
+     * @param IConfig $config
+     * @param EventDispatcherInterface $dispatcher
+     */
+    public function __construct(\Doctrine\DBAL\Connection $connection,
+                                ISecureRandom $random,
+                                IConfig $config,
+                                EventDispatcherInterface $dispatcher = null) {
+        $this->connection = $connection;
+        $this->random = $random;
+        $this->config = $config;
+        $this->dispatcher = $dispatcher;
+    }
+
+    /**
+     * @param \Doctrine\DBAL\Schema\Schema $targetSchema
+     *
+     * @throws Exception
+     */
+    public function migrate(Schema $targetSchema) {
+        $this->noEmit = true;
+        $this->applySchema($targetSchema);
+    }
+
+    /**
+     * @param \Doctrine\DBAL\Schema\Schema $targetSchema
+     * @return string
+     */
+    public function generateChangeScript(Schema $targetSchema) {
+        $schemaDiff = $this->getDiff($targetSchema, $this->connection);
+
+        $script = '';
+        $sqls = $schemaDiff->toSql($this->connection->getDatabasePlatform());
+        foreach ($sqls as $sql) {
+            $script .= $this->convertStatementToScript($sql);
+        }
+
+        return $script;
+    }
+
+    /**
+     * Create a unique name for the temporary table
+     *
+     * @param string $name
+     * @return string
+     */
+    protected function generateTemporaryTableName($name) {
+        return $this->config->getSystemValue('dbtableprefix', 'oc_') . $name . '_' . $this->random->generate(13, ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_DIGITS);
+    }
+
+    /**
+     * Check the migration of a table on a copy so we can detect errors before messing with the real table
+     *
+     * @param \Doctrine\DBAL\Schema\Table $table
+     * @throws \OC\DB\MigrationException
+     */
+    protected function checkTableMigrate(Table $table) {
+        $name = $table->getName();
+        $tmpName = $this->generateTemporaryTableName($name);
+
+        $this->copyTable($name, $tmpName);
+
+        //create the migration schema for the temporary table
+        $tmpTable = $this->renameTableSchema($table, $tmpName);
+        $schemaConfig = new SchemaConfig();
+        $schemaConfig->setName($this->connection->getDatabase());
+        $schema = new Schema([$tmpTable], [], $schemaConfig);
+
+        try {
+            $this->applySchema($schema);
+            $this->dropTable($tmpName);
+        } catch (Exception $e) {
+            // pgsql needs to commit it's failed transaction before doing anything else
+            if ($this->connection->isTransactionActive()) {
+                $this->connection->commit();
+            }
+            $this->dropTable($tmpName);
+            throw new MigrationException($table->getName(), $e->getMessage());
+        }
+    }
+
+    /**
+     * @param \Doctrine\DBAL\Schema\Table $table
+     * @param string $newName
+     * @return \Doctrine\DBAL\Schema\Table
+     */
+    protected function renameTableSchema(Table $table, $newName) {
+        /**
+         * @var \Doctrine\DBAL\Schema\Index[] $indexes
+         */
+        $indexes = $table->getIndexes();
+        $newIndexes = [];
+        foreach ($indexes as $index) {
+            if ($index->isPrimary()) {
+                // do not rename primary key
+                $indexName = $index->getName();
+            } else {
+                // avoid conflicts in index names
+                $indexName = $this->config->getSystemValue('dbtableprefix', 'oc_') . $this->random->generate(13, ISecureRandom::CHAR_LOWER);
+            }
+            $newIndexes[] = new Index($indexName, $index->getColumns(), $index->isUnique(), $index->isPrimary());
+        }
+
+        // foreign keys are not supported so we just set it to an empty array
+        return new Table($newName, $table->getColumns(), $newIndexes, [], [], $table->getOptions());
+    }
+
+    /**
+     * @throws Exception
+     */
+    public function createSchema() {
+        $this->connection->getConfiguration()->setSchemaAssetsFilter(function ($asset) {
+            /** @var string|AbstractAsset $asset */
+            $filterExpression = $this->getFilterExpression();
+            if ($asset instanceof AbstractAsset) {
+                return preg_match($filterExpression, $asset->getName()) !== false;
+            }
+            return preg_match($filterExpression, $asset) !== false;
+        });
+        return $this->connection->getSchemaManager()->createSchema();
+    }
+
+    /**
+     * @param Schema $targetSchema
+     * @param \Doctrine\DBAL\Connection $connection
+     * @return \Doctrine\DBAL\Schema\SchemaDiff
+     */
+    protected function getDiff(Schema $targetSchema, \Doctrine\DBAL\Connection $connection) {
+        // adjust varchar columns with a length higher then getVarcharMaxLength to clob
+        foreach ($targetSchema->getTables() as $table) {
+            foreach ($table->getColumns() as $column) {
+                if ($column->getType() instanceof StringType) {
+                    if ($column->getLength() > $connection->getDatabasePlatform()->getVarcharMaxLength()) {
+                        $column->setType(Type::getType('text'));
+                        $column->setLength(null);
+                    }
+                }
+            }
+        }
+
+        $this->connection->getConfiguration()->setSchemaAssetsFilter(function ($asset) {
+            /** @var string|AbstractAsset $asset */
+            $filterExpression = $this->getFilterExpression();
+            if ($asset instanceof AbstractAsset) {
+                return preg_match($filterExpression, $asset->getName()) !== false;
+            }
+            return preg_match($filterExpression, $asset) !== false;
+        });
+        $sourceSchema = $connection->getSchemaManager()->createSchema();
+
+        // remove tables we don't know about
+        foreach ($sourceSchema->getTables() as $table) {
+            if (!$targetSchema->hasTable($table->getName())) {
+                $sourceSchema->dropTable($table->getName());
+            }
+        }
+        // remove sequences we don't know about
+        foreach ($sourceSchema->getSequences() as $table) {
+            if (!$targetSchema->hasSequence($table->getName())) {
+                $sourceSchema->dropSequence($table->getName());
+            }
+        }
+
+        $comparator = new Comparator();
+        return $comparator->compare($sourceSchema, $targetSchema);
+    }
+
+    /**
+     * @param \Doctrine\DBAL\Schema\Schema $targetSchema
+     * @param \Doctrine\DBAL\Connection $connection
+     *
+     * @throws Exception
+     */
+    protected function applySchema(Schema $targetSchema, \Doctrine\DBAL\Connection $connection = null) {
+        if (is_null($connection)) {
+            $connection = $this->connection;
+        }
+
+        $schemaDiff = $this->getDiff($targetSchema, $connection);
+
+        if (!$connection->getDatabasePlatform() instanceof MySQLPlatform) {
+            $connection->beginTransaction();
+        }
+        $sqls = $schemaDiff->toSql($connection->getDatabasePlatform());
+        $step = 0;
+        foreach ($sqls as $sql) {
+            $this->emit($sql, $step++, count($sqls));
+            $connection->query($sql);
+        }
+        if (!$connection->getDatabasePlatform() instanceof MySQLPlatform) {
+            $connection->commit();
+        }
+    }
+
+    /**
+     * @param string $sourceName
+     * @param string $targetName
+     */
+    protected function copyTable($sourceName, $targetName) {
+        $quotedSource = $this->connection->quoteIdentifier($sourceName);
+        $quotedTarget = $this->connection->quoteIdentifier($targetName);
+
+        $this->connection->exec('CREATE TABLE ' . $quotedTarget . ' (LIKE ' . $quotedSource . ')');
+        $this->connection->exec('INSERT INTO ' . $quotedTarget . ' SELECT * FROM ' . $quotedSource);
+    }
+
+    /**
+     * @param string $name
+     */
+    protected function dropTable($name) {
+        $this->connection->exec('DROP TABLE ' . $this->connection->quoteIdentifier($name));
+    }
+
+    /**
+     * @param $statement
+     * @return string
+     */
+    protected function convertStatementToScript($statement) {
+        $script = $statement . ';';
+        $script .= PHP_EOL;
+        $script .= PHP_EOL;
+        return $script;
+    }
+
+    protected function getFilterExpression() {
+        return '/^' . preg_quote($this->config->getSystemValue('dbtableprefix', 'oc_')) . '/';
+    }
+
+    protected function emit($sql, $step, $max) {
+        if ($this->noEmit) {
+            return;
+        }
+        if (is_null($this->dispatcher)) {
+            return;
+        }
+        $this->dispatcher->dispatch('\OC\DB\Migrator::executeSql', new GenericEvent($sql, [$step + 1, $max]));
+    }
+
+    private function emitCheckStep($tableName, $step, $max) {
+        if (is_null($this->dispatcher)) {
+            return;
+        }
+        $this->dispatcher->dispatch('\OC\DB\Migrator::checkTable', new GenericEvent($tableName, [$step + 1, $max]));
+    }
 }

Spacing +9 added lines, -9 removed lines

@@ -113,7 +113,7 @@ 
 	 * @return string
 	 */
 	protected function generateTemporaryTableName($name) {
-		return $this->config->getSystemValue('dbtableprefix', 'oc_') . $name . '_' . $this->random->generate(13, ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_DIGITS);
+		return $this->config->getSystemValue('dbtableprefix', 'oc_').$name.'_'.$this->random->generate(13, ISecureRandom::CHAR_LOWER.ISecureRandom::CHAR_DIGITS);
 	}
 
 	/**
@@ -164,7 +164,7 @@ 
 				$indexName = $index->getName();
 			} else {
 				// avoid conflicts in index names
-				$indexName = $this->config->getSystemValue('dbtableprefix', 'oc_') . $this->random->generate(13, ISecureRandom::CHAR_LOWER);
+				$indexName = $this->config->getSystemValue('dbtableprefix', 'oc_').$this->random->generate(13, ISecureRandom::CHAR_LOWER);
 			}
 			$newIndexes[] = new Index($indexName, $index->getColumns(), $index->isUnique(), $index->isPrimary());
 		}
@@ -177,7 +177,7 @@ 
 	 * @throws Exception
 	 */
 	public function createSchema() {
-		$this->connection->getConfiguration()->setSchemaAssetsFilter(function ($asset) {
+		$this->connection->getConfiguration()->setSchemaAssetsFilter(function($asset) {
 			/** @var string|AbstractAsset $asset */
 			$filterExpression = $this->getFilterExpression();
 			if ($asset instanceof AbstractAsset) {
@@ -206,7 +206,7 @@ 
 			}
 		}
 
-		$this->connection->getConfiguration()->setSchemaAssetsFilter(function ($asset) {
+		$this->connection->getConfiguration()->setSchemaAssetsFilter(function($asset) {
 			/** @var string|AbstractAsset $asset */
 			$filterExpression = $this->getFilterExpression();
 			if ($asset instanceof AbstractAsset) {
@@ -268,15 +268,15 @@ 
 		$quotedSource = $this->connection->quoteIdentifier($sourceName);
 		$quotedTarget = $this->connection->quoteIdentifier($targetName);
 
-		$this->connection->exec('CREATE TABLE ' . $quotedTarget . ' (LIKE ' . $quotedSource . ')');
-		$this->connection->exec('INSERT INTO ' . $quotedTarget . ' SELECT * FROM ' . $quotedSource);
+		$this->connection->exec('CREATE TABLE '.$quotedTarget.' (LIKE '.$quotedSource.')');
+		$this->connection->exec('INSERT INTO '.$quotedTarget.' SELECT * FROM '.$quotedSource);
 	}
 
 	/**
 	 * @param string $name
 	 */
 	protected function dropTable($name) {
-		$this->connection->exec('DROP TABLE ' . $this->connection->quoteIdentifier($name));
+		$this->connection->exec('DROP TABLE '.$this->connection->quoteIdentifier($name));
 	}
 
 	/**
@@ -284,14 +284,14 @@ 
 	 * @return string
 	 */
 	protected function convertStatementToScript($statement) {
-		$script = $statement . ';';
+		$script = $statement.';';
 		$script .= PHP_EOL;
 		$script .= PHP_EOL;
 		return $script;
 	}
 
 	protected function getFilterExpression() {
-		return '/^' . preg_quote($this->config->getSystemValue('dbtableprefix', 'oc_')) . '/';
+		return '/^'.preg_quote($this->config->getSystemValue('dbtableprefix', 'oc_')).'/';
 	}
 
 	protected function emit($sql, $step, $max) {

lib/private/DB/Exceptions/DbalException.php

Indentation +78 added lines, -78 removed lines

@@ -49,88 +49,88 @@
  */
 class DbalException extends Exception {
 
-	/** @var \Doctrine\DBAL\Exception */
-	private $original;
+    /** @var \Doctrine\DBAL\Exception */
+    private $original;
 
-	/**
-	 * @param \Doctrine\DBAL\Exception $original
-	 * @param int $code
-	 * @param string $message
-	 */
-	private function __construct(\Doctrine\DBAL\Exception $original, int $code, string $message) {
-		parent::__construct(
-			$message,
-			$code,
-			$original
-		);
-		$this->original = $original;
-	}
+    /**
+     * @param \Doctrine\DBAL\Exception $original
+     * @param int $code
+     * @param string $message
+     */
+    private function __construct(\Doctrine\DBAL\Exception $original, int $code, string $message) {
+        parent::__construct(
+            $message,
+            $code,
+            $original
+        );
+        $this->original = $original;
+    }
 
-	public static function wrap(\Doctrine\DBAL\Exception $original, string $message = ''): self {
-		return new self(
-			$original,
-			is_int($original->getCode()) ? $original->getCode() : 0,
-			empty($message) ? $original->getMessage() : $message
-		);
-	}
+    public static function wrap(\Doctrine\DBAL\Exception $original, string $message = ''): self {
+        return new self(
+            $original,
+            is_int($original->getCode()) ? $original->getCode() : 0,
+            empty($message) ? $original->getMessage() : $message
+        );
+    }
 
-	public function getReason(): ?int {
-		/**
-		 * Generic errors
-		 */
-		if ($this->original instanceof ConnectionException) {
-			return parent::REASON_CONNECTION_LOST;
-		}
-		if ($this->original instanceof DriverException) {
-			return parent::REASON_DRIVER;
-		}
-		if ($this->original instanceof InvalidArgumentException) {
-			return parent::REASON_INVALID_ARGUMENT;
-		}
+    public function getReason(): ?int {
+        /**
+         * Generic errors
+         */
+        if ($this->original instanceof ConnectionException) {
+            return parent::REASON_CONNECTION_LOST;
+        }
+        if ($this->original instanceof DriverException) {
+            return parent::REASON_DRIVER;
+        }
+        if ($this->original instanceof InvalidArgumentException) {
+            return parent::REASON_INVALID_ARGUMENT;
+        }
 
-		/**
-		 * Constraint errors
-		 */
-		if ($this->original instanceof ForeignKeyConstraintViolationException) {
-			return parent::REASON_FOREIGN_KEY_VIOLATION;
-		}
-		if ($this->original instanceof NotNullConstraintViolationException) {
-			return parent::REASON_NOT_NULL_CONSTRAINT_VIOLATION;
-		}
-		if ($this->original instanceof UniqueConstraintViolationException) {
-			return parent::REASON_UNIQUE_CONSTRAINT_VIOLATION;
-		}
-		// The base exception comes last
-		if ($this->original instanceof ConstraintViolationException) {
-			return parent::REASON_CONSTRAINT_VIOLATION;
-		}
+        /**
+         * Constraint errors
+         */
+        if ($this->original instanceof ForeignKeyConstraintViolationException) {
+            return parent::REASON_FOREIGN_KEY_VIOLATION;
+        }
+        if ($this->original instanceof NotNullConstraintViolationException) {
+            return parent::REASON_NOT_NULL_CONSTRAINT_VIOLATION;
+        }
+        if ($this->original instanceof UniqueConstraintViolationException) {
+            return parent::REASON_UNIQUE_CONSTRAINT_VIOLATION;
+        }
+        // The base exception comes last
+        if ($this->original instanceof ConstraintViolationException) {
+            return parent::REASON_CONSTRAINT_VIOLATION;
+        }
 
-		/**
-		 * Other server errors
-		 */
-		if ($this->original instanceof DatabaseObjectExistsException) {
-			return parent::REASON_DATABASE_OBJECT_EXISTS;
-		}
-		if ($this->original instanceof DatabaseObjectNotFoundException) {
-			return parent::REASON_DATABASE_OBJECT_NOT_FOUND;
-		}
-		if ($this->original instanceof DeadlockException) {
-			return parent::REASON_DEADLOCK;
-		}
-		if ($this->original instanceof InvalidFieldNameException) {
-			return parent::REASON_INVALID_FIELD_NAME;
-		}
-		if ($this->original instanceof NonUniqueFieldNameException) {
-			return parent::REASON_NON_UNIQUE_FIELD_NAME;
-		}
-		if ($this->original instanceof SyntaxErrorException) {
-			return parent::REASON_SYNTAX_ERROR;
-		}
-		// The base server exception class comes last
-		if ($this->original instanceof ServerException) {
-			return parent::REASON_SERVER;
-		}
+        /**
+         * Other server errors
+         */
+        if ($this->original instanceof DatabaseObjectExistsException) {
+            return parent::REASON_DATABASE_OBJECT_EXISTS;
+        }
+        if ($this->original instanceof DatabaseObjectNotFoundException) {
+            return parent::REASON_DATABASE_OBJECT_NOT_FOUND;
+        }
+        if ($this->original instanceof DeadlockException) {
+            return parent::REASON_DEADLOCK;
+        }
+        if ($this->original instanceof InvalidFieldNameException) {
+            return parent::REASON_INVALID_FIELD_NAME;
+        }
+        if ($this->original instanceof NonUniqueFieldNameException) {
+            return parent::REASON_NON_UNIQUE_FIELD_NAME;
+        }
+        if ($this->original instanceof SyntaxErrorException) {
+            return parent::REASON_SYNTAX_ERROR;
+        }
+        // The base server exception class comes last
+        if ($this->original instanceof ServerException) {
+            return parent::REASON_SERVER;
+        }
 
-		return null;
-	}
+        return null;
+    }
 }

lib/private/DB/ConnectionAdapter.php

Indentation +204 added lines, -204 removed lines

@@ -39,208 +39,208 @@
  */
 class ConnectionAdapter implements IDBConnection {
 
-	/** @var Connection */
-	private $inner;
-
-	public function __construct(Connection $inner) {
-		$this->inner = $inner;
-	}
-
-	public function getQueryBuilder(): IQueryBuilder {
-		return $this->inner->getQueryBuilder();
-	}
-
-	public function prepare($sql, $limit = null, $offset = null): IPreparedStatement {
-		try {
-			return new PreparedStatement(
-				$this->inner->prepare($sql, $limit, $offset)
-			);
-		} catch (Exception $e) {
-			throw DbalException::wrap($e);
-		}
-	}
-
-	public function executeQuery(string $sql, array $params = [], $types = []): IResult {
-		try {
-			return new ResultAdapter(
-				$this->inner->executeQuery($sql, $params, $types)
-			);
-		} catch (Exception $e) {
-			throw DbalException::wrap($e);
-		}
-	}
-
-	public function executeUpdate(string $sql, array $params = [], array $types = []): int {
-		try {
-			return $this->inner->executeUpdate($sql, $params, $types);
-		} catch (Exception $e) {
-			throw DbalException::wrap($e);
-		}
-	}
-
-	public function executeStatement($sql, array $params = [], array $types = []): int {
-		try {
-			return $this->inner->executeStatement($sql, $params, $types);
-		} catch (Exception $e) {
-			throw DbalException::wrap($e);
-		}
-	}
-
-	public function lastInsertId(string $table): int {
-		try {
-			return (int)$this->inner->lastInsertId($table);
-		} catch (Exception $e) {
-			throw DbalException::wrap($e);
-		}
-	}
-
-	public function insertIfNotExist(string $table, array $input, array $compare = null) {
-		try {
-			return $this->inner->insertIfNotExist($table, $input, $compare);
-		} catch (Exception $e) {
-			throw DbalException::wrap($e);
-		}
-	}
-
-	public function insertIgnoreConflict(string $table, array $values): int {
-		try {
-			return $this->inner->insertIgnoreConflict($table, $values);
-		} catch (Exception $e) {
-			throw DbalException::wrap($e);
-		}
-	}
-
-	public function setValues($table, array $keys, array $values, array $updatePreconditionValues = []): int {
-		try {
-			return $this->inner->setValues($table, $keys, $values, $updatePreconditionValues);
-		} catch (Exception $e) {
-			throw DbalException::wrap($e);
-		}
-	}
-
-	public function lockTable($tableName): void {
-		try {
-			$this->inner->lockTable($tableName);
-		} catch (Exception $e) {
-			throw DbalException::wrap($e);
-		}
-	}
-
-	public function unlockTable(): void {
-		try {
-			$this->inner->unlockTable();
-		} catch (Exception $e) {
-			throw DbalException::wrap($e);
-		}
-	}
-
-	public function beginTransaction(): void {
-		try {
-			$this->inner->beginTransaction();
-		} catch (Exception $e) {
-			throw DbalException::wrap($e);
-		}
-	}
-
-	public function inTransaction(): bool {
-		return $this->inner->inTransaction();
-	}
-
-	public function commit(): void {
-		try {
-			$this->inner->commit();
-		} catch (Exception $e) {
-			throw DbalException::wrap($e);
-		}
-	}
-
-	public function rollBack(): void {
-		try {
-			$this->inner->rollBack();
-		} catch (Exception $e) {
-			throw DbalException::wrap($e);
-		}
-	}
-
-	public function getError(): string {
-		return $this->inner->getError();
-	}
-
-	public function errorCode() {
-		return $this->inner->errorCode();
-	}
-
-	public function errorInfo() {
-		return $this->inner->errorInfo();
-	}
-
-	public function connect(): bool {
-		try {
-			return $this->inner->connect();
-		} catch (Exception $e) {
-			throw DbalException::wrap($e);
-		}
-	}
-
-	public function close(): void {
-		$this->inner->close();
-	}
-
-	public function quote($input, $type = IQueryBuilder::PARAM_STR) {
-		return $this->inner->quote($input, $type);
-	}
-
-	/**
-	 * @todo we are leaking a 3rdparty type here
-	 */
-	public function getDatabasePlatform(): AbstractPlatform {
-		return $this->inner->getDatabasePlatform();
-	}
-
-	public function dropTable(string $table): void {
-		try {
-			$this->inner->dropTable($table);
-		} catch (Exception $e) {
-			throw DbalException::wrap($e);
-		}
-	}
-
-	public function tableExists(string $table): bool {
-		try {
-			return $this->inner->tableExists($table);
-		} catch (Exception $e) {
-			throw DbalException::wrap($e);
-		}
-	}
-
-	public function escapeLikeParameter(string $param): string {
-		return $this->inner->escapeLikeParameter($param);
-	}
-
-	public function supports4ByteText(): bool {
-		return $this->inner->supports4ByteText();
-	}
-
-	/**
-	 * @todo leaks a 3rdparty type
-	 */
-	public function createSchema(): Schema {
-		try {
-			return $this->inner->createSchema();
-		} catch (Exception $e) {
-			throw DbalException::wrap($e);
-		}
-	}
-
-	public function migrateToSchema(Schema $toSchema): void {
-		try {
-			$this->inner->migrateToSchema($toSchema);
-		} catch (Exception $e) {
-			throw DbalException::wrap($e);
-		}
-	}
-
-	public function getInner(): Connection {
-		return $this->inner;
-	}
+    /** @var Connection */
+    private $inner;
+
+    public function __construct(Connection $inner) {
+        $this->inner = $inner;
+    }
+
+    public function getQueryBuilder(): IQueryBuilder {
+        return $this->inner->getQueryBuilder();
+    }
+
+    public function prepare($sql, $limit = null, $offset = null): IPreparedStatement {
+        try {
+            return new PreparedStatement(
+                $this->inner->prepare($sql, $limit, $offset)
+            );
+        } catch (Exception $e) {
+            throw DbalException::wrap($e);
+        }
+    }
+
+    public function executeQuery(string $sql, array $params = [], $types = []): IResult {
+        try {
+            return new ResultAdapter(
+                $this->inner->executeQuery($sql, $params, $types)
+            );
+        } catch (Exception $e) {
+            throw DbalException::wrap($e);
+        }
+    }
+
+    public function executeUpdate(string $sql, array $params = [], array $types = []): int {
+        try {
+            return $this->inner->executeUpdate($sql, $params, $types);
+        } catch (Exception $e) {
+            throw DbalException::wrap($e);
+        }
+    }
+
+    public function executeStatement($sql, array $params = [], array $types = []): int {
+        try {
+            return $this->inner->executeStatement($sql, $params, $types);
+        } catch (Exception $e) {
+            throw DbalException::wrap($e);
+        }
+    }
+
+    public function lastInsertId(string $table): int {
+        try {
+            return (int)$this->inner->lastInsertId($table);
+        } catch (Exception $e) {
+            throw DbalException::wrap($e);
+        }
+    }
+
+    public function insertIfNotExist(string $table, array $input, array $compare = null) {
+        try {
+            return $this->inner->insertIfNotExist($table, $input, $compare);
+        } catch (Exception $e) {
+            throw DbalException::wrap($e);
+        }
+    }
+
+    public function insertIgnoreConflict(string $table, array $values): int {
+        try {
+            return $this->inner->insertIgnoreConflict($table, $values);
+        } catch (Exception $e) {
+            throw DbalException::wrap($e);
+        }
+    }
+
+    public function setValues($table, array $keys, array $values, array $updatePreconditionValues = []): int {
+        try {
+            return $this->inner->setValues($table, $keys, $values, $updatePreconditionValues);
+        } catch (Exception $e) {
+            throw DbalException::wrap($e);
+        }
+    }
+
+    public function lockTable($tableName): void {
+        try {
+            $this->inner->lockTable($tableName);
+        } catch (Exception $e) {
+            throw DbalException::wrap($e);
+        }
+    }
+
+    public function unlockTable(): void {
+        try {
+            $this->inner->unlockTable();
+        } catch (Exception $e) {
+            throw DbalException::wrap($e);
+        }
+    }
+
+    public function beginTransaction(): void {
+        try {
+            $this->inner->beginTransaction();
+        } catch (Exception $e) {
+            throw DbalException::wrap($e);
+        }
+    }
+
+    public function inTransaction(): bool {
+        return $this->inner->inTransaction();
+    }
+
+    public function commit(): void {
+        try {
+            $this->inner->commit();
+        } catch (Exception $e) {
+            throw DbalException::wrap($e);
+        }
+    }
+
+    public function rollBack(): void {
+        try {
+            $this->inner->rollBack();
+        } catch (Exception $e) {
+            throw DbalException::wrap($e);
+        }
+    }
+
+    public function getError(): string {
+        return $this->inner->getError();
+    }
+
+    public function errorCode() {
+        return $this->inner->errorCode();
+    }
+
+    public function errorInfo() {
+        return $this->inner->errorInfo();
+    }
+
+    public function connect(): bool {
+        try {
+            return $this->inner->connect();
+        } catch (Exception $e) {
+            throw DbalException::wrap($e);
+        }
+    }
+
+    public function close(): void {
+        $this->inner->close();
+    }
+
+    public function quote($input, $type = IQueryBuilder::PARAM_STR) {
+        return $this->inner->quote($input, $type);
+    }
+
+    /**
+     * @todo we are leaking a 3rdparty type here
+     */
+    public function getDatabasePlatform(): AbstractPlatform {
+        return $this->inner->getDatabasePlatform();
+    }
+
+    public function dropTable(string $table): void {
+        try {
+            $this->inner->dropTable($table);
+        } catch (Exception $e) {
+            throw DbalException::wrap($e);
+        }
+    }
+
+    public function tableExists(string $table): bool {
+        try {
+            return $this->inner->tableExists($table);
+        } catch (Exception $e) {
+            throw DbalException::wrap($e);
+        }
+    }
+
+    public function escapeLikeParameter(string $param): string {
+        return $this->inner->escapeLikeParameter($param);
+    }
+
+    public function supports4ByteText(): bool {
+        return $this->inner->supports4ByteText();
+    }
+
+    /**
+     * @todo leaks a 3rdparty type
+     */
+    public function createSchema(): Schema {
+        try {
+            return $this->inner->createSchema();
+        } catch (Exception $e) {
+            throw DbalException::wrap($e);
+        }
+    }
+
+    public function migrateToSchema(Schema $toSchema): void {
+        try {
+            $this->inner->migrateToSchema($toSchema);
+        } catch (Exception $e) {
+            throw DbalException::wrap($e);
+        }
+    }
+
+    public function getInner(): Connection {
+        return $this->inner;
+    }
 }

Spacing +1 added lines, -1 removed lines

@@ -88,7 +88,7 @@
 
 	public function lastInsertId(string $table): int {
 		try {
-			return (int)$this->inner->lastInsertId($table);
+			return (int) $this->inner->lastInsertId($table);
 		} catch (Exception $e) {
 			throw DbalException::wrap($e);
 		}