From 1bfb944d515c88f915739c3b920d39d6da200d29 Mon Sep 17 00:00:00 2001
From: Joas Schilling <nickvergessen@owncloud.com>
Date: Mon, 6 Jul 2015 12:00:01 +0200
Subject: [PATCH] Add QueryBuilder, ExpressionBuilder and CompositeExpression
wrappers
---
lib/private/appframework/db/db.php | 18 +
lib/private/db/compositeexpression.php | 92 +++
lib/private/db/connection.php | 18 +
lib/private/db/expressionbuilder.php | 282 ++++++++
lib/private/db/querybuilder.php | 865 +++++++++++++++++++++++++
lib/public/db/icompositeexpression.php | 64 ++
lib/public/db/iexpressionbuilder.php | 252 +++++++
lib/public/db/iquerybuilder.php | 742 +++++++++++++++++++++
lib/public/idbconnection.php | 16 +
9 files changed, 2349 insertions(+)
create mode 100644 lib/private/db/compositeexpression.php
create mode 100644 lib/private/db/expressionbuilder.php
create mode 100644 lib/private/db/querybuilder.php
create mode 100644 lib/public/db/icompositeexpression.php
create mode 100644 lib/public/db/iexpressionbuilder.php
create mode 100644 lib/public/db/iquerybuilder.php
diff --git a/lib/private/appframework/db/db.php b/lib/private/appframework/db/db.php
index d05cd44b54c..529962002ac 100644
--- a/lib/private/appframework/db/db.php
+++ b/lib/private/appframework/db/db.php
@@ -45,6 +45,24 @@ class Db implements IDb {
$this->connection = $connection;
}
+ /**
+ * Gets the ExpressionBuilder for the connection.
+ *
+ * @return \OCP\DB\IExpressionBuilder
+ */
+ public function getExpressionBuilder() {
+ return $this->connection->getExpressionBuilder();
+ }
+
+ /**
+ * Gets the ExpressionBuilder for the connection.
+ *
+ * @return \OCP\DB\IQueryBuilder
+ */
+ public function getQueryBuilder() {
+ return $this->connection->getQueryBuilder();
+ }
+
/**
* Used to abstract the ownCloud database access away
*
diff --git a/lib/private/db/compositeexpression.php b/lib/private/db/compositeexpression.php
new file mode 100644
index 00000000000..cc57c524369
--- /dev/null
+++ b/lib/private/db/compositeexpression.php
@@ -0,0 +1,92 @@
+<?php
+/**
+ * @author Joas Schilling <nickvergessen@owncloud.com>
+ *
+ * @copyright Copyright (c) 2015, ownCloud, Inc.
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program. If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OC\DB;
+
+use OCP\DB\ICompositeExpression;
+
+class CompositeExpression implements ICompositeExpression, \Countable {
+ /** @var \Doctrine\DBAL\Query\Expression\CompositeExpression */
+ protected $compositeExpression;
+
+ /**
+ * Constructor.
+ *
+ * @param \Doctrine\DBAL\Query\Expression\CompositeExpression $compositeExpression
+ */
+ public function __construct(\Doctrine\DBAL\Query\Expression\CompositeExpression $compositeExpression) {
+ $this->compositeExpression = $compositeExpression;
+ }
+
+ /**
+ * Adds multiple parts to composite expression.
+ *
+ * @param array $parts
+ *
+ * @return \OCP\DB\ICompositeExpression
+ */
+ public function addMultiple(array $parts = array()) {
+ $this->compositeExpression->addMultiple($parts);
+
+ return $this;
+ }
+
+ /**
+ * Adds an expression to composite expression.
+ *
+ * @param mixed $part
+ *
+ * @return \OCP\DB\ICompositeExpression
+ */
+ public function add($part) {
+ $this->compositeExpression->add($part);
+
+ return $this;
+ }
+
+ /**
+ * Retrieves the amount of expressions on composite expression.
+ *
+ * @return integer
+ */
+ public function count() {
+ return $this->compositeExpression->count();
+ }
+
+ /**
+ * Returns the type of this composite expression (AND/OR).
+ *
+ * @return string
+ */
+ public function getType() {
+ return $this->compositeExpression->getType();
+ }
+
+ /**
+ * Retrieves the string representation of this composite expression.
+ *
+ * @return string
+ */
+ public function __toString()
+ {
+ return (string) $this->compositeExpression;
+ }
+}
diff --git a/lib/private/db/connection.php b/lib/private/db/connection.php
index a36bd2649df..9bb54883bf4 100644
--- a/lib/private/db/connection.php
+++ b/lib/private/db/connection.php
@@ -51,6 +51,24 @@ class Connection extends \Doctrine\DBAL\Connection implements IDBConnection {
}
}
+ /**
+ * Gets the ExpressionBuilder for the connection.
+ *
+ * @return \OCP\DB\IExpressionBuilder
+ */
+ public function getExpressionBuilder() {
+ return new ExpressionBuilder($this);
+ }
+
+ /**
+ * Gets the QueryBuilder for the connection.
+ *
+ * @return \OCP\DB\IQueryBuilder
+ */
+ public function getQueryBuilder() {
+ return new QueryBuilder($this);
+ }
+
/**
* @return string
*/
diff --git a/lib/private/db/expressionbuilder.php b/lib/private/db/expressionbuilder.php
new file mode 100644
index 00000000000..f042664d960
--- /dev/null
+++ b/lib/private/db/expressionbuilder.php
@@ -0,0 +1,282 @@
+<?php
+/**
+ * @author Joas Schilling <nickvergessen@owncloud.com>
+ *
+ * @copyright Copyright (c) 2015, ownCloud, Inc.
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program. If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OC\DB;
+
+use Doctrine\DBAL\Query\Expression\ExpressionBuilder as DoctrineExpressionBuilder;
+use OCP\DB\IExpressionBuilder;
+use OCP\IDBConnection;
+
+class ExpressionBuilder implements IExpressionBuilder {
+ /** @var \Doctrine\DBAL\Query\Expression\ExpressionBuilder */
+ private $expressionBuilder;
+
+ /**
+ * Initializes a new <tt>ExpressionBuilder</tt>.
+ *
+ * @param \OCP\IDBConnection $connection
+ */
+ public function __construct(IDBConnection $connection) {
+ $this->expressionBuilder = new DoctrineExpressionBuilder($connection);
+ }
+
+ /**
+ * Creates a conjunction of the given boolean expressions.
+ *
+ * Example:
+ *
+ * [php]
+ * // (u.type = ?) AND (u.role = ?)
+ * $expr->andX('u.type = ?', 'u.role = ?'));
+ *
+ * @param mixed $x Optional clause. Defaults = null, but requires
+ * at least one defined when converting to string.
+ *
+ * @return \OCP\DB\ICompositeExpression
+ */
+ public function andX($x = null) {
+ $compositeExpression = call_user_func_array([$this->expressionBuilder, 'andX'], func_get_args());
+ return new CompositeExpression($compositeExpression);
+ }
+
+ /**
+ * Creates a disjunction of the given boolean expressions.
+ *
+ * Example:
+ *
+ * [php]
+ * // (u.type = ?) OR (u.role = ?)
+ * $qb->where($qb->expr()->orX('u.type = ?', 'u.role = ?'));
+ *
+ * @param mixed $x Optional clause. Defaults = null, but requires
+ * at least one defined when converting to string.
+ *
+ * @return \OCP\DB\ICompositeExpression
+ */
+ public function orX($x = null) {
+ $compositeExpression = call_user_func_array([$this->expressionBuilder, 'orX'], func_get_args());
+ return new CompositeExpression($compositeExpression);
+ }
+
+ /**
+ * Creates a comparison expression.
+ *
+ * @param mixed $x The left expression.
+ * @param string $operator One of the ExpressionBuilder::* constants.
+ * @param mixed $y The right expression.
+ *
+ * @return string
+ */
+ public function comparison($x, $operator, $y) {
+ return $this->expressionBuilder->comparison($x, $operator, $y);
+ }
+
+ /**
+ * Creates an equality comparison expression with the given arguments.
+ *
+ * First argument is considered the left expression and the second is the right expression.
+ * When converted to string, it will generated a <left expr> = <right expr>. Example:
+ *
+ * [php]
+ * // u.id = ?
+ * $expr->eq('u.id', '?');
+ *
+ * @param mixed $x The left expression.
+ * @param mixed $y The right expression.
+ *
+ * @return string
+ */
+ public function eq($x, $y) {
+ return $this->expressionBuilder->eq($x, $y);
+ }
+
+ /**
+ * Creates a non equality comparison expression with the given arguments.
+ * First argument is considered the left expression and the second is the right expression.
+ * When converted to string, it will generated a <left expr> <> <right expr>. Example:
+ *
+ * [php]
+ * // u.id <> 1
+ * $q->where($q->expr()->neq('u.id', '1'));
+ *
+ * @param mixed $x The left expression.
+ * @param mixed $y The right expression.
+ *
+ * @return string
+ */
+ public function neq($x, $y) {
+ return $this->expressionBuilder->neq($x, $y);
+ }
+
+ /**
+ * Creates a lower-than comparison expression with the given arguments.
+ * First argument is considered the left expression and the second is the right expression.
+ * When converted to string, it will generated a <left expr> < <right expr>. Example:
+ *
+ * [php]
+ * // u.id < ?
+ * $q->where($q->expr()->lt('u.id', '?'));
+ *
+ * @param mixed $x The left expression.
+ * @param mixed $y The right expression.
+ *
+ * @return string
+ */
+ public function lt($x, $y) {
+ return $this->expressionBuilder->lt($x, $y);
+ }
+
+ /**
+ * Creates a lower-than-equal comparison expression with the given arguments.
+ * First argument is considered the left expression and the second is the right expression.
+ * When converted to string, it will generated a <left expr> <= <right expr>. Example:
+ *
+ * [php]
+ * // u.id <= ?
+ * $q->where($q->expr()->lte('u.id', '?'));
+ *
+ * @param mixed $x The left expression.
+ * @param mixed $y The right expression.
+ *
+ * @return string
+ */
+ public function lte($x, $y) {
+ return $this->expressionBuilder->lte($x, $y);
+ }
+
+ /**
+ * Creates a greater-than comparison expression with the given arguments.
+ * First argument is considered the left expression and the second is the right expression.
+ * When converted to string, it will generated a <left expr> > <right expr>. Example:
+ *
+ * [php]
+ * // u.id > ?
+ * $q->where($q->expr()->gt('u.id', '?'));
+ *
+ * @param mixed $x The left expression.
+ * @param mixed $y The right expression.
+ *
+ * @return string
+ */
+ public function gt($x, $y) {
+ return $this->expressionBuilder->gt($x, $y);
+ }
+
+ /**
+ * Creates a greater-than-equal comparison expression with the given arguments.
+ * First argument is considered the left expression and the second is the right expression.
+ * When converted to string, it will generated a <left expr> >= <right expr>. Example:
+ *
+ * [php]
+ * // u.id >= ?
+ * $q->where($q->expr()->gte('u.id', '?'));
+ *
+ * @param mixed $x The left expression.
+ * @param mixed $y The right expression.
+ *
+ * @return string
+ */
+ public function gte($x, $y) {
+ return $this->expressionBuilder->gte($x, $y);
+ }
+
+ /**
+ * Creates an IS NULL expression with the given arguments.
+ *
+ * @param string $x The field in string format to be restricted by IS NULL.
+ *
+ * @return string
+ */
+ public function isNull($x) {
+ return $this->expressionBuilder->isNull($x);
+ }
+
+ /**
+ * Creates an IS NOT NULL expression with the given arguments.
+ *
+ * @param string $x The field in string format to be restricted by IS NOT NULL.
+ *
+ * @return string
+ */
+ public function isNotNull($x) {
+ return $this->expressionBuilder->isNotNull($x);
+ }
+
+ /**
+ * Creates a LIKE() comparison expression with the given arguments.
+ *
+ * @param string $x Field in string format to be inspected by LIKE() comparison.
+ * @param mixed $y Argument to be used in LIKE() comparison.
+ *
+ * @return string
+ */
+ public function like($x, $y) {
+ return $this->expressionBuilder->like($x, $y);
+ }
+
+ /**
+ * Creates a NOT LIKE() comparison expression with the given arguments.
+ *
+ * @param string $x Field in string format to be inspected by NOT LIKE() comparison.
+ * @param mixed $y Argument to be used in NOT LIKE() comparison.
+ *
+ * @return string
+ */
+ public function notLike($x, $y) {
+ return $this->expressionBuilder->notLike($x, $y);
+ }
+
+ /**
+ * Creates a IN () comparison expression with the given arguments.
+ *
+ * @param string $x The field in string format to be inspected by IN() comparison.
+ * @param string|array $y The placeholder or the array of values to be used by IN() comparison.
+ *
+ * @return string
+ */
+ public function in($x, $y) {
+ return $this->expressionBuilder->in($x, $y);
+ }
+
+ /**
+ * Creates a NOT IN () comparison expression with the given arguments.
+ *
+ * @param string $x The field in string format to be inspected by NOT IN() comparison.
+ * @param string|array $y The placeholder or the array of values to be used by NOT IN() comparison.
+ *
+ * @return string
+ */
+ public function notIn($x, $y) {
+ return $this->expressionBuilder->notIn($x, $y);
+ }
+
+ /**
+ * Quotes a given input parameter.
+ *
+ * @param mixed $input The parameter to be quoted.
+ * @param string|null $type The type of the parameter.
+ *
+ * @return string
+ */
+ public function literal($input, $type = null) {
+ return $this->expressionBuilder->literal($input, $type);
+ }
+}
diff --git a/lib/private/db/querybuilder.php b/lib/private/db/querybuilder.php
new file mode 100644
index 00000000000..9ae07aeb0fd
--- /dev/null
+++ b/lib/private/db/querybuilder.php
@@ -0,0 +1,865 @@
+<?php
+/**
+ * @author Joas Schilling <nickvergessen@owncloud.com>
+ *
+ * @copyright Copyright (c) 2015, ownCloud, Inc.
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program. If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OC\DB;
+
+use OCP\DB\IQueryBuilder;
+use OCP\IDBConnection;
+
+class QueryBuilder implements IQueryBuilder {
+
+ /** @var \OCP\IDBConnection */
+ private $connection;
+
+ /** @var \Doctrine\DBAL\Query\QueryBuilder */
+ private $queryBuilder;
+
+ /**
+ * Initializes a new <tt>QueryBuilder</tt>.
+ *
+ * @var \OCP\IDBConnection
+ */
+ public function __construct(IDBConnection $connection)
+ {
+ $this->connection = $connection;
+ $this->queryBuilder = new \Doctrine\DBAL\Query\QueryBuilder($this->connection);
+ }
+
+ /**
+ * 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\IExpressionBuilder
+ */
+ public function expr() {
+ return $this->connection->getExpressionBuilder();
+ }
+
+ /**
+ * Gets the type of the currently built query.
+ *
+ * @return integer
+ */
+ public function getType() {
+ return $this->queryBuilder->getType();
+ }
+
+ /**
+ * Gets the associated DBAL Connection for this query builder.
+ *
+ * @return \OCP\IDBConnection
+ */
+ public function getConnection() {
+ return $this->connection;
+ }
+
+ /**
+ * Gets the state of this query builder instance.
+ *
+ * @return integer Either QueryBuilder::STATE_DIRTY or QueryBuilder::STATE_CLEAN.
+ */
+ public function getState() {
+ return $this->queryBuilder->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.
+ *
+ * @return \Doctrine\DBAL\Driver\Statement|int
+ */
+ public function execute() {
+ return $this->queryBuilder->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.
+ */
+ public function getSQL() {
+ return $this->queryBuilder->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 $type One of the PDO::PARAM_* constants.
+ *
+ * @return \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ */
+ public function setParameter($key, $value, $type = null) {
+ $this->queryBuilder->setParameter($key, $value, $type);
+
+ return $this;
+ }
+
+ /**
+ * 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 \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ */
+ public function setParameters(array $params, array $types = array()) {
+ $this->queryBuilder->setParameters($params, $types);
+
+ return $this;
+ }
+
+ /**
+ * 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.
+ */
+ public function getParameters() {
+ return $this->queryBuilder->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.
+ */
+ public function getParameter($key) {
+ return $this->queryBuilder->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.
+ */
+ public function getParameterTypes() {
+ return $this->queryBuilder->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.
+ */
+ public function getParameterType($key) {
+ return $this->queryBuilder->getParameterType($key);
+ }
+
+ /**
+ * Sets the position of the first result to retrieve (the "offset").
+ *
+ * @param integer $firstResult The first result to return.
+ *
+ * @return \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ */
+ public function setFirstResult($firstResult) {
+ $this->queryBuilder->setFirstResult($firstResult);
+
+ return $this;
+ }
+
+ /**
+ * 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.
+ */
+ public function getFirstResult() {
+ return $this->queryBuilder->getFirstResult();
+ }
+
+ /**
+ * Sets the maximum number of results to retrieve (the "limit").
+ *
+ * @param integer $maxResults The maximum number of results to retrieve.
+ *
+ * @return \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ */
+ public function setMaxResults($maxResults) {
+ $this->queryBuilder->setMaxResults($maxResults);
+
+ return $this;
+ }
+
+ /**
+ * 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 integer The maximum number of results.
+ */
+ public function getMaxResults() {
+ return $this->queryBuilder->getMaxResults();
+ }
+
+ /**
+ * Either appends to or replaces a single, generic query part.
+ *
+ * The available parts are: 'select', 'from', 'set', 'where',
+ * 'groupBy', 'having' and 'orderBy'.
+ *
+ * @param string $sqlPartName
+ * @param string $sqlPart
+ * @param boolean $append
+ *
+ * @return \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ */
+ public function add($sqlPartName, $sqlPart, $append = false) {
+ $this->queryBuilder->add($sqlPartName, $sqlPart, $append);
+
+ return $this;
+ }
+
+ /**
+ * 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 $select The selection expressions.
+ *
+ * @return \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ */
+ public function select($select = null) {
+ $this->queryBuilder->select($select);
+
+ return $this;
+ }
+
+ /**
+ * 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 \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ */
+ public function addSelect($select = null) {
+ $this->queryBuilder->addSelect($select);
+
+ return $this;
+ }
+
+ /**
+ * 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 \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ */
+ public function delete($delete = null, $alias = null) {
+ $this->queryBuilder->delete($delete, $alias);
+
+ return $this;
+ }
+
+ /**
+ * 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 \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ */
+ public function update($update = null, $alias = null) {
+ $this->queryBuilder->update($update, $alias);
+
+ return $this;
+ }
+
+ /**
+ * 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 \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ */
+ public function insert($insert = null) {
+ $this->queryBuilder->insert($insert);
+
+ return $this;
+ }
+
+ /**
+ * 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 \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ */
+ public function from($from, $alias = null) {
+ $this->queryBuilder->from($from, $alias);
+
+ return $this;
+ }
+
+ /**
+ * 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 \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ */
+ public function join($fromAlias, $join, $alias, $condition = null) {
+ $this->queryBuilder->join($fromAlias, $join, $alias, $condition);
+
+ return $this;
+ }
+
+ /**
+ * 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 \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ */
+ public function innerJoin($fromAlias, $join, $alias, $condition = null) {
+ $this->queryBuilder->innerJoin($fromAlias, $join, $alias, $condition);
+
+ return $this;
+ }
+
+ /**
+ * 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 \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ */
+ public function leftJoin($fromAlias, $join, $alias, $condition = null) {
+ $this->queryBuilder->leftJoin($fromAlias, $join, $alias, $condition);
+
+ return $this;
+ }
+
+ /**
+ * 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 \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ */
+ public function rightJoin($fromAlias, $join, $alias, $condition = null) {
+ $this->queryBuilder->rightJoin($fromAlias, $join, $alias, $condition);
+
+ return $this;
+ }
+
+ /**
+ * 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 string $value The value, expression, placeholder, etc.
+ *
+ * @return \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ */
+ public function set($key, $value) {
+ $this->queryBuilder->set($key, $value);
+
+ return $this;
+ }
+
+ /**
+ * 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 \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ */
+ public function where($predicates) {
+ call_user_func_array([$this->queryBuilder, 'where'], func_get_args());
+
+ return $this;
+ }
+
+ /**
+ * 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 \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ *
+ * @see where()
+ */
+ public function andWhere($where) {
+ call_user_func_array([$this->queryBuilder, 'andWhere'], func_get_args());
+
+ return $this;
+ }
+
+ /**
+ * 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 \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ *
+ * @see where()
+ */
+ public function orWhere($where) {
+ call_user_func_array([$this->queryBuilder, 'orWhere'], func_get_args());
+
+ return $this;
+ }
+
+ /**
+ * 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 $groupBy The grouping expression.
+ *
+ * @return \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ */
+ public function groupBy($groupBy) {
+ call_user_func_array([$this->queryBuilder, 'groupBy'], func_get_args());
+
+ return $this;
+ }
+
+ /**
+ * 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 \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ */
+ public function addGroupBy($groupBy) {
+ call_user_func_array([$this->queryBuilder, 'addGroupBy'], func_get_args());
+
+ return $this;
+ }
+
+ /**
+ * 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 string $value The value that should be inserted into the column.
+ *
+ * @return \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ */
+ public function setValue($column, $value) {
+ $this->queryBuilder->setValue($column, $value);
+
+ return $this;
+ }
+
+ /**
+ * 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 \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ */
+ public function values(array $values) {
+ $this->queryBuilder->values($values);
+
+ return $this;
+ }
+
+ /**
+ * 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 \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ */
+ public function having($having) {
+ call_user_func_array([$this->queryBuilder, 'having'], func_get_args());
+
+ return $this;
+ }
+
+ /**
+ * 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 \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ */
+ public function andHaving($having) {
+ call_user_func_array([$this->queryBuilder, 'andHaving'], func_get_args());
+
+ return $this;
+ }
+
+ /**
+ * 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 \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ */
+ public function orHaving($having) {
+ call_user_func_array([$this->queryBuilder, 'orHaving'], func_get_args());
+
+ return $this;
+ }
+
+ /**
+ * 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 \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ */
+ public function orderBy($sort, $order = null) {
+ $this->queryBuilder->orderBy($sort, $order);
+
+ return $this;
+ }
+
+ /**
+ * Adds an ordering to the query results.
+ *
+ * @param string $sort The ordering expression.
+ * @param string $order The ordering direction.
+ *
+ * @return \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ */
+ public function addOrderBy($sort, $order = null) {
+ $this->queryBuilder->addOrderBy($sort, $order);
+
+ return $this;
+ }
+
+ /**
+ * Gets a query part by its name.
+ *
+ * @param string $queryPartName
+ *
+ * @return mixed
+ */
+ public function getQueryPart($queryPartName) {
+ return $this->queryBuilder->getQueryPart($queryPartName);
+ }
+
+ /**
+ * Gets all query parts.
+ *
+ * @return array
+ */
+ public function getQueryParts() {
+ return $this->queryBuilder->getQueryParts();
+ }
+
+ /**
+ * Resets SQL parts.
+ *
+ * @param array|null $queryPartNames
+ *
+ * @return \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ */
+ public function resetQueryParts($queryPartNames = null) {
+ $this->queryBuilder->resetQueryParts($queryPartNames);
+
+ return $this;
+ }
+
+ /**
+ * Resets a single SQL part.
+ *
+ * @param string $queryPartName
+ *
+ * @return \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ */
+ public function resetQueryPart($queryPartName) {
+ $this->queryBuilder->resetQueryPart($queryPartName);
+
+ return $this;
+ }
+
+ /**
+ * 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 http://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 string the placeholder name used.
+ */
+ public function createNamedParameter($value, $type = \PDO::PARAM_STR, $placeHolder = null) {
+ return $this->queryBuilder->createNamedParameter($value, $type, $placeHolder);
+ }
+
+ /**
+ * 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', PDO::PARAM_STR))
+ * ->orWhere('u.username = ' . $qb->createPositionalParameter('Bar', PDO::PARAM_STR))
+ * </code>
+ *
+ * @param mixed $value
+ * @param integer $type
+ *
+ * @return string
+ */
+ public function createPositionalParameter($value, $type = \PDO::PARAM_STR) {
+ return $this->queryBuilder->createPositionalParameter($value, $type);
+ }
+}
diff --git a/lib/public/db/icompositeexpression.php b/lib/public/db/icompositeexpression.php
new file mode 100644
index 00000000000..123e4ca7cc6
--- /dev/null
+++ b/lib/public/db/icompositeexpression.php
@@ -0,0 +1,64 @@
+<?php
+/**
+ * @author Joas Schilling <nickvergessen@owncloud.com>
+ *
+ * @copyright Copyright (c) 2015, ownCloud, Inc.
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program. If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OCP\DB;
+
+/**
+ * This class provides a wrapper around Doctrine's CompositeExpression
+ * @since 8.2.0
+ */
+interface ICompositeExpression {
+ /**
+ * Adds multiple parts to composite expression.
+ *
+ * @param array $parts
+ *
+ * @return \OCP\DB\ICompositeExpression
+ * @since 8.2.0
+ */
+ public function addMultiple(array $parts = array());
+
+ /**
+ * Adds an expression to composite expression.
+ *
+ * @param mixed $part
+ *
+ * @return \OCP\DB\ICompositeExpression
+ * @since 8.2.0
+ */
+ public function add($part);
+
+ /**
+ * Retrieves the amount of expressions on composite expression.
+ *
+ * @return integer
+ * @since 8.2.0
+ */
+ public function count();
+
+ /**
+ * Returns the type of this composite expression (AND/OR).
+ *
+ * @return string
+ * @since 8.2.0
+ */
+ public function getType();
+}
diff --git a/lib/public/db/iexpressionbuilder.php b/lib/public/db/iexpressionbuilder.php
new file mode 100644
index 00000000000..848a8a2f8f1
--- /dev/null
+++ b/lib/public/db/iexpressionbuilder.php
@@ -0,0 +1,252 @@
+<?php
+/**
+ * @author Joas Schilling <nickvergessen@owncloud.com>
+ *
+ * @copyright Copyright (c) 2015, ownCloud, Inc.
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program. If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OCP\DB;
+
+/**
+ * This class provides a wrapper around Doctrine's ExpressionBuilder
+ * @since 8.2.0
+ */
+interface IExpressionBuilder {
+ /**
+ * Creates a conjunction of the given boolean expressions.
+ *
+ * Example:
+ *
+ * [php]
+ * // (u.type = ?) AND (u.role = ?)
+ * $expr->andX('u.type = ?', 'u.role = ?'));
+ *
+ * @param mixed $x Optional clause. Defaults = null, but requires
+ * at least one defined when converting to string.
+ *
+ * @return \OCP\DB\ICompositeExpression
+ * @since 8.2.0
+ */
+ public function andX($x = null);
+
+ /**
+ * Creates a disjunction of the given boolean expressions.
+ *
+ * Example:
+ *
+ * [php]
+ * // (u.type = ?) OR (u.role = ?)
+ * $qb->where($qb->expr()->orX('u.type = ?', 'u.role = ?'));
+ *
+ * @param mixed $x Optional clause. Defaults = null, but requires
+ * at least one defined when converting to string.
+ *
+ * @return \OCP\DB\ICompositeExpression
+ * @since 8.2.0
+ */
+ public function orX($x = null);
+
+ /**
+ * Creates a comparison expression.
+ *
+ * @param mixed $x The left expression.
+ * @param string $operator One of the ExpressionBuilder::* constants.
+ * @param mixed $y The right expression.
+ *
+ * @return string
+ * @since 8.2.0
+ */
+ public function comparison($x, $operator, $y);
+
+ /**
+ * Creates an equality comparison expression with the given arguments.
+ *
+ * First argument is considered the left expression and the second is the right expression.
+ * When converted to string, it will generated a <left expr> = <right expr>. Example:
+ *
+ * [php]
+ * // u.id = ?
+ * $expr->eq('u.id', '?');
+ *
+ * @param mixed $x The left expression.
+ * @param mixed $y The right expression.
+ *
+ * @return string
+ * @since 8.2.0
+ */
+ public function eq($x, $y);
+
+ /**
+ * Creates a non equality comparison expression with the given arguments.
+ * First argument is considered the left expression and the second is the right expression.
+ * When converted to string, it will generated a <left expr> <> <right expr>. Example:
+ *
+ * [php]
+ * // u.id <> 1
+ * $q->where($q->expr()->neq('u.id', '1'));
+ *
+ * @param mixed $x The left expression.
+ * @param mixed $y The right expression.
+ *
+ * @return string
+ * @since 8.2.0
+ */
+ public function neq($x, $y);
+
+ /**
+ * Creates a lower-than comparison expression with the given arguments.
+ * First argument is considered the left expression and the second is the right expression.
+ * When converted to string, it will generated a <left expr> < <right expr>. Example:
+ *
+ * [php]
+ * // u.id < ?
+ * $q->where($q->expr()->lt('u.id', '?'));
+ *
+ * @param mixed $x The left expression.
+ * @param mixed $y The right expression.
+ *
+ * @return string
+ * @since 8.2.0
+ */
+ public function lt($x, $y);
+
+ /**
+ * Creates a lower-than-equal comparison expression with the given arguments.
+ * First argument is considered the left expression and the second is the right expression.
+ * When converted to string, it will generated a <left expr> <= <right expr>. Example:
+ *
+ * [php]
+ * // u.id <= ?
+ * $q->where($q->expr()->lte('u.id', '?'));
+ *
+ * @param mixed $x The left expression.
+ * @param mixed $y The right expression.
+ *
+ * @return string
+ * @since 8.2.0
+ */
+ public function lte($x, $y);
+
+ /**
+ * Creates a greater-than comparison expression with the given arguments.
+ * First argument is considered the left expression and the second is the right expression.
+ * When converted to string, it will generated a <left expr> > <right expr>. Example:
+ *
+ * [php]
+ * // u.id > ?
+ * $q->where($q->expr()->gt('u.id', '?'));
+ *
+ * @param mixed $x The left expression.
+ * @param mixed $y The right expression.
+ *
+ * @return string
+ * @since 8.2.0
+ */
+ public function gt($x, $y);
+
+ /**
+ * Creates a greater-than-equal comparison expression with the given arguments.
+ * First argument is considered the left expression and the second is the right expression.
+ * When converted to string, it will generated a <left expr> >= <right expr>. Example:
+ *
+ * [php]
+ * // u.id >= ?
+ * $q->where($q->expr()->gte('u.id', '?'));
+ *
+ * @param mixed $x The left expression.
+ * @param mixed $y The right expression.
+ *
+ * @return string
+ * @since 8.2.0
+ */
+ public function gte($x, $y);
+
+ /**
+ * Creates an IS NULL expression with the given arguments.
+ *
+ * @param string $x The field in string format to be restricted by IS NULL.
+ *
+ * @return string
+ * @since 8.2.0
+ */
+ public function isNull($x);
+
+ /**
+ * Creates an IS NOT NULL expression with the given arguments.
+ *
+ * @param string $x The field in string format to be restricted by IS NOT NULL.
+ *
+ * @return string
+ * @since 8.2.0
+ */
+ public function isNotNull($x);
+
+ /**
+ * Creates a LIKE() comparison expression with the given arguments.
+ *
+ * @param string $x Field in string format to be inspected by LIKE() comparison.
+ * @param mixed $y Argument to be used in LIKE() comparison.
+ *
+ * @return string
+ * @since 8.2.0
+ */
+ public function like($x, $y);
+
+ /**
+ * Creates a NOT LIKE() comparison expression with the given arguments.
+ *
+ * @param string $x Field in string format to be inspected by NOT LIKE() comparison.
+ * @param mixed $y Argument to be used in NOT LIKE() comparison.
+ *
+ * @return string
+ * @since 8.2.0
+ */
+ public function notLike($x, $y);
+
+ /**
+ * Creates a IN () comparison expression with the given arguments.
+ *
+ * @param string $x The field in string format to be inspected by IN() comparison.
+ * @param string|array $y The placeholder or the array of values to be used by IN() comparison.
+ *
+ * @return string
+ * @since 8.2.0
+ */
+ public function in($x, $y);
+
+ /**
+ * Creates a NOT IN () comparison expression with the given arguments.
+ *
+ * @param string $x The field in string format to be inspected by NOT IN() comparison.
+ * @param string|array $y The placeholder or the array of values to be used by NOT IN() comparison.
+ *
+ * @return string
+ * @since 8.2.0
+ */
+ public function notIn($x, $y);
+
+ /**
+ * Quotes a given input parameter.
+ *
+ * @param mixed $input The parameter to be quoted.
+ * @param string|null $type The type of the parameter.
+ *
+ * @return string
+ * @since 8.2.0
+ */
+ public function literal($input, $type = null);
+}
diff --git a/lib/public/db/iquerybuilder.php b/lib/public/db/iquerybuilder.php
new file mode 100644
index 00000000000..24ca96c578d
--- /dev/null
+++ b/lib/public/db/iquerybuilder.php
@@ -0,0 +1,742 @@
+<?php
+/**
+ * @author Joas Schilling <nickvergessen@owncloud.com>
+ *
+ * @copyright Copyright (c) 2015, ownCloud, Inc.
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program. If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OCP\DB;
+
+/**
+ * This class provides a wrapper around Doctrine's QueryBuilder
+ * @since 8.2.0
+ */
+interface IQueryBuilder {
+ /**
+ * 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\IExpressionBuilder
+ * @since 8.2.0
+ */
+ public function expr();
+
+ /**
+ * 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.
+ *
+ * @return \Doctrine\DBAL\Driver\Statement|int
+ * @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 $type One of the PDO::PARAM_* constants.
+ *
+ * @return \OCP\DB\IQueryBuilder 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 \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ * @since 8.2.0
+ */
+ public function setParameters(array $params, array $types = array());
+
+ /**
+ * 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 \OCP\DB\IQueryBuilder 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 \OCP\DB\IQueryBuilder 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 integer The maximum number of results.
+ * @since 8.2.0
+ */
+ public function getMaxResults();
+
+ /**
+ * Either appends to or replaces a single, generic query part.
+ *
+ * The available parts are: 'select', 'from', 'set', 'where',
+ * 'groupBy', 'having' and 'orderBy'.
+ *
+ * @param string $sqlPartName
+ * @param string $sqlPart
+ * @param boolean $append
+ *
+ * @return \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ * @since 8.2.0
+ */
+ public function add($sqlPartName, $sqlPart, $append = false);
+
+ /**
+ * 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 $select The selection expressions.
+ *
+ * @return \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ * @since 8.2.0
+ */
+ public function select($select = null);
+
+ /**
+ * 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 \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ * @since 8.2.0
+ */
+ public function addSelect($select = null);
+
+ /**
+ * 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 \OCP\DB\IQueryBuilder 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 \OCP\DB\IQueryBuilder 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 \OCP\DB\IQueryBuilder 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 \OCP\DB\IQueryBuilder 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 \OCP\DB\IQueryBuilder 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 \OCP\DB\IQueryBuilder 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 \OCP\DB\IQueryBuilder 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 \OCP\DB\IQueryBuilder 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 string $value The value, expression, placeholder, etc.
+ *
+ * @return \OCP\DB\IQueryBuilder 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 \OCP\DB\IQueryBuilder 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 \OCP\DB\IQueryBuilder 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 \OCP\DB\IQueryBuilder 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 $groupBy The grouping expression.
+ *
+ * @return \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ * @since 8.2.0
+ */
+ public function groupBy($groupBy);
+
+ /**
+ * 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 \OCP\DB\IQueryBuilder 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 string $value The value that should be inserted into the column.
+ *
+ * @return \OCP\DB\IQueryBuilder 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 \OCP\DB\IQueryBuilder 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 \OCP\DB\IQueryBuilder 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 \OCP\DB\IQueryBuilder 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 \OCP\DB\IQueryBuilder 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 \OCP\DB\IQueryBuilder 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 \OCP\DB\IQueryBuilder 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 \OCP\DB\IQueryBuilder This QueryBuilder instance.
+ * @since 8.2.0
+ */
+ public function resetQueryParts($queryPartNames = null);
+
+ /**
+ * Resets a single SQL part.
+ *
+ * @param string $queryPartName
+ *
+ * @return \OCP\DB\IQueryBuilder 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 http://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 string the placeholder name used.
+ * @since 8.2.0
+ */
+ public function createNamedParameter($value, $type = \PDO::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', PDO::PARAM_STR))
+ * ->orWhere('u.username = ' . $qb->createPositionalParameter('Bar', PDO::PARAM_STR))
+ * </code>
+ *
+ * @param mixed $value
+ * @param integer $type
+ *
+ * @return string
+ * @since 8.2.0
+ */
+ public function createPositionalParameter($value, $type = \PDO::PARAM_STR);
+}
diff --git a/lib/public/idbconnection.php b/lib/public/idbconnection.php
index ebad3c1f693..a4be3acd2e2 100644
--- a/lib/public/idbconnection.php
+++ b/lib/public/idbconnection.php
@@ -40,6 +40,22 @@ namespace OCP;
* @since 6.0.0
*/
interface IDBConnection {
+ /**
+ * Gets the ExpressionBuilder for the connection.
+ *
+ * @return \OCP\DB\IExpressionBuilder
+ * @since 8.2.0
+ */
+ public function getExpressionBuilder();
+
+ /**
+ * Gets the QueryBuilder for the connection.
+ *
+ * @return \OCP\DB\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
--
GitLab