General class for an abstracted MERGE query operation.

An ANSI SQL:2003 compatible database would run the following query:

MERGE INTO table_name_1 USING table_name_2 ON (condition)
  WHEN MATCHED THEN
  UPDATE SET column1 = value1 [, column2 = value2 ...]
  WHEN NOT MATCHED THEN
  INSERT (column1 [, column2 ...]) VALUES (value1 [, value2 ...

MySQL does not directly implement MERGE queries and will emulate this statement by running an UPDATE, and if that does not match any rows, then an INSERT.

The condition is built exactly like SelectQuery or UpdateQuery conditions, the UPDATE query part is built similarly like an UpdateQuery and finally the INSERT query part is built similarly like an InsertQuery. However, both UpdateQuery and InsertQuery has a fields method so MergeQuery::updateFields() and MergeQuery::insertFields() needs to be called instead. MergeQuery::fields() can also be called which calls both of these methods as the common case is to use the same column-value pairs for both INSERT and UPDATE. However, this is not mandatory. Another convenient wrapper is MergeQuery::key() which adds the same column-value pairs to the condition and the INSERT query part.

Several methods (key(), fields(), insertFields()) can be called to set a key-value pair for the INSERT query part. Subsequent calls for the same fields override the earlier ones. The same is true for UPDATE and key(), fields() and updateFields().

Hierarchy

Expanded class hierarchy of MergeQuery

Related topics

File

core/includes/database/query.inc, line 1282
Non-specific Database query code. Used by all engines.

Members

Contains filters are case sensitive
Name Modifiers Type Descriptionsort ascending
Query::$connectionTarget protected property The target of the connection object.
MergeQuery::$table protected property The table to be used for INSERT and UPDATE.
MergeQuery::$result protected property The result of the merge query.
Query::$queryOptions protected property The query options to pass on to the connection object.
Query::$nextPlaceholder protected property The placeholder counter.
Query::$connectionKey protected property The key of the connection object.
Query::$connection protected property The connection object on which to run this query.
MergeQuery::$condition protected property The condition object for this query.
MergeQuery::expression public function Specifies fields to be updated as an expression.
MergeQuery::useDefaults public function Specifies fields for which the database-defaults should be used.
MergeQuery::key public function Sets the key field(s) to be used as conditions for this query.
MergeQuery::fields public function Sets common field-value pairs in the INSERT and UPDATE query parts.
MergeQuery::exists public function Sets a condition that the specified subquery returns values. Overrides QueryConditionInterface::exists
MergeQuery::notExists public function Sets a condition that the specified subquery returns no values. Overrides QueryConditionInterface::notExists
MergeQuery::isNull public function Sets a condition that the specified field be NULL. Overrides QueryConditionInterface::isNull
MergeQuery::isNotNull public function Sets a condition that the specified field be NOT NULL. Overrides QueryConditionInterface::isNotNull
MergeQuery::execute public function Runs the query against the database. Overrides Query::execute
Query::uniqueIdentifier public function Returns a unique identifier for this object. Overrides QueryPlaceholderInterface::uniqueIdentifier
Query::getComments public function Returns a reference to the comments array for the query.
MergeQuery::STATUS_UPDATE constant Returned by execute() if an UPDATE query has been executed.
MergeQuery::STATUS_INSERT constant Returned by execute() if an INSERT query has been executed.
MergeQuery::getResult public function Return the result of the merge query.
Query::__wakeup public function Implements the magic __wakeup function to reconnect to the database.
Query::__sleep public function Implements the magic __sleep function to disconnect from the database.
Query::__clone public function Implements the magic __clone function.
MergeQuery::__toString public function Implements PHP magic __toString method to convert the query to a string. Overrides Query::__toString
MergeQuery::condition public function Helper function: builds the most common conditional clauses. Overrides QueryConditionInterface::condition
Query::nextPlaceholder public function Gets the next placeholder value for this query object. Overrides QueryPlaceholderInterface::nextPlaceholder
MergeQuery::arguments public function Gets a complete list of all values to insert into the prepared statement. Overrides QueryConditionInterface::arguments
MergeQuery::conditions public function Gets a complete list of all conditions in this conditional clause. Overrides QueryConditionInterface::conditions
MergeQuery::$needsUpdate protected property Flag indicating whether an UPDATE is necessary.
MergeQuery::__construct public function Constructs a MergeQuery object. Overrides Query::__construct
MergeQuery::compile public function Compiles the saved conditions for later retrieval. Overrides QueryConditionInterface::compile
MergeQuery::compiled public function Check whether a condition has been previously compiled. Overrides QueryConditionInterface::compiled
MergeQuery::$expressionFields protected property Array of fields to update to an expression in case of a duplicate record.
MergeQuery::$insertValues protected property An array of values to be inserted.
MergeQuery::$defaultFields protected property An array of fields which should be set to their database-defined defaults.
MergeQuery::$updateFields protected property An array of fields that will be updated.
MergeQuery::$insertFields protected property An array of fields on which to insert.
Query::$comments protected property An array of comments that can be prepended to a query.
MergeQuery::where public function Adds an arbitrary WHERE clause to the query. Overrides QueryConditionInterface::where
MergeQuery::updateFields public function Adds a set of field->value pairs to be updated.
MergeQuery::insertFields public function Adds a set of field->value pairs to be inserted.
Query::comment public function Adds a comment to the query.
Query::$uniqueIdentifier protected property A unique identifier for this query object, as generated by uniqid().