abstract class Upsert

General class for an abstracted "Upsert" (UPDATE or INSERT) query operation.

This class can only be used with a table with a single unique index. Often, this will be the primary key. On such a table this class works like Insert except the rows will be set to the desired values even if the key existed before.

Hierarchy

• class \Drupal\Core\Database\Query\Query implements PlaceholderInterface
  • class \Drupal\Core\Database\Query\Upsert implements \Countable uses InsertTrait

File

core/lib/Drupal/Core/Database/Query/Upsert.php, line 16

Namespace

Drupal\Core\Database\Query

Members

Name	Modifiers	Type	Description
InsertTrait::$defaultFields	protected	property	An array of fields that should be set to their database-defined defaults.
InsertTrait::$insertFields	protected	property	An array of fields on which to insert.
InsertTrait::$insertValues	protected	property	A nested array of values to insert.
InsertTrait::$table	protected	property	The table on which to insert.
InsertTrait::count	public	function
InsertTrait::fields	public	function	Adds a set of field->value pairs to be inserted.
InsertTrait::getInsertPlaceholderFragment	protected	function	Returns the query placeholders for values that will be inserted.
InsertTrait::useDefaults	public	function	Specifies fields for which the database defaults should be used.
InsertTrait::values	public	function	Adds another set of values to the query to be inserted.
Query::$comments	protected	property	An array of comments that can be prepended to a query.
Query::$connection	protected	property	The connection object on which to run this query.
Query::$connectionKey	protected	property	The key of the connection object.
Query::$connectionTarget	protected	property	The target of the connection object.
Query::$nextPlaceholder	protected	property	The placeholder counter.
Query::$queryOptions	protected	property	The query options to pass on to the connection object.
Query::$uniqueIdentifier	protected	property	A unique identifier for this query object.
Query::comment	public	function	Adds a comment to the query.
Query::getComments	public	function	Returns a reference to the comments array for the query.
Query::nextPlaceholder	public	function	Gets the next placeholder value for this query object. Overrides PlaceholderInterface::nextPlaceholder
Query::uniqueIdentifier	public	function	Returns a unique identifier for this object. Overrides PlaceholderInterface::uniqueIdentifier
Query::__clone	public	function	Implements the magic __clone function.
Query::__sleep	public	function	Implements the magic __sleep function to disconnect from the database.
Query::__toString	abstract public	function	Implements PHP magic __toString method to convert the query to a string.
Query::__wakeup	public	function	Implements the magic __wakeup function to reconnect to the database.
Upsert::$key	protected	property	The unique or primary key of the table.
Upsert::execute	public	function	Runs the query against the database. Overrides Query::execute
Upsert::key	public	function	Sets the unique / primary key field to be used as condition for this query.
Upsert::preExecute	protected	function	Preprocesses and validates the query.
Upsert::__construct	public	function	Constructs an Upsert object. Overrides Query::__construct