DB_common::nextId()

DB_common::nextId()

DB_common::nextId() -- Returns the next number from a sequence

Description

Returns the next available number from a sequence. The sequence is automatically incremented each time this method is called.

See "Intro - Sequences" for a more complete discusion.

Parameter

string $seq_name

name of the sequence

To avoid problems with various database systems, sequence names should start with a letter and only contain letters, numbers and the underscore character.

boolean $onDemand

When TRUE, the sequence is automatically created if it does not exist yet.

The on demand creation process necessitates the database user specified in the script having the database permissions needed to create a table or sequence. The exact privileges involved depends on the DBMS being used.

Return value

integer - a free id number or a DB_Error object on failure

Note

This function can not be called statically.

Warning

When using PEAR DB's sequence methods, we strongly advise using these methods for all procedures, including the creation of the sequences. Do not use PEAR DB's methods to access sequences that were created directly in the DBMS. See the warning on the "Intro - Sequences" page complete information.

© Copyright 2003-2023 www.php-editors.com. The ultimate PHP Editor and PHP IDE site.