Build SELECT queries with a fluent interface. More...

Inherits Wikimedia\Rdbms\JoinGroupBase.

Inherited by MediaWiki\FileRepo\File\FileSelectQueryBuilder, MediaWiki\Logging\LoggingSelectQueryBuilder, MediaWiki\Page\PageSelectQueryBuilder, MediaWiki\Revision\ArchiveSelectQueryBuilder, MediaWiki\Revision\RevisionSelectQueryBuilder, and MediaWiki\User\UserSelectQueryBuilder.

Collaboration diagram for Wikimedia\Rdbms\SelectQueryBuilder:

[legend]

Public Member Functions
	__construct (IReadableDatabase $db)
	Only for use in subclasses.

	acquireRowLocks ()
	Execute the query, but throw away the results.

	andWhere ( $conds)
	Add conditions to the query.

	bigResult ()
	Enable the SQL_BIG_RESULT option.

	bufferResult ()
	Enable the SQL_BUFFER_RESULT option.

	buildGroupConcatField ( $delim)
	Build a GROUP_CONCAT or equivalent statement for a query.

	calcFoundRows ()
	Enable the SQL_CALC_FOUND_ROWS option.

	caller ( $fname)
	Set the method name to be included in an SQL comment.

	clearFields ()
	Remove all fields from the query.

	conds ( $conds)
	Add conditions to the query.

	connection (IReadableDatabase $db)
	Change the IReadableDatabase object the query builder is bound to.

	distinct ()
	Enable the DISTINCT option.

	estimateRowCount ()
	Estimate the number of rows in dataset.

	explain ()
	Make the query be an EXPLAIN SELECT query instead of a SELECT query.

	fetchField ()
	Run the constructed SELECT query, and return a single field extracted from the first result row.

	fetchFieldValues ()
	Run the constructed SELECT query, and extract a single field from each result row, returning an array containing all the values.

	fetchResultSet ()
	Run the constructed SELECT query and return all results.

	fetchRow ()
	Run the constructed SELECT query, and return the first result row.

	fetchRowCount ()
	Run the SELECT query, and return the number of results.

	field ( $field, $alias=null)
	Add a single field to the query, optionally with an alias.

	fields ( $fields)
	Add a field or an array of fields to the query.

	forUpdate ()
	Enable the FOR UPDATE option.

	from ( $table, $alias=null)
	Add a single table to the SELECT query.

	getQueryInfo ( $joinsName='join_conds')
	Get an associative array describing the query in terms of its raw parameters to IReadableDatabase::select().

	getSQL ()
	Get the SQL query string which would be used by fetchResultSet().

	groupBy ( $group)
	Add a GROUP BY clause.

	having ( $having)
	Add a HAVING clause.

	ignoreIndex ( $index)
	Set the IGNORE INDEX option.

	joinConds (array $joinConds)
	Manually append to the $join_conds array which will be passed to IReadableDatabase::select().

	limit ( $limit)
	Set the query limit.

	lockInShareMode ()
	Enable the LOCK IN SHARE MODE option.

	merge (SelectQueryBuilder $builder)
	Merge another query builder with this one.

	newJoinGroup ()
	Create a parenthesized group of joins which can be added to the object like a table.

	newSubquery ()
	Get an empty SelectQueryBuilder which can be used to build a subquery of this query.

	offset ( $offset)
	Set the offset.

	option ( $name, $value=null)
	Manually set an option in the $options array to be passed to IReadableDatabase::select()

	options (array $options)
	Manually set multiple options in the $options array to be passed to IReadableDatabase::select().

	orderBy ( $fields, $direction=null)
	Set the ORDER BY clause.

	queryInfo ( $info)
	Set the query parameters to the given values, appending to the values which were already set.

	rawTables ( $tables)
	Given a table or table array as might be passed to IReadableDatabase::select(), append it to the existing tables, interpreting nested arrays as join groups.

	recency ( $recency)

	select ( $fields)
	Add a field or an array of fields to the query.

	setMaxExecutionTime (int $time)
	Set MAX_EXECUTION_TIME for queries.

	smallResult ()
	Enable the SQL_SMALL_RESULT option.

	straightJoinOption ()
	Enable the STRAIGHT_JOIN query option.

	tables ( $tables)
	Add multiple tables.

	useIndex ( $index)
	Set a USE INDEX option.

	where ( $conds)
	Add conditions to the query.

Public Member Functions inherited from Wikimedia\Rdbms\JoinGroupBase
	join ( $table, $alias=null, $conds=[])
	Inner join a table or group of tables.

	leftJoin ( $table, $alias=null, $conds=[])
	Left join a table or group of tables.

	straightJoin ( $table, $alias=null, $conds=[])
	Straight join a table or group of tables.

	table ( $table, $alias=null)
	Add a single table or a single parenthesized group.

Public Attributes
const	SORT_ASC = 'ASC'
	sort the results in ascending order

const	SORT_DESC = 'DESC'
	sort the results in descending order

Protected Member Functions
	getAutoAlias ()
	Get a table alias which is unique to this SelectQueryBuilder.

	getCaller ()
	get the method name of the caller, for use in sub classes

Protected Attributes
IReadableDatabase	$db

array	$options = []
	The options to be passed to IReadableDatabase::select()

Protected Attributes inherited from Wikimedia\Rdbms\JoinGroupBase
array	$joinConds = []

string null	$lastAlias

array	$tables = []

Detailed Description

Build SELECT queries with a fluent interface.

Each query builder object must be used for a single database query only, and not be reused afterwards. To run multiple similar queries, you can create a query builder to set up most of your query, which you can use as a "template" to clone. You can then modify the cloned object for each individual query.

Note that the methods in this class are not stable to override. This class may be extended to create query builders for specific database tables, such \\MediaWiki\\Page\\PageSelectQueryBuilder, whilst still providing the same fluent interface for adding arbitrary additional conditions and such.

Since: 1.35

Stability: stable: to extend

Definition at line 26 of file SelectQueryBuilder.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\Rdbms\SelectQueryBuilder::__construct ( IReadableDatabase $db )

Only for use in subclasses.

To create a SelectQueryBuilder instance, use $db->newSelectQueryBuilder() instead.

Reimplemented in MediaWiki\Logging\LoggingSelectQueryBuilder, MediaWiki\Revision\ArchiveSelectQueryBuilder, and MediaWiki\Revision\RevisionSelectQueryBuilder.

Definition at line 75 of file SelectQueryBuilder.php.

References Wikimedia\Rdbms\SelectQueryBuilder\$db.

Member Function Documentation

◆ acquireRowLocks()

Wikimedia\Rdbms\SelectQueryBuilder::acquireRowLocks ( )

Execute the query, but throw away the results.

This is intended for locking select queries. By calling this method, the caller is indicating that the query is only done to acquire locks on the selected rows. The field list is optional.

Either forUpdate() or lockInShareMode() must be called before calling this method.

See also: self::forUpdate(); self::lockInShareMode()

Since: 1.40

Definition at line 934 of file SelectQueryBuilder.php.

◆ andWhere()

Wikimedia\Rdbms\SelectQueryBuilder::andWhere ( $conds )

Add conditions to the query.

Alias for where().

@phpcs:ignore Generic.Files.LineLength

Parameters

Returns: $this

Definition at line 368 of file SelectQueryBuilder.php.

References Wikimedia\Rdbms\SelectQueryBuilder\where().

Referenced by SearchMySQL\queryFeatures().

◆ bigResult()

Wikimedia\Rdbms\SelectQueryBuilder::bigResult ( )

Enable the SQL_BIG_RESULT option.

Returns: $this

Definition at line 655 of file SelectQueryBuilder.php.

References Wikimedia\Rdbms\SelectQueryBuilder\options().

◆ bufferResult()

Wikimedia\Rdbms\SelectQueryBuilder::bufferResult ( )

Enable the SQL_BUFFER_RESULT option.

Returns: $this

Definition at line 665 of file SelectQueryBuilder.php.

References Wikimedia\Rdbms\SelectQueryBuilder\options().

◆ buildGroupConcatField()

Wikimedia\Rdbms\SelectQueryBuilder::buildGroupConcatField ( $delim )

Build a GROUP_CONCAT or equivalent statement for a query.

This is useful for combining a field for several rows into a single string. NULL values will not appear in the output, duplicated values will appear, and the resulting delimiter-separated values have no defined sort order. Code using the results may need to use the PHP unique() or sort() methods.

Parameters

string $delim

Returns: string

Definition at line 869 of file SelectQueryBuilder.php.

◆ calcFoundRows()

Wikimedia\Rdbms\SelectQueryBuilder::calcFoundRows ( )

Enable the SQL_CALC_FOUND_ROWS option.

Returns: $this

Definition at line 685 of file SelectQueryBuilder.php.

References Wikimedia\Rdbms\SelectQueryBuilder\options().

◆ caller()

Wikimedia\Rdbms\SelectQueryBuilder::caller ( $fname )

Set the method name to be included in an SQL comment.

Parameters

string $fname

Returns: $this

Definition at line 739 of file SelectQueryBuilder.php.

References Wikimedia\Rdbms\SelectQueryBuilder\caller().

Referenced by Wikimedia\Rdbms\SelectQueryBuilder\caller(), Wikimedia\Rdbms\SelectQueryBuilder\merge(), Wikimedia\Rdbms\SelectQueryBuilder\queryInfo(), and MediaWiki\Api\ApiQueryBase\select().

◆ clearFields()

Wikimedia\Rdbms\SelectQueryBuilder::clearFields ( )

Remove all fields from the query.

Returns: $this

Definition at line 296 of file SelectQueryBuilder.php.

References Wikimedia\Rdbms\SelectQueryBuilder\fields().

◆ conds()

Wikimedia\Rdbms\SelectQueryBuilder::conds ( $conds )

Add conditions to the query.

Alias for where().

@phpcs:ignore Generic.Files.LineLength

Parameters

Returns: $this

Definition at line 380 of file SelectQueryBuilder.php.

References Wikimedia\Rdbms\SelectQueryBuilder\where().

Referenced by Wikimedia\Rdbms\SelectQueryBuilder\merge(), Wikimedia\Rdbms\SelectQueryBuilder\where(), and MediaWiki\Page\PageSelectQueryBuilder\wherePageIds().

◆ connection()

Wikimedia\Rdbms\SelectQueryBuilder::connection ( IReadableDatabase $db )

Change the IReadableDatabase object the query builder is bound to.

The specified IReadableDatabase will subsequently be used to execute the query.

Parameters

IReadableDatabase $db

Returns: $this

Definition at line 86 of file SelectQueryBuilder.php.

References Wikimedia\Rdbms\SelectQueryBuilder\$db, and Wikimedia\Rdbms\IReadableDatabase\getType().

◆ distinct()

Wikimedia\Rdbms\SelectQueryBuilder::distinct ( )

Enable the DISTINCT option.

Return only unique result rows.

Returns: $this

Definition at line 475 of file SelectQueryBuilder.php.

References Wikimedia\Rdbms\SelectQueryBuilder\options().

Referenced by MediaWiki\ChangeTags\ChangeTagsStore\modifyDisplayQueryBuilder().

◆ estimateRowCount()

Wikimedia\Rdbms\SelectQueryBuilder::estimateRowCount ( )

Estimate the number of rows in dataset.

MySQL allows you to estimate the number of rows that would be returned by a SELECT query, using EXPLAIN SELECT. The estimate is provided using index cardinality statistics, and is notoriously inaccurate, especially when large numbers of rows have recently been added or deleted.

Definition at line 836 of file SelectQueryBuilder.php.

◆ explain()

Wikimedia\Rdbms\SelectQueryBuilder::explain ( )

Make the query be an EXPLAIN SELECT query instead of a SELECT query.

Returns: $this

Definition at line 635 of file SelectQueryBuilder.php.

References Wikimedia\Rdbms\SelectQueryBuilder\options().

◆ fetchField()

Wikimedia\Rdbms\SelectQueryBuilder::fetchField ( )

Run the constructed SELECT query, and return a single field extracted from the first result row.

This may only be called when only one field has been added to the builder.

Returns: mixed|false The value from the field, or false if nothing was found

Definition at line 773 of file SelectQueryBuilder.php.

◆ fetchFieldValues()

Wikimedia\Rdbms\SelectQueryBuilder::fetchFieldValues ( )

Run the constructed SELECT query, and extract a single field from each result row, returning an array containing all the values.

This may only be called when only one field has been added to the builder.

Returns: array

Definition at line 791 of file SelectQueryBuilder.php.

◆ fetchResultSet()

Wikimedia\Rdbms\SelectQueryBuilder::fetchResultSet ( )

Run the constructed SELECT query and return all results.

Returns: IResultWrapper

Definition at line 760 of file SelectQueryBuilder.php.

Referenced by MediaWiki\Api\ApiQueryBase\select().

◆ fetchRow()

Wikimedia\Rdbms\SelectQueryBuilder::fetchRow ( )

Run the constructed SELECT query, and return the first result row.

If there were no results, return false.

Returns: \stdClass|false

