Inherits Wikimedia\Rdbms\SelectQueryBuilder.

Collaboration diagram for MediaWiki\Page\PageSelectQueryBuilder:

[legend]

Public Member Functions
	__construct (IReadableDatabase $db, PageStore $pageStore, ?LinkCache $linkCache=null)

	fetchPageIds ()
	Returns an array of page ids matching the query.

	fetchPageRecord ()
	Fetch a single PageRecord that matches specified criteria.

	fetchPageRecordArray ()
	Fetch PageRecords for the specified query as an associative array, using page IDs as array keys.

	fetchPageRecords ()
	Fetch PageRecords for the specified query.

	orderByPageId (string $dir=self::SORT_ASC)
	Order results by page id.

	orderByTitle (string $dir=self::SORT_ASC)
	Order results by namespace and title in $direction.

	whereNamespace (int $namespace)
	Find by provided namespace.

	wherePageIds ( $pageIds)
	Find by provided page ids.

	whereTitlePrefix (int $namespace, string $prefix)
	Find by provided prefix.

	whereTitles (int $namespace, $pageTitles)
	Find by provided page titles.

Public Member Functions inherited from Wikimedia\Rdbms\SelectQueryBuilder
	__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.

Additional Inherited Members
Public Attributes inherited from Wikimedia\Rdbms\SelectQueryBuilder
const	SORT_ASC = 'ASC'
	sort the results in ascending order

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

Protected Member Functions inherited from Wikimedia\Rdbms\SelectQueryBuilder
	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 inherited from Wikimedia\Rdbms\SelectQueryBuilder
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

Since: 1.36

Definition at line 15 of file PageSelectQueryBuilder.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Page\PageSelectQueryBuilder::__construct	(	IReadableDatabase	$db,
		PageStore	$pageStore,
		?LinkCache	$linkCache = null )

Parameters

IReadableDatabase	$db
PageStore	$pageStore
LinkCache \| null	$linkCache	A link cache to store any retrieved rows into

Access: internal

Definition at line 30 of file PageSelectQueryBuilder.php.

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

Member Function Documentation

◆ fetchPageIds()

MediaWiki\Page\PageSelectQueryBuilder::fetchPageIds ( )

Returns an array of page ids matching the query.

Returns: int[]

Definition at line 183 of file PageSelectQueryBuilder.php.

◆ fetchPageRecord()

MediaWiki\Page\PageSelectQueryBuilder::fetchPageRecord ( )

Fetch a single PageRecord that matches specified criteria.

Returns: PageRecord|null

Definition at line 128 of file PageSelectQueryBuilder.php.

◆ fetchPageRecordArray()

MediaWiki\Page\PageSelectQueryBuilder::fetchPageRecordArray ( )

Fetch PageRecords for the specified query as an associative array, using page IDs as array keys.

Returns: ExistingPageRecord[]

Definition at line 168 of file PageSelectQueryBuilder.php.

◆ fetchPageRecords()

MediaWiki\Page\PageSelectQueryBuilder::fetchPageRecords ( )

Fetch PageRecords for the specified query.

Returns: Iterator<ExistingPageRecord>

Definition at line 148 of file PageSelectQueryBuilder.php.

◆ orderByPageId()

MediaWiki\Page\PageSelectQueryBuilder::orderByPageId ( string $dir = self::SORT_ASC )

Order results by page id.

Parameters

string $dir one of self::SORT_ASC or self::SORT_DESC

Returns: PageSelectQueryBuilder

Definition at line 118 of file PageSelectQueryBuilder.php.

◆ orderByTitle()

MediaWiki\Page\PageSelectQueryBuilder::orderByTitle ( string $dir = self::SORT_ASC )

Order results by namespace and title in $direction.

Parameters

string $dir one of self::SORT_ASC or self::SORT_DESC

Returns: PageSelectQueryBuilder

Definition at line 106 of file PageSelectQueryBuilder.php.

◆ whereNamespace()

MediaWiki\Page\PageSelectQueryBuilder::whereNamespace ( int $namespace )

Find by provided namespace.

Parameters

int $namespace

Returns: PageSelectQueryBuilder

Definition at line 63 of file PageSelectQueryBuilder.php.

◆ wherePageIds()

MediaWiki\Page\PageSelectQueryBuilder::wherePageIds ( $pageIds )

Find by provided page ids.

Parameters

int | int[] $pageIds

Returns: PageSelectQueryBuilder

Definition at line 44 of file PageSelectQueryBuilder.php.

References Wikimedia\Rdbms\SelectQueryBuilder\conds().

◆ whereTitlePrefix()

MediaWiki\Page\PageSelectQueryBuilder::whereTitlePrefix	(	int	$namespace,
		string	$prefix )

Find by provided prefix.

Parameters

int	$namespace
string	$prefix

Returns: PageSelectQueryBuilder

Definition at line 76 of file PageSelectQueryBuilder.php.

◆ whereTitles()

MediaWiki\Page\PageSelectQueryBuilder::whereTitles	(	int	$namespace,
			$pageTitles )

Find by provided page titles.

Parameters

int	$namespace
string \| string[]	$pageTitles

Returns: PageSelectQueryBuilder

Definition at line 92 of file PageSelectQueryBuilder.php.

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

includes/Page/PageSelectQueryBuilder.php

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ fetchPageIds()

◆ fetchPageRecord()

◆ fetchPageRecordArray()

◆ fetchPageRecords()

◆ orderByPageId()

◆ orderByTitle()

◆ whereNamespace()

◆ wherePageIds()

◆ whereTitlePrefix()

◆ whereTitles()