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
- class Query implements QueryPlaceholderInterface
- class MergeQuery implements QueryConditionInterface
Expanded class hierarchy of MergeQuery
Related topics
File
- includes/
database/ query.inc, line 1261 - Non-specific Database query code. Used by all engines.
Members
Name | Modifiers | Type | Description |
---|---|---|---|
MergeQuery:: |
protected | property | An array of fields which should be set to their database-defined defaults. |
MergeQuery:: |
protected | property | Array of fields to update to an expression in case of a duplicate record. |
MergeQuery:: |
protected | property | An array of fields on which to insert. |
MergeQuery:: |
protected | property | An array of values to be inserted. |
MergeQuery:: |
protected | property | Flag indicating whether an UPDATE is necessary. |
MergeQuery:: |
protected | property | The result of the merge query. |
MergeQuery:: |
protected | property | The table to be used for INSERT and UPDATE. |
MergeQuery:: |
protected | property | An array of fields that will be updated. |
MergeQuery:: |
public | function |
Implements QueryConditionInterface::arguments(). Overrides QueryConditionInterface:: |
MergeQuery:: |
public | function |
Implements QueryConditionInterface::compile(). Overrides QueryConditionInterface:: |
MergeQuery:: |
public | function |
Implements QueryConditionInterface::compiled(). Overrides QueryConditionInterface:: |
MergeQuery:: |
public | function |
Implements QueryConditionInterface::condition(). Overrides QueryConditionInterface:: |
MergeQuery:: |
public | function |
Implements QueryConditionInterface::conditions(). Overrides QueryConditionInterface:: |
MergeQuery:: |
public | function |
Constructs a MergeQuery object. Overrides Query:: |
MergeQuery:: |
public | function |
Runs the query against the database. Overrides Query:: |
MergeQuery:: |
public | function |
Implements QueryConditionInterface::exists(). Overrides QueryConditionInterface:: |
MergeQuery:: |
public | function | Specifies fields to be updated as an expression. |
MergeQuery:: |
public | function | Sets common field-value pairs in the INSERT and UPDATE query parts. |
MergeQuery:: |
public | function | Return the result of the merge query. |
MergeQuery:: |
public | function | Adds a set of field->value pairs to be inserted. |
MergeQuery:: |
public | function |
Implements QueryConditionInterface::isNotNull(). Overrides QueryConditionInterface:: |
MergeQuery:: |
public | function |
Implements QueryConditionInterface::isNull(). Overrides QueryConditionInterface:: |
MergeQuery:: |
public | function | Sets the key field(s) to be used as conditions for this query. |
MergeQuery:: |
public | function |
Implements QueryConditionInterface::notExists(). Overrides QueryConditionInterface:: |
MergeQuery:: |
constant | Returned by execute() if an INSERT query has been executed. | |
MergeQuery:: |
constant | Returned by execute() if an UPDATE query has been executed. | |
MergeQuery:: |
public | function |
Implements PHP magic __toString method to convert the query to a string. Overrides Query:: |
MergeQuery:: |
public | function | Adds a set of field->value pairs to be updated. |
MergeQuery:: |
public | function | Specifies fields for which the database-defaults should be used. |
MergeQuery:: |
public | function |
Implements QueryConditionInterface::where(). Overrides QueryConditionInterface:: |
Query:: |
protected | property | An array of comments that can be prepended to a query. |
Query:: |
protected | property | The connection object on which to run this query. |
Query:: |
protected | property | The key of the connection object. |
Query:: |
protected | property | The target of the connection object. |
Query:: |
protected | property | The placeholder counter. |
Query:: |
protected | property | The query options to pass on to the connection object. |
Query:: |
protected | property | A unique identifier for this query object. |
Query:: |
public | function | Implements the magic __clone function. |
Query:: |
public | function | Adds a comment to the query. |
Query:: |
public | function | Returns a reference to the comments array for the query. |
Query:: |
public | function |
Gets the next placeholder value for this query object. Overrides QueryPlaceholderInterface:: |
Query:: |
public | function | Implements the magic __sleep function to disconnect from the database. |
Query:: |
public | function |
Returns a unique identifier for this object. Overrides QueryPlaceholderInterface:: |
Query:: |
public | function | Implements the magic __wakeup function to reconnect to the database. |