Query builder for SELECT statements.
Hierarchy
- class \Drupal\Core\Database\Query\Query implements PlaceholderInterface
- class \Drupal\Core\Database\Query\Select implements SelectInterface uses QueryConditionTrait
Related topics
- Database abstraction layer
- Allow the use of different database servers using the same code base.
File
- core/lib/Drupal/Core/Database/Query/Select.php, line 14
Namespace
Drupal\Core\Database\Query
Members
| Name | Modifiers | Type | Description |
|---|---|---|---|
| Query::$comments | protected | property | An array of comments that can be prepended to a query. |
| Query::$connection | protected | property | The connection object on which to run this query. |
| Query::$connectionKey | protected | property | The key of the connection object. |
| Query::$connectionTarget | protected | property | The target of the connection object. |
| Query::$nextPlaceholder | protected | property | The placeholder counter. |
| Query::$queryOptions | protected | property | The query options to pass on to the connection object. |
| Query::$uniqueIdentifier | protected | property | A unique identifier for this query object. |
| Query::comment | public | function | Adds a comment to the query. |
| Query::getComments | public | function | Returns a reference to the comments array for the query. |
| Query::nextPlaceholder | public | function | Gets the next placeholder value for this query object. Overrides PlaceholderInterface::nextPlaceholder |
| Query::uniqueIdentifier | public | function | Returns a unique identifier for this object. Overrides PlaceholderInterface::uniqueIdentifier |
| Query::__sleep | public | function | Implements the magic __sleep function to disconnect from the database. |
| Query::__wakeup | public | function | Implements the magic __wakeup function to reconnect to the database. |
| QueryConditionTrait::$condition | protected | property | The condition object for this query. |
| QueryConditionTrait::andConditionGroup | public | function | Creates a new group of conditions ANDed together. Overrides ConditionInterface::andConditionGroup |
| QueryConditionTrait::condition | public | function | Helper function: builds the most common conditional clauses. Overrides ConditionInterface::condition |
| QueryConditionTrait::conditionGroupFactory | public | function | Creates an object holding a group of conditions. Overrides ConditionInterface::conditionGroupFactory |
| QueryConditionTrait::conditions | public | function | Gets a complete list of all conditions in this conditional clause. Overrides ConditionInterface::conditions |
| QueryConditionTrait::exists | public | function | Sets a condition that the specified subquery returns values. Overrides ConditionInterface::exists |
| QueryConditionTrait::isNotNull | public | function | Sets a condition that the specified field be NOT NULL. Overrides ConditionInterface::isNotNull |
| QueryConditionTrait::isNull | public | function | Sets a condition that the specified field be NULL. Overrides ConditionInterface::isNull |
| QueryConditionTrait::notExists | public | function | Sets a condition that the specified subquery returns no values. Overrides ConditionInterface::notExists |
| QueryConditionTrait::orConditionGroup | public | function | Creates a new group of conditions ORed together. Overrides ConditionInterface::orConditionGroup |
| QueryConditionTrait::where | public | function | Adds an arbitrary WHERE clause to the query. Overrides ConditionInterface::where |
| Select::$distinct | protected | property | Whether or not this query should be DISTINCT |
| Select::$expressions | protected | property | The expressions to SELECT as virtual fields. |
| Select::$fields | protected | property | The fields to SELECT. |
| Select::$forUpdate | protected | property | The FOR UPDATE status |
| Select::$group | protected | property | The fields by which to group. |
| Select::$having | protected | property | The conditional object for the HAVING clause. |
| Select::$order | protected | property | The fields by which to order this query. |
| Select::$prepared | protected | property | Indicates if preExecute() has already been called. |
| Select::$range | protected | property | The range limiters for this query. |
| Select::$tables | protected | property | The tables against which to JOIN. |
| Select::$union | protected | property | An array whose elements specify a query to UNION, and the UNION type. The 'type' key may be '', 'ALL', or 'DISTINCT' to represent a 'UNION', 'UNION ALL', or 'UNION DISTINCT'… |
| Select::addExpression | public | function | Adds an expression to the list of "fields" to be SELECTed. Overrides SelectInterface::addExpression |
| Select::addField | public | function | Adds a field to the list to be SELECTed. Overrides SelectInterface::addField |
| Select::addJoin | public | function | Join against another table in the database. Overrides SelectInterface::addJoin |
| Select::addMetaData | public | function | Adds additional metadata to the query. Overrides AlterableInterface::addMetaData |
| Select::addTag | public | function | Adds a tag to a query. Overrides AlterableInterface::addTag |
| Select::arguments | public | function | Gets a complete list of all values to insert into the prepared statement. Overrides QueryConditionTrait::arguments |
| Select::compile | public | function | Compiles the saved conditions for later retrieval. Overrides QueryConditionTrait::compile |
| Select::compiled | public | function | Check whether a condition has been previously compiled. Overrides QueryConditionTrait::compiled |
| Select::countQuery | public | function | Get the equivalent COUNT query of this query as a new query object. Overrides SelectInterface::countQuery |
| Select::distinct | public | function | Sets this query to be DISTINCT. Overrides SelectInterface::distinct |
| Select::escapeField | public | function | Escapes a field name string. Overrides SelectInterface::escapeField |
| Select::escapeLike | public | function | Escapes characters that work as wildcard characters in a LIKE pattern. Overrides SelectInterface::escapeLike |
| Select::execute | public | function | Runs the query against the database. Overrides Query::execute |
| Select::extend | public | function | Enhance this object by wrapping it in an extender object. Overrides ExtendableInterface::extend |
| Select::fields | public | function | Add multiple fields from the same table to be SELECTed. Overrides SelectInterface::fields |
| Select::forUpdate | public | function | Add FOR UPDATE to the query. Overrides SelectInterface::forUpdate |
| Select::getArguments | public | function | Compiles and returns an associative array of the arguments for this prepared statement. Overrides SelectInterface::getArguments |
| Select::getExpressions | public | function | Returns a reference to the expressions array for this query. Overrides SelectInterface::getExpressions |
| Select::getFields | public | function | Returns a reference to the fields array for this query. Overrides SelectInterface::getFields |
| Select::getGroupBy | public | function | Returns a reference to the group-by array for this query. Overrides SelectInterface::getGroupBy |
| Select::getMetaData | public | function | Retrieves a given piece of metadata. Overrides AlterableInterface::getMetaData |
| Select::getOrderBy | public | function | Returns a reference to the order by array for this query. Overrides SelectInterface::getOrderBy |
| Select::getTables | public | function | Returns a reference to the tables array for this query. Overrides SelectInterface::getTables |
| Select::getUnion | public | function | Returns a reference to the union queries for this query. This include queries for UNION, UNION ALL, and UNION DISTINCT. Overrides SelectInterface::getUnion |
| Select::groupBy | public | function | Groups the result set by the specified field. Overrides SelectInterface::groupBy |
| Select::hasAllTags | public | function | Determines if a given query has all specified tags. Overrides AlterableInterface::hasAllTags |
| Select::hasAnyTag | public | function | Determines if a given query has any specified tag. Overrides AlterableInterface::hasAnyTag |
| Select::hasTag | public | function | Determines if a given query has a given tag. Overrides AlterableInterface::hasTag |
| Select::having | public | function | Adds an arbitrary HAVING clause to the query. Overrides SelectInterface::having |
| Select::havingArguments | public | function | Gets a list of all values to insert into the HAVING clause. Overrides SelectInterface::havingArguments |
| Select::havingCompile | public | function | Compiles the HAVING clause for later retrieval. Overrides SelectInterface::havingCompile |
| Select::havingCondition | public | function | Helper function to build most common HAVING conditional clauses. Overrides SelectInterface::havingCondition |
| Select::havingConditions | public | function | Gets a list of all conditions in the HAVING clause. Overrides SelectInterface::havingConditions |
| Select::havingExists | public | function | Sets a HAVING condition that the specified subquery returns values. Overrides SelectInterface::havingExists |
| Select::havingIsNotNull | public | function | Sets a condition in the HAVING clause that the specified field be NOT NULL. Overrides SelectInterface::havingIsNotNull |
| Select::havingIsNull | public | function | Sets a condition in the HAVING clause that the specified field be NULL. Overrides SelectInterface::havingIsNull |
| Select::havingNotExists | public | function | Sets a HAVING condition that the specified subquery returns no values. Overrides SelectInterface::havingNotExists |
| Select::innerJoin | public | function | Inner Join against another table in the database. Overrides SelectInterface::innerJoin |
| Select::isPrepared | public | function | Indicates if preExecute() has already been called on that object. Overrides SelectInterface::isPrepared |
| Select::join | public | function | Default Join against another table in the database. Overrides SelectInterface::join |
| Select::leftJoin | public | function | Left Outer Join against another table in the database. Overrides SelectInterface::leftJoin |
| Select::orderBy | public | function | Orders the result set by a given field. Overrides SelectInterface::orderBy |
| Select::orderRandom | public | function | Orders the result set by a random value. Overrides SelectInterface::orderRandom |
| Select::preExecute | public | function | Generic preparation and validation for a SELECT query. Overrides SelectInterface::preExecute |
| Select::prepareCountQuery | protected | function | Prepares a count query from the current query object. |
| Select::range | public | function | Restricts a query to a given range in the result set. Overrides SelectInterface::range |
| Select::rightJoin | public | function | Right Outer Join against another table in the database. Overrides SelectInterface::rightJoin |
| Select::union | public | function | Add another Select query to UNION to this one. Overrides SelectInterface::union |
| Select::__clone | public | function | Implements the magic __clone function. Overrides Query::__clone |
| Select::__construct | public | function | Constructs a Select object. Overrides Query::__construct |
| Select::__toString | public | function | Implements PHP magic __toString method to convert the query to a string. Overrides Query::__toString |
Please login to continue.