PEAR Manual
PrevNext

DB_common::createSequence()

DB_common::createSequence() -- Creates a new sequence

Synopsis

integer createSequence (string $seq_name)

Description

See "Intro - Sequences"

Parameter

string $seq_name

name of the new sequence to create

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

Return value

integer - DB_OK or a DB_Error object on failure

Throws

Table 33-1. Possible PEAR_Error values

Error codeError messageReasonSolution
every error code  Database specific error Check the name of the sequence. If correct, probably a bug in the sequence implementation

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.

Example

Example 33-1. Using createSequence()

<?php
// Once you have a valid DB object named $db...
$tmp = $db->createSequence('mySequence');

if (PEAR::isError($tmp)) {
    die($tmp->getMessage());
}
?>

See

"Intro - Sequences", nextId(), dropSequence()

PrevHomeNext
DB_common::commit()UpDB_common::disconnect()