MediaWiki master
Public Member Functions | List of all members
Wikimedia\Rdbms\IWriteQueryBuilder Interface Reference
Database

Shared interface of all write query builders. More...

Inherited by Wikimedia\Rdbms\DeleteQueryBuilder, Wikimedia\Rdbms\InsertQueryBuilder, Wikimedia\Rdbms\ReplaceQueryBuilder, and Wikimedia\Rdbms\UpdateQueryBuilder.

Public Member Functions

 caller ( $fname)
 Set the method name to be included in an SQL comment.
 
 connection (IDatabase $db)
 Change the IDatabase object the query builder is bound to.
 
 execute ()
 Run the constructed query.
 
 getQueryInfo ()
 Get an associative array describing the query in terms of its raw parameters to the counter-part method in Database object.
 
 queryInfo ( $info)
 Set the query parameters to the given values, appending to the values which were already set.
 

Detailed Description

Shared interface of all write query builders.

Since
1.46

Definition at line 11 of file IWriteQueryBuilder.php.

Member Function Documentation

◆ caller()

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

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

Parameters
string$fname
Returns
$this

Implemented in Wikimedia\Rdbms\DeleteQueryBuilder, Wikimedia\Rdbms\InsertQueryBuilder, Wikimedia\Rdbms\ReplaceQueryBuilder, and Wikimedia\Rdbms\UpdateQueryBuilder.

◆ connection()

Wikimedia\Rdbms\IWriteQueryBuilder::connection ( IDatabase $db)

Change the IDatabase object the query builder is bound to.

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

Parameters
IDatabase$db
Returns
$this

Implemented in Wikimedia\Rdbms\DeleteQueryBuilder, Wikimedia\Rdbms\InsertQueryBuilder, Wikimedia\Rdbms\ReplaceQueryBuilder, and Wikimedia\Rdbms\UpdateQueryBuilder.

◆ execute()

Wikimedia\Rdbms\IWriteQueryBuilder::execute ( )

Run the constructed query.

Implemented in Wikimedia\Rdbms\DeleteQueryBuilder, Wikimedia\Rdbms\InsertQueryBuilder, Wikimedia\Rdbms\ReplaceQueryBuilder, and Wikimedia\Rdbms\UpdateQueryBuilder.

◆ getQueryInfo()

Wikimedia\Rdbms\IWriteQueryBuilder::getQueryInfo ( )

Get an associative array describing the query in terms of its raw parameters to the counter-part method in Database object.

This can be used to interface with legacy code.

Returns
array The query info array, with keys:
  • table: The table name
  • set: The set array
  • conds: The conditions
  • options: The query options
  • caller: The caller signature

Implemented in Wikimedia\Rdbms\DeleteQueryBuilder, Wikimedia\Rdbms\InsertQueryBuilder, Wikimedia\Rdbms\ReplaceQueryBuilder, and Wikimedia\Rdbms\UpdateQueryBuilder.

◆ queryInfo()

Wikimedia\Rdbms\IWriteQueryBuilder::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 the counter-part method in Database object.

Parameters
array$infoAssociative array of query info, with keys:
  • table: The table name to be passed to the counter-part method in Database object
  • set: The set conditions
  • conds: The conditions
  • options: The query options
  • caller: The caller signature.
Returns
$this

Implemented in Wikimedia\Rdbms\DeleteQueryBuilder, Wikimedia\Rdbms\InsertQueryBuilder, Wikimedia\Rdbms\ReplaceQueryBuilder, and Wikimedia\Rdbms\UpdateQueryBuilder.

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