Sequence

interface Sequence

Methods

listSequences

List all sequences in the database.

public listSequences(): array

Returns: array

sequenceExists

Check if a sequence exists.

public sequenceExists(string $sequenceName): bool

Returns: bool

Parameters

Parameter	Type	Description
$sequenceName	string

describeSequence

Describe a sequence.

public describeSequence(string $name): array|false

Returns: array|false

Parameters

Parameter	Type	Description
$name	string

createSequence

Create a new sequence.

public createSequence(string $name, array $sequenceInfo, bool $ifNotExists): bool

Returns: bool

Parameters

Parameter	Type	Description
$name	string
$sequenceInfo	array
$ifNotExists	bool

dropSequence

Drop a sequence.

public dropSequence(string $name, bool $ifExists): bool

Returns: bool

Parameters

Parameter	Type	Description
$name	string
$ifExists	bool

nextSequenceValue

Get the next value from a sequence.

public nextSequenceValue(string $name): false|int

Returns: false|int

Parameters

Parameter	Type	Description
$name	string

setSequenceValue

Set the value of a sequence.

public setSequenceValue(string $name, int $value): bool

Returns: bool

Parameters

Parameter	Type	Description
$name	string
$value	int

---

Generated by Hazaar API Doc Generator on Fri, 04 Sep 2026 23:32:16 +0000