Definition at line 808 of file SelectQueryBuilder.php.

◆ fetchRowCount()

Wikimedia\Rdbms\SelectQueryBuilder::fetchRowCount ( )

Run the SELECT query, and return the number of results.

This typically uses a subquery to discard the actual results on the server side, and is useful when counting rows with a limit.

To count rows without a limit, it's more efficient to use a normal COUNT() expression, for example:

$queryBuilder->select( 'COUNT(*)' )->from( 'page' )->fetchField()

Definition at line 823 of file SelectQueryBuilder.php.

◆ field()

Wikimedia\Rdbms\SelectQueryBuilder::field	(		$field,
			$alias = null )

Add a single field to the query, optionally with an alias.

The field is an SQL fragment. It is unsafe to pass user input to this function.

Parameters

string	$field
string \| null	$alias

Returns: $this

Definition at line 271 of file SelectQueryBuilder.php.

References Wikimedia\Rdbms\SelectQueryBuilder\fields().

Referenced by Wikimedia\Rdbms\SelectQueryBuilder\fields(), MediaWiki\Revision\RevisionSelectQueryBuilder\joinUser(), and MediaWiki\ChangeTags\ChangeTagsStore\modifyDisplayQueryBuilder().

◆ fields()

Wikimedia\Rdbms\SelectQueryBuilder::fields ( $fields )

Add a field or an array of fields to the query.

Each field is an SQL fragment. If the array key is non-numeric, the key is taken to be an alias for the field.

See also: IReadableDatabase::select()

Parameters

string | string[] $fields

Returns: $this

Definition at line 238 of file SelectQueryBuilder.php.

References Wikimedia\Rdbms\SelectQueryBuilder\field().

Referenced by Wikimedia\Rdbms\SelectQueryBuilder\clearFields(), Wikimedia\Rdbms\SelectQueryBuilder\field(), MediaWiki\Revision\ArchiveSelectQueryBuilder\joinComment(), MediaWiki\Revision\RevisionSelectQueryBuilder\joinComment(), MediaWiki\Revision\RevisionSelectQueryBuilder\joinPage(), Wikimedia\Rdbms\SelectQueryBuilder\merge(), Wikimedia\Rdbms\SelectQueryBuilder\queryInfo(), Wikimedia\Rdbms\SelectQueryBuilder\select(), and MediaWiki\Api\ApiQueryBase\select().

◆ forUpdate()

Wikimedia\Rdbms\SelectQueryBuilder::forUpdate ( )

Enable the FOR UPDATE option.

Lock the returned rows so that they can't be changed until the next COMMIT. Cannot be used with aggregate functions (COUNT, MAX, etc., but also DISTINCT).

Returns: $this

Definition at line 465 of file SelectQueryBuilder.php.

References Wikimedia\Rdbms\SelectQueryBuilder\options().

Referenced by Wikimedia\Rdbms\SelectQueryBuilder\recency().

◆ from()

Wikimedia\Rdbms\SelectQueryBuilder::from	(		$table,
			$alias = null )

Add a single table to the SELECT query.

Alias for table().

Parameters

string \| JoinGroup \| Subquery \| SelectQueryBuilder	$table	Table reference; see `table` for details
string \| null	$alias	The table alias, or null for no alias

Returns: $this

Definition at line 204 of file SelectQueryBuilder.php.

References Wikimedia\Rdbms\JoinGroupBase\table().

◆ getAutoAlias()

Wikimedia\Rdbms\SelectQueryBuilder::getAutoAlias ( )

protected

Get a table alias which is unique to this SelectQueryBuilder.

Returns: string

Reimplemented from Wikimedia\Rdbms\JoinGroupBase.

Definition at line 402 of file SelectQueryBuilder.php.

Referenced by Wikimedia\Rdbms\SelectQueryBuilder\newJoinGroup().

◆ getCaller()

Wikimedia\Rdbms\SelectQueryBuilder::getCaller ( )

finalprotected

get the method name of the caller, for use in sub classes

Since: 1.43

Definition at line 750 of file SelectQueryBuilder.php.

◆ getQueryInfo()

Wikimedia\Rdbms\SelectQueryBuilder::getQueryInfo ( $joinsName = 'join_conds' )

Get an associative array describing the query in terms of its raw parameters to IReadableDatabase::select().

This can be used to interface with legacy code.

Parameters

string $joinsName The name of the join_conds key

Returns

array The query info array, with keys:

tables: The table array
fields: The fields
conds: The conditions
options: The query options
join_conds: The join conditions. This can also be given a different name by passing a $joinsName parameter, since some legacy code uses the name "joins".
caller: The caller signature

Definition at line 906 of file SelectQueryBuilder.php.

Referenced by MediaWiki\Api\ApiQueryBase\select().

◆ getSQL()

Wikimedia\Rdbms\SelectQueryBuilder::getSQL ( )

Get the SQL query string which would be used by fetchResultSet().

Returns: string

Definition at line 884 of file SelectQueryBuilder.php.

◆ groupBy()

Wikimedia\Rdbms\SelectQueryBuilder::groupBy ( $group )

Add a GROUP BY clause.

May be either an SQL fragment string naming a field or expression to group by, or an array of such SQL fragments.

If there is an existing GROUP BY clause, the new one will be appended.

Parameters

string | string[] $group

Returns: $this

Definition at line 501 of file SelectQueryBuilder.php.

◆ having()

Wikimedia\Rdbms\SelectQueryBuilder::having ( $having )

Add a HAVING clause.

May be either a string containing a HAVING clause or an array of conditions building the HAVING clause. If an array is given, the conditions constructed from each element are combined with AND.

If there is an existing HAVING clause, the new one will be appended.

Parameters

string | string[] $having

Returns: $this

Definition at line 518 of file SelectQueryBuilder.php.

◆ ignoreIndex()

Wikimedia\Rdbms\SelectQueryBuilder::ignoreIndex ( $index )

Set the IGNORE INDEX option.

If a string is given, the index hint is applied to the most recently appended table or alias. If an array is given, it is assumed to be an associative array with the alias names in the keys and the indexes in the values, as in the IGNORE INDEX option to IReadableDatabase::select(). The array will be merged with the existing value.

Parameters

string | string[] $index

Returns: $this

Definition at line 599 of file SelectQueryBuilder.php.

◆ joinConds()

Wikimedia\Rdbms\SelectQueryBuilder::joinConds ( array $joinConds )

Manually append to the $join_conds array which will be passed to IReadableDatabase::select().

This is not recommended for new code. Instead, join() and leftJoin() should be used.

Parameters

array $joinConds

Returns: $this

Definition at line 392 of file SelectQueryBuilder.php.

References Wikimedia\Rdbms\SelectQueryBuilder\joinConds().

Referenced by Wikimedia\Rdbms\SelectQueryBuilder\joinConds(), Wikimedia\Rdbms\SelectQueryBuilder\merge(), Wikimedia\Rdbms\SelectQueryBuilder\queryInfo(), and MediaWiki\Api\ApiQueryBase\select().

◆ limit()

Wikimedia\Rdbms\SelectQueryBuilder::limit ( $limit )

Set the query limit.

Return at most this many rows. The rows are sorted and then the first rows are taken until the limit is reached. Limit is applied to a result set after offset.

If the query builder already has a limit, the old limit will be discarded.

Parameters

int $limit

Returns: $this

Definition at line 441 of file SelectQueryBuilder.php.

References Wikimedia\Rdbms\SelectQueryBuilder\options().

◆ lockInShareMode()

Wikimedia\Rdbms\SelectQueryBuilder::lockInShareMode ( )

Enable the LOCK IN SHARE MODE option.

Lock the returned rows so that they can't be changed until the next COMMIT. Cannot be used with aggregate functions (COUNT, MAX, etc., but also DISTINCT).

Returns: $this

Definition at line 453 of file SelectQueryBuilder.php.

References Wikimedia\Rdbms\SelectQueryBuilder\options().

Referenced by Wikimedia\Rdbms\SelectQueryBuilder\recency().

◆ merge()

Wikimedia\Rdbms\SelectQueryBuilder::merge ( SelectQueryBuilder $builder )

Merge another query builder with this one.

Append the other builder's tables, joins, fields, conditions and options to this one.

Since: 1.41

Parameters

SelectQueryBuilder $builder

Returns: $this

Definition at line 173 of file SelectQueryBuilder.php.

References Wikimedia\Rdbms\SelectQueryBuilder\caller(), Wikimedia\Rdbms\SelectQueryBuilder\conds(), Wikimedia\Rdbms\SelectQueryBuilder\fields(), Wikimedia\Rdbms\SelectQueryBuilder\joinConds(), Wikimedia\Rdbms\SelectQueryBuilder\options(), Wikimedia\Rdbms\SelectQueryBuilder\rawTables(), Wikimedia\Rdbms\SelectQueryBuilder\tables(), and Wikimedia\Rdbms\SelectQueryBuilder\where().

