public function Connection::nextId in Drupal 9

Same name in this branch

9 core/lib/Drupal/Core/Database/Connection.php \Drupal\Core\Database\Connection::nextId()
9 core/tests/fixtures/database_drivers/custom/fake/Connection.php \Drupal\Driver\Database\fake\Connection::nextId()
9 core/lib/Drupal/Core/Database/Driver/sqlite/Connection.php \Drupal\Core\Database\Driver\sqlite\Connection::nextId()
9 core/lib/Drupal/Core/Database/Driver/pgsql/Connection.php \Drupal\Core\Database\Driver\pgsql\Connection::nextId()
9 core/lib/Drupal/Core/Database/Driver/mysql/Connection.php \Drupal\Core\Database\Driver\mysql\Connection::nextId()

Same name and namespace in other branches

8 core/lib/Drupal/Core/Database/Driver/mysql/Connection.php \Drupal\Core\Database\Driver\mysql\Connection::nextId()

Retrieves a unique ID from a given sequence.

Use this function if for some reason you can't use a serial field. For example, MySQL has no ways of reading of the current value of a sequence and PostgreSQL can not advance the sequence to be larger than a given value. Or sometimes you just need a unique integer.

Parameters

$existing_id: (optional) After a database import, it might be that the sequences table is behind, so by passing in the maximum existing ID, it can be assured that we never issue the same ID.

Return value

An integer number larger than any number returned by earlier calls and also larger than the $existing_id if one was passed in.

Overrides Connection::nextId

File

core/lib/Drupal/Core/Database/Driver/mysql/Connection.php, line 346

Class

Connection: MySQL implementation of \Drupal\Core\Database\Connection.

Namespace

Drupal\Core\Database\Driver\mysql

Code

public function nextId($existing_id = 0) {
  $new_id = $this
    ->query('INSERT INTO {sequences} () VALUES ()', [], [
    'return' => Database::RETURN_INSERT_ID,
  ]);

  // This should only happen after an import or similar event.
  if ($existing_id >= $new_id) {

    // If we INSERT a value manually into the sequences table, on the next
    // INSERT, MySQL will generate a larger value. However, there is no way
    // of knowing whether this value already exists in the table. MySQL
    // provides an INSERT IGNORE which would work, but that can mask problems
    // other than duplicate keys. Instead, we use INSERT ... ON DUPLICATE KEY
    // UPDATE in such a way that the UPDATE does not do anything. This way,
    // duplicate keys do not generate errors but everything else does.
    $this
      ->query('INSERT INTO {sequences} (value) VALUES (:value) ON DUPLICATE KEY UPDATE value = value', [
      ':value' => $existing_id,
    ]);
    $new_id = $this
      ->query('INSERT INTO {sequences} () VALUES ()', [], [
      'return' => Database::RETURN_INSERT_ID,
    ]);
  }
  $this->needsCleanup = TRUE;
  return $new_id;
}

You are here