Sequence

class Sequence(val name: String, val startWith: Long? = null, val incrementBy: Long? = null, val minValue: Long? = null, val maxValue: Long? = null, val cycle: Boolean? = null, val cache: Long? = null)

Represents a database sequence.

Parameters

name

Name of the sequence.

startWith

Beginning of the sequence.

incrementBy

Value to be added to the current sequence value when creating a new value.

minValue

Minimum value a sequence can generate.

maxValue

Maximum value for the sequence.

cycle

Allows the sequence to wrap around when the maxValue or minValue has been reached by an ascending or descending sequence respectively.

cache

Specifies how many sequence numbers are to be pre-allocated and stored in memory for faster access.

Constructors

Link copied to clipboard
constructor(name: String, startWith: Long? = null, incrementBy: Long? = null, minValue: Long? = null, maxValue: Long? = null, cycle: Boolean? = null, cache: Long? = null)

Properties

Link copied to clipboard
val cache: Long? = null
Link copied to clipboard
val cycle: Boolean? = null
Link copied to clipboard

The SQL statements that create this sequence.

Link copied to clipboard

This name of this sequence in proper database casing.

Link copied to clipboard
val incrementBy: Long? = null
Link copied to clipboard
val maxValue: Long? = null
Link copied to clipboard
val minValue: Long? = null
Link copied to clipboard
Link copied to clipboard
val startWith: Long? = null

Functions

Link copied to clipboard

Returns the SQL statements that create this sequence.

Link copied to clipboard

Returns the SQL statements that drop this sequence.

Link copied to clipboard

Returns whether this sequence exists in the database.

Link copied to clipboard

Advances this sequence and returns the new value.

Link copied to clipboard

Advances this sequence and returns the new value.