◆ newJoinGroup()

Wikimedia\Rdbms\SelectQueryBuilder::newJoinGroup ( )

Create a parenthesized group of joins which can be added to the object like a table.

The group is initially empty.

Returns: JoinGroup

Definition at line 412 of file SelectQueryBuilder.php.

References Wikimedia\Rdbms\SelectQueryBuilder\getAutoAlias().

◆ newSubquery()

Wikimedia\Rdbms\SelectQueryBuilder::newSubquery ( )

Get an empty SelectQueryBuilder which can be used to build a subquery of this query.

Returns: SelectQueryBuilder

Definition at line 190 of file SelectQueryBuilder.php.

References Wikimedia\Rdbms\SelectQueryBuilder\$db.

Referenced by MediaWiki\Block\HideUserUtils\addFieldToBuilder().

◆ offset()

Wikimedia\Rdbms\SelectQueryBuilder::offset ( $offset )

Set the offset.

Skip this many rows at the start of the result set. Offset with limit() can theoretically be used for paging through a result set, but this is discouraged for performance reasons.

If the query builder already has an offset, the old offset will be discarded.

Parameters

int $offset

Returns: $this

Definition at line 426 of file SelectQueryBuilder.php.

References Wikimedia\Rdbms\SelectQueryBuilder\options().

◆ option()

Wikimedia\Rdbms\SelectQueryBuilder::option	(		$name,
			$value = null )

Manually set an option in the $options array to be passed to IReadableDatabase::select()

Parameters

string	$name	The option name
mixed	$value	The option value, or null for a boolean option

Returns: $this

Definition at line 698 of file SelectQueryBuilder.php.

References Wikimedia\Rdbms\SelectQueryBuilder\options().

◆ options()

Wikimedia\Rdbms\SelectQueryBuilder::options ( array $options )

Manually set multiple options in the $options array to be passed to IReadableDatabase::select().

Parameters

array $options

Returns: $this

Definition at line 714 of file SelectQueryBuilder.php.

References Wikimedia\Rdbms\SelectQueryBuilder\options().

◆ orderBy()

Wikimedia\Rdbms\SelectQueryBuilder::orderBy	(		$fields,
			$direction = null )

Set the ORDER BY clause.

If it has already been set, append the additional fields to it.

Parameters

string[] \| string	$fields	The field or list of fields to order by.
string \| null	$direction	Sorting direction applied to all fields, self::SORT_ASC or self::SORT_DESC. If different fields need to be sorted in opposite directions, then this parameter must be omitted, and $fields must contain 'ASC' or 'DESC' after each field name.

Returns: $this

Definition at line 536 of file SelectQueryBuilder.php.

◆ queryInfo()

Wikimedia\Rdbms\SelectQueryBuilder::queryInfo ( $info )

Set the query parameters to the given values, appending to the values which were already set.

This can be used to interface with legacy code. If a key is omitted, the previous value will be retained.

The parameters must be formatted as required by IReadableDatabase::select. For example, JoinGroup cannot be used.

Parameters

array

$info

Associative array of query info, with keys:

tables: The raw array of tables to be passed to IReadableDatabase::select()
fields: The fields
conds: The conditions
options: The query options
join_conds: The join conditions
joins: Alias for join_conds. If both joins and join_conds are specified, the values will be merged.
caller: The caller signature

Returns: $this

Definition at line 115 of file SelectQueryBuilder.php.

References Wikimedia\Rdbms\SelectQueryBuilder\caller(), Wikimedia\Rdbms\SelectQueryBuilder\fields(), Wikimedia\Rdbms\SelectQueryBuilder\joinConds(), Wikimedia\Rdbms\SelectQueryBuilder\options(), Wikimedia\Rdbms\SelectQueryBuilder\rawTables(), and Wikimedia\Rdbms\SelectQueryBuilder\where().

Referenced by MediaWiki\Api\ApiQueryBase\select().

◆ rawTables()

Wikimedia\Rdbms\SelectQueryBuilder::rawTables ( $tables )

Given a table or table array as might be passed to IReadableDatabase::select(), append it to the existing tables, interpreting nested arrays as join groups.

This can be used to interface with existing code that expresses join groups as nested arrays. In new code, join groups should generally be created with newJoinGroup(), which provides a fluent interface.

Parameters

string | array $tables Table references; see IReadableDatabase::select for details

Returns: $this

Definition at line 153 of file SelectQueryBuilder.php.

References Wikimedia\Rdbms\JoinGroupBase\$tables, and Wikimedia\Rdbms\SelectQueryBuilder\tables().

Referenced by Wikimedia\Rdbms\SelectQueryBuilder\merge(), Wikimedia\Rdbms\SelectQueryBuilder\queryInfo(), and MediaWiki\Api\ApiQueryBase\select().

◆ recency()

Wikimedia\Rdbms\SelectQueryBuilder::recency ( $recency )

Parameters

int $recency Bitfield of IDBAccessObject::READ_* constants

Returns: $this

Definition at line 723 of file SelectQueryBuilder.php.

References Wikimedia\Rdbms\SelectQueryBuilder\forUpdate(), Wikimedia\Rdbms\SelectQueryBuilder\lockInShareMode(), Wikimedia\Rdbms\IDBAccessObject\READ_EXCLUSIVE, and Wikimedia\Rdbms\IDBAccessObject\READ_LOCKING.

◆ select()

Wikimedia\Rdbms\SelectQueryBuilder::select ( $fields )

Add a field or an array of fields to the query.

Alias for fields().

Parameters

string | string[] $fields

Returns: $this

Definition at line 257 of file SelectQueryBuilder.php.

References Wikimedia\Rdbms\SelectQueryBuilder\fields().

Referenced by MediaWiki\Logging\LoggingSelectQueryBuilder\__construct(), MediaWiki\Revision\ArchiveSelectQueryBuilder\__construct(), MediaWiki\Revision\RevisionSelectQueryBuilder\__construct(), and MediaWiki\Block\HideUserUtils\addFieldToBuilder().

◆ setMaxExecutionTime()

Wikimedia\Rdbms\SelectQueryBuilder::setMaxExecutionTime ( int $time )

Set MAX_EXECUTION_TIME for queries.

Parameters

int $time maximum allowed time in milliseconds

Returns: $this

Definition at line 486 of file SelectQueryBuilder.php.

References Wikimedia\Rdbms\SelectQueryBuilder\options().

◆ smallResult()

Wikimedia\Rdbms\SelectQueryBuilder::smallResult ( )

Enable the SQL_SMALL_RESULT option.

Returns: $this

Definition at line 675 of file SelectQueryBuilder.php.

References Wikimedia\Rdbms\SelectQueryBuilder\options().

◆ straightJoinOption()

Wikimedia\Rdbms\SelectQueryBuilder::straightJoinOption ( )

Enable the STRAIGHT_JOIN query option.

Returns: $this

Definition at line 645 of file SelectQueryBuilder.php.

References Wikimedia\Rdbms\SelectQueryBuilder\options().

◆ tables()

Wikimedia\Rdbms\SelectQueryBuilder::tables ( $tables )

Add multiple tables.

It's recommended to use join() and leftJoin() instead in new code.

Parameters

string[] $tables Table references (string keys are aliases). See table for details.

Returns: $this

Definition at line 216 of file SelectQueryBuilder.php.

References Wikimedia\Rdbms\JoinGroupBase\$tables, and Wikimedia\Rdbms\JoinGroupBase\table().

Referenced by Wikimedia\Rdbms\SelectQueryBuilder\merge(), and Wikimedia\Rdbms\SelectQueryBuilder\rawTables().

◆ useIndex()

Wikimedia\Rdbms\SelectQueryBuilder::useIndex ( $index )

Set a USE INDEX option.

If a string is given, the index hint is applied to the most recently appended table or alias. If an array is given, it is assumed to be an associative array with the alias names in the keys and the indexes in the values, as in the USE INDEX option to IReadableDatabase::select(). The array will be merged with the existing value.

Parameters

string | string[] $index

Returns: $this

Definition at line 581 of file SelectQueryBuilder.php.

◆ where()

Wikimedia\Rdbms\SelectQueryBuilder::where ( $conds )

Add conditions to the query.

The supplied conditions will be appended to the existing conditions, separated by AND.

@phpcs:ignore Generic.Files.LineLength

Parameters

May be either a string containing a single condition, or an array of conditions. If an array is given, the conditions constructed from each element are combined with AND.

Array elements may take one of two forms:

Elements with a numeric key are interpreted as raw SQL fragments.
Elements with a string key are interpreted as equality conditions, where the key is the field name.
- If the value of such an array element is a scalar (such as a string), it will be treated as data and thus quoted appropriately. If it is null, an IS NULL clause will be added.
- If the value is an array, an IN (...) clause will be constructed from its non-null elements, and an IS NULL clause will be added if null is present, such that the field may match any of the elements in the array. The non-null elements will be quoted.

Note that expressions are often DBMS-dependent in their syntax. DBMS-independent wrappers are provided for constructing several types of expression commonly used in condition queries. See:

IReadableDatabase::buildLike()
IReadableDatabase::conditional()

Untrusted user input is safe in the values of string keys, however untrusted input must not be used in the array key names or in the values of numeric keys. Escaping of untrusted input used in values of numeric keys should be done via IReadableDatabase::addQuotes()

Returns: $this

Definition at line 340 of file SelectQueryBuilder.php.

References Wikimedia\Rdbms\SelectQueryBuilder\conds(), and Wikimedia\Rdbms\Platform\ISQLPlatform\LIST_AND.

Referenced by Wikimedia\Rdbms\SelectQueryBuilder\andWhere(), Wikimedia\Rdbms\SelectQueryBuilder\conds(), Wikimedia\Rdbms\SelectQueryBuilder\merge(), MediaWiki\ChangeTags\ChangeTagsStore\modifyDisplayQueryBuilder(), Wikimedia\Rdbms\SelectQueryBuilder\queryInfo(), and MediaWiki\Api\ApiQueryBase\select().

Member Data Documentation

◆ $db

IReadableDatabase Wikimedia\Rdbms\SelectQueryBuilder::$db

protected

Definition at line 69 of file SelectQueryBuilder.php.

Referenced by Wikimedia\Rdbms\SelectQueryBuilder\__construct(), MediaWiki\Logging\LoggingSelectQueryBuilder\__construct(), MediaWiki\Revision\ArchiveSelectQueryBuilder\__construct(), MediaWiki\Revision\RevisionSelectQueryBuilder\__construct(), MediaWiki\User\UserSelectQueryBuilder\__construct(), MediaWiki\Page\PageSelectQueryBuilder\__construct(), MediaWiki\FileRepo\File\FileSelectQueryBuilder\__construct(), Wikimedia\Rdbms\SelectQueryBuilder\connection(), and Wikimedia\Rdbms\SelectQueryBuilder\newSubquery().

◆ $options

array Wikimedia\Rdbms\SelectQueryBuilder::$options = []

protected

The options to be passed to IReadableDatabase::select()

Definition at line 57 of file SelectQueryBuilder.php.

Referenced by MediaWiki\FileRepo\File\FileSelectQueryBuilder\__construct().

◆ SORT_ASC

const Wikimedia\Rdbms\SelectQueryBuilder::SORT_ASC = 'ASC'

sort the results in ascending order

Definition at line 29 of file SelectQueryBuilder.php.

◆ SORT_DESC

const Wikimedia\Rdbms\SelectQueryBuilder::SORT_DESC = 'DESC'

sort the results in descending order

Definition at line 32 of file SelectQueryBuilder.php.

The documentation for this class was generated from the following file:

includes/libs/rdbms/querybuilder/SelectQueryBuilder.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ acquireRowLocks()

◆ andWhere()

◆ bigResult()

◆ bufferResult()

◆ buildGroupConcatField()

◆ calcFoundRows()

◆ caller()

◆ clearFields()

◆ conds()

◆ connection()

◆ distinct()

◆ estimateRowCount()

◆ explain()

◆ fetchField()

◆ fetchFieldValues()

◆ fetchResultSet()

◆ fetchRow()

◆ fetchRowCount()

◆ field()

◆ fields()

◆ forUpdate()

◆ from()

◆ getAutoAlias()

◆ getCaller()

◆ getQueryInfo()

◆ getSQL()

◆ groupBy()

◆ having()

◆ ignoreIndex()

◆ joinConds()

◆ limit()

◆ lockInShareMode()

◆ merge()

◆ newJoinGroup()

◆ newSubquery()

◆ offset()

◆ option()

◆ options()

◆ orderBy()

◆ queryInfo()

◆ rawTables()

◆ recency()

◆ select()

◆ setMaxExecutionTime()

◆ smallResult()

◆ straightJoinOption()

◆ tables()

◆ useIndex()

◆ where()

Member Data Documentation

◆ $db

◆ $options

◆ SORT_ASC

◆ SORT_DESC