Modifier and Type	Class and Description
public static enum	Sequence.Cycle CYCLE clause and sequence state.

Modifier and Type	Field and Description
private long	baseValue
private boolean	belongsToTable
private long	cacheSize
private Sequence.Cycle	cycle
private TypeInfo	dataType
public static final int	DEFAULT_CACHE_SIZE The default cache size for sequences.
private long	increment
private long	margin
private long	maxValue
private long	minValue
private long	startValue
private boolean	writeWithMargin

Access	Constructor and Description
public	Sequence(SessionLocal the session session, Schema the schema schema, int the object id id, String the sequence name name, SequenceOptions the sequence options options, boolean whether this sequence belongs to a table (for generated columns) belongsToTable) Creates a new sequence.

Method Summary

Modifier and Type	Method and Description
private long	Returns: the prospective or adjusted cache size checkOptions(long the prospective base value baseValue, long the prospective start value startValue, long the prospective min value minValue, long the prospective max value maxValue, long the prospective increment increment, long the prospective cache size cacheSize, boolean whether cache size may be adjusted, cache size 0 is adjusted unconditionally to 1 mayAdjustCacheSize) Validates the specified prospective base value, start value, min value, max value, increment, and cache size relative to each other, since each of their respective validities are contingent on the values of the other parameters.
public void	close() Flush the current value to disk and close this object.
private boolean	decrement(long oldBase, long newBase)
public void	flush(SessionLocal the session session) Flush the current value, including the margin, to disk.
private void	flushInternal(SessionLocal session)
public void	flushWithoutMargin() Flush the current value to disk.
public synchronized long	getBaseValue()
public boolean	getBelongsToTable()
public long	getCacheSize()
public String	getCreateSQL() Implements abstract org.h2.engine.DbObject.getCreateSQL. Construct the CREATE ...
public synchronized long	getCurrentValue()
public Sequence.Cycle	getCycle()
public TypeInfo	getDataType()
public static long	Returns: min value. getDefaultMaxValue(Long the start value of the sequence. startValue, long the increment of the sequence value. increment, long[] min and max bounds of data type of the sequence bounds) Calculates default max value.
public static long	Returns: min value. getDefaultMinValue(Long the start value of the sequence. startValue, long the increment of the sequence value. increment, long[] min and max bounds of data type of the sequence bounds) Calculates default min value.
public String	getDropSQL() Overrides org.h2.engine.DbObject.getDropSQL. Construct a DROP ...
public int	getEffectivePrecision()
public long	getIncrement()
private static long	getMaxCacheSize(long range, long increment)
public long	getMaxValue()
public long	getMinValue()
public Value	Returns: the next value getNext(SessionLocal the session session) Get the next value for this sequence.
public synchronized StringBuilder	Returns: the builder getSequenceOptionsSQL(StringBuilder the builder builder) Append the options part of the SQL statement to create the sequence.
private StringBuilder	getSequenceOptionsSQL(StringBuilder builder, long value)
public long	getStartValue()
public int	getType() Implements abstract org.h2.engine.DbObject.getType. Get the object type.
private boolean	increment(long oldBase, long newBase)
public synchronized void	modify(Long the base value (`null` if restart is not requested) baseValue, Long the new start value (`null` if no change) startValue, Long the new min value (`null` if no change) minValue, Long the new max value (`null` if no change) maxValue, Long the new increment (`null` if no change) increment, Sequence.Cycle the new cycle value, or `null` if no change cycle, Long the new cache size (`null` if no change) cacheSize) Allows the base value, start value, min value, max value, increment and cache size to be updated atomically, including atomic validation.
public void	removeChildrenAndResources(SessionLocal the session session) Implements abstract org.h2.engine.DbObject.removeChildrenAndResources. Delete all dependent children objects and resources of this object.
public void	setBelongsToTable(boolean b)

Inherited from org.h2.schema.SchemaObject:: getSchema getSQL getSQL

Field Detail

baseValue	back to summary
private long baseValue

belongsToTable	back to summary
private boolean belongsToTable

