db/sequence

Documentation

• source: db/sequence.ts

Overview

Classes

Sequence

nextval()

Retrieves the next available value from a specified sequence.

static nextval(sequence: string, tableName: string, datasourceName: string): number;

Parameter	Type	Description
sequence	string	The name of the database sequence.
tableName	string	Optional: The name of the table associated with the sequence (depends on database dialect/facade implementation).
datasourceName	string	Optional: The name of the database connection to use.

Returns

• Type: number
• Description: The next sequence value as a number.

create()

Creates a new database sequence.

static create(sequence: string, start: number, datasourceName: string): void;

Parameter	Type	Description
sequence	string	The name of the sequence to create.
start	number	Optional: The starting value for the sequence (defaults to 1 if not provided).
datasourceName	string	Optional: The name of the database connection to use.

Returns

• Type: void
• Description:

drop()

Drops (deletes) an existing database sequence.

static drop(sequence: string, datasourceName: string): void;

Parameter	Type	Description
sequence	string	The name of the sequence to drop.
datasourceName	string	Optional: The name of the database connection to use.

Returns

• Type: void
• Description: