You are here

abstract public function Connection::nextId in Drupal 8

Same name in this branch
  1. 8 core/lib/Drupal/Core/Database/Connection.php \Drupal\Core\Database\Connection::nextId()
  2. 8 core/tests/fixtures/database_drivers/custom/fake/Connection.php \Drupal\Driver\Database\fake\Connection::nextId()
  3. 8 core/lib/Drupal/Core/Database/Driver/sqlite/Connection.php \Drupal\Core\Database\Driver\sqlite\Connection::nextId()
  4. 8 core/lib/Drupal/Core/Database/Driver/pgsql/Connection.php \Drupal\Core\Database\Driver\pgsql\Connection::nextId()
  5. 8 core/lib/Drupal/Core/Database/Driver/mysql/Connection.php \Drupal\Core\Database\Driver\mysql\Connection::nextId()
Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Database/Connection.php \Drupal\Core\Database\Connection::nextId()

Retrieves an 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.

5 methods override Connection::nextId()
Connection::nextId in core/tests/fixtures/database_drivers/custom/fake/Connection.php
Retrieves an unique ID from a given sequence.
Connection::nextId in core/lib/Drupal/Core/Database/Driver/sqlite/Connection.php
Retrieves an unique ID from a given sequence.
Connection::nextId in core/lib/Drupal/Core/Database/Driver/pgsql/Connection.php
Retrieve a the next id in a sequence.
Connection::nextId in core/lib/Drupal/Core/Database/Driver/mysql/Connection.php
Retrieves an unique ID from a given sequence.
StubConnection::nextId in core/tests/Drupal/Tests/Core/Database/Stub/StubConnection.php
Retrieves an unique ID from a given sequence.

File

core/lib/Drupal/Core/Database/Connection.php, line 1499

Class

Connection
Base Database API class.

Namespace

Drupal\Core\Database

Code

public abstract function nextId($existing_id = 0);