cacheSize	back to summary
private long cacheSize

cycle	back to summary
private Sequence.Cycle cycle

dataType	back to summary
private TypeInfo dataType

DEFAULT_CACHE_SIZE	back to summary
public static final int DEFAULT_CACHE_SIZE The default cache size for sequences.

increment	back to summary
private long increment

margin	back to summary
private long margin

maxValue	back to summary
private long maxValue

minValue	back to summary
private long minValue

startValue	back to summary
private long startValue

writeWithMargin	back to summary
private boolean writeWithMargin

Constructor Detail

Sequence	back to summary
public Sequence(SessionLocal session, Schema schema, int id, String name, SequenceOptions options, boolean belongsToTable) Creates a new sequence. Parameters session:SessionLocal the session schema:Schema the schema id:int the object id name:String the sequence name options:SequenceOptions the sequence options belongsToTable:boolean whether this sequence belongs to a table (for generated columns)

Sequence

back to summary

public Sequence(SessionLocal session, Schema schema, int id, String name, SequenceOptions options, boolean belongsToTable)

Creates a new sequence.

Parameters

session:SessionLocal: the session
schema:Schema: the schema
id:int: the object id
name:String: the sequence name
options:SequenceOptions: the sequence options
belongsToTable:boolean: whether this sequence belongs to a table (for generated columns)

Method Detail

checkOptions	back to summary
private long checkOptions(long baseValue, long startValue, long minValue, long maxValue, long increment, long cacheSize, boolean mayAdjustCacheSize) Validates the specified prospective base value, start value, min value, max value, increment, and cache size relative to each other, since each of their respective validities are contingent on the values of the other parameters. Parameters baseValue:long the prospective base value startValue:long the prospective start value minValue:long the prospective min value maxValue:long the prospective max value increment:long the prospective increment cacheSize:long the prospective cache size mayAdjustCacheSize:boolean whether cache size may be adjusted, cache size 0 is adjusted unconditionally to 1 Returns:long the prospective or adjusted cache size

checkOptions

back to summary

private long checkOptions(long baseValue, long startValue, long minValue, long maxValue, long increment, long cacheSize, boolean mayAdjustCacheSize)

Validates the specified prospective base value, start value, min value, max value, increment, and cache size relative to each other, since each of their respective validities are contingent on the values of the other parameters.

Parameters

baseValue:long: the prospective base value
startValue:long: the prospective start value
minValue:long: the prospective min value
maxValue:long: the prospective max value
increment:long: the prospective increment
cacheSize:long: the prospective cache size
mayAdjustCacheSize:boolean: whether cache size may be adjusted, cache size 0 is adjusted unconditionally to 1

Returns:long

the prospective or adjusted cache size

close	back to summary
public void close() Flush the current value to disk and close this object.

decrement	back to summary
private boolean decrement(long oldBase, long newBase)

flush	back to summary
public void flush(SessionLocal session) Flush the current value, including the margin, to disk. Parameters session:SessionLocal the session

flush

back to summary

public void flush(SessionLocal session)

Flush the current value, including the margin, to disk.

Parameters

session:SessionLocal: the session

flushInternal	back to summary
private void flushInternal(SessionLocal session)

flushWithoutMargin	back to summary
public void flushWithoutMargin() Flush the current value to disk.

getBaseValue	back to summary
public synchronized long getBaseValue()

getBelongsToTable	back to summary
public boolean getBelongsToTable()

getCacheSize	back to summary
public long getCacheSize()

getCreateSQL	back to summary
public String getCreateSQL() Implements abstract org.h2.engine.DbObject.getCreateSQL. Doc from org.h2.engine.DbObject.getCreateSQL. Construct the CREATE ... SQL statement for this object. Returns:String the SQL statement Annotations @Override

getCreateSQL

back to summary

public String getCreateSQL()

Implements abstract org.h2.engine.DbObject.getCreateSQL.

Doc from org.h2.engine.DbObject.getCreateSQL.

Construct the CREATE ... SQL statement for this object.

Returns:String

the SQL statement

Annotations

@Override

getCurrentValue	back to summary
public synchronized long getCurrentValue()

getCycle	back to summary
public Sequence.Cycle getCycle()

getDataType	back to summary
public TypeInfo getDataType()

getDefaultMaxValue	back to summary
public static long getDefaultMaxValue(Long startValue, long increment, long[] bounds) Calculates default max value. Parameters startValue:Long the start value of the sequence. increment:long the increment of the sequence value. bounds:long[] min and max bounds of data type of the sequence Returns:long min value.

getDefaultMaxValue

back to summary

public static long getDefaultMaxValue(Long startValue, long increment, long[] bounds)

Calculates default max value.

Parameters

startValue:Long: the start value of the sequence.
increment:long: the increment of the sequence value.
bounds:long[]: min and max bounds of data type of the sequence

Returns:long

min value.

getDefaultMinValue	back to summary
public static long getDefaultMinValue(Long startValue, long increment, long[] bounds) Calculates default min value. Parameters startValue:Long the start value of the sequence. increment:long the increment of the sequence value. bounds:long[] min and max bounds of data type of the sequence Returns:long min value.

getDefaultMinValue

back to summary

public static long getDefaultMinValue(Long startValue, long increment, long[] bounds)

Calculates default min value.

Parameters

startValue:Long: the start value of the sequence.
increment:long: the increment of the sequence value.
bounds:long[]: min and max bounds of data type of the sequence

Returns:long

min value.

getDropSQL	back to summary
public String getDropSQL() Overrides org.h2.engine.DbObject.getDropSQL. Doc from org.h2.engine.DbObject.getDropSQL. Construct a DROP ... SQL statement for this object. Returns:String the SQL statement Annotations @Override

getDropSQL

back to summary

public String getDropSQL()

Overrides org.h2.engine.DbObject.getDropSQL.

Doc from org.h2.engine.DbObject.getDropSQL.

Construct a DROP ... SQL statement for this object.

Returns:String

the SQL statement

Annotations

@Override

getEffectivePrecision	back to summary
public int getEffectivePrecision()

getIncrement	back to summary
public long getIncrement()

getMaxCacheSize	back to summary
private static long getMaxCacheSize(long range, long increment)

getMaxValue	back to summary
public long getMaxValue()

getMinValue	back to summary
public long getMinValue()

getNext back to summary

getNext	back to summary
public Value getNext(SessionLocal session) Get the next value for this sequence. Should not be called directly, use `SessionLocal#getNextValueFor(Sequence, org.h2.command.Prepared)` instead. Parameters session:SessionLocal the session Returns:Value the next value

public Value getNext(SessionLocal session)

Get the next value for this sequence. Should not be called directly, use SessionLocal#getNextValueFor(Sequence, org.h2.command.Prepared) instead.

Parameters

session:SessionLocal: the session

Returns:Value

the next value

getSequenceOptionsSQL	back to summary
public synchronized StringBuilder getSequenceOptionsSQL(StringBuilder builder) Append the options part of the SQL statement to create the sequence. Parameters builder:StringBuilder the builder Returns:StringBuilder the builder

getSequenceOptionsSQL

back to summary

public synchronized StringBuilder getSequenceOptionsSQL(StringBuilder builder)

Append the options part of the SQL statement to create the sequence.

Parameters

builder:StringBuilder: the builder

Returns:StringBuilder

the builder

getSequenceOptionsSQL	back to summary
private StringBuilder getSequenceOptionsSQL(StringBuilder builder, long value)

getStartValue	back to summary
public long getStartValue()

getType	back to summary
public int getType() Implements abstract org.h2.engine.DbObject.getType. Doc from org.h2.engine.DbObject.getType. Get the object type. Returns:int the object type Annotations @Override

getType

back to summary

public int getType()

Implements abstract org.h2.engine.DbObject.getType.

Doc from org.h2.engine.DbObject.getType.

Get the object type.

Returns:int

the object type

Annotations

@Override

increment	back to summary
private boolean increment(long oldBase, long newBase)

modify back to summary

modify	back to summary
public synchronized void modify(Long baseValue, Long startValue, Long minValue, Long maxValue, Long increment, Sequence.Cycle cycle, Long cacheSize) Allows the base value, start value, min value, max value, increment and cache size to be updated atomically, including atomic validation. Useful because setting these attributes one after the other could otherwise result in an invalid sequence state (e.g. min value > max value, start value < min value, etc). Parameters baseValue:Long the base value (`null` if restart is not requested) startValue:Long the new start value (`null` if no change) minValue:Long the new min value (`null` if no change) maxValue:Long the new max value (`null` if no change) increment:Long the new increment (`null` if no change) cycle:Sequence.Cycle the new cycle value, or `null` if no change cacheSize:Long the new cache size (`null` if no change)

public synchronized void modify(Long baseValue, Long startValue, Long minValue, Long maxValue, Long increment, Sequence.Cycle cycle, Long cacheSize)

Allows the base value, start value, min value, max value, increment and cache size to be updated atomically, including atomic validation. Useful because setting these attributes one after the other could otherwise result in an invalid sequence state (e.g. min value > max value, start value < min value, etc).

Parameters

baseValue:Long: the base value (null if restart is not requested)
startValue:Long: the new start value (null if no change)
minValue:Long: the new min value (null if no change)
maxValue:Long: the new max value (null if no change)
increment:Long: the new increment (null if no change)
cycle:Sequence.Cycle: the new cycle value, or null if no change
cacheSize:Long: the new cache size (null if no change)

removeChildrenAndResources	back to summary
public void removeChildrenAndResources(SessionLocal session) Implements abstract org.h2.engine.DbObject.removeChildrenAndResources. Doc from org.h2.engine.DbObject.removeChildrenAndResources. Delete all dependent children objects and resources of this object. Parameters session:SessionLocal the session Annotations @Override

removeChildrenAndResources

back to summary

public void removeChildrenAndResources(SessionLocal session)

Implements abstract org.h2.engine.DbObject.removeChildrenAndResources.

Doc from org.h2.engine.DbObject.removeChildrenAndResources.

Delete all dependent children objects and resources of this object.

Parameters

session:SessionLocal: the session

Annotations

@Override

setBelongsToTable	back to summary
public void setBelongsToTable(boolean b)

org.h2.schema back to summary

public final Enum Sequence.Cycle

Class Inheritance

extends Enum<Sequence.Cycle>

java.lang.Object
java.lang.Enum
org.h2.schema.Sequence.Cycle

CYCLE clause and sequence state.

Field Summary

Modifier and Type	Field and Description
public static final Sequence.Cycle	CYCLE Sequence is cycled.
public static final Sequence.Cycle	EXHAUSTED Sequence is not cycled and was already exhausted.
public static final Sequence.Cycle	NO_CYCLE Sequence is not cycled and isn't exhausted yet.

Constructor Summary

Access	Constructor and Description
private	Cycle()

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if sequence is cycled, `false` if sequence is not cycled isCycle() Return whether sequence is cycled.
public static Sequence.Cycle	valueOf(String name)
public static Sequence.Cycle[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

CYCLE	back to summary
public static final Sequence.Cycle CYCLE Sequence is cycled.

EXHAUSTED	back to summary
public static final Sequence.Cycle EXHAUSTED Sequence is not cycled and was already exhausted.

NO_CYCLE	back to summary
public static final Sequence.Cycle NO_CYCLE Sequence is not cycled and isn't exhausted yet.

Constructor Detail

Cycle	back to summary
private Cycle()

Method Detail

isCycle back to summary

public boolean isCycle()

Return whether sequence is cycled.

Returns:boolean: true if sequence is cycled, false if sequence is not cycled

valueOf	back to summary
public static Sequence.Cycle valueOf(String name)

values	back to summary
public static Sequence.Cycle[] values()

public final Class Sequence

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum Sequence.Cycle

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail