org.h2.schema

类 Sequence

java.lang.Object

org.h2.engine.DbObjectBase

org.h2.schema.SchemaObjectBase

org.h2.schema.Sequence

所有已实现的接口:

DbObject, SchemaObject

public class Sequence
extends SchemaObjectBase

A sequence is created using the statement CREATE SEQUENCE

字段概要

字段

限定符和类型	字段和说明
static int	DEFAULT_CACHE_SIZE The default cache size for sequences.

从类继承的字段 org.h2.engine.DbObjectBase

comment, database, trace

从接口继承的字段 org.h2.engine.DbObject

AGGREGATE, COMMENT, CONSTANT, CONSTRAINT, FUNCTION_ALIAS, INDEX, RIGHT, ROLE, SCHEMA, SEQUENCE, SETTING, TABLE_OR_VIEW, TRIGGER, USER, USER_DATATYPE

构造器概要

构造器

构造器和说明
Sequence(Schema schema, int id, String name, long startValue, long increment) Creates a new sequence for an auto-increment column.
Sequence(Schema schema, int id, String name, Long startValue, Long increment, Long cacheSize, Long minValue, Long maxValue, boolean cycle, boolean belongsToTable) Creates a new sequence.

方法概要

限定符和类型	方法和说明
void	checkRename() Check if this object can be renamed.
void	close() Flush the current value to disk and close this object.
void	flush(Session session) Flush the current value, including the margin, to disk.
void	flushWithoutMargin() Flush the current value to disk.
boolean	getBelongsToTable()
long	getCacheSize()
String	getCreateSQL() Build a SQL statement to re-create this object.
String	getCreateSQLForCopy(Table table, String quotedName) Build a SQL statement to re-create the object, or to create a copy of the object with a different name or referencing a different table
long	getCurrentValue()
boolean	getCycle()
String	getDropSQL() Build a SQL statement to drop this object.
long	getIncrement()
long	getMaxValue()
long	getMinValue()
long	getNext(Session session) Get the next value for this sequence.
int	getType() Get the object type.
void	modify(Long startValue, Long minValue, Long maxValue, Long increment) Allows the start value, increment, min value and max value to be updated atomically, including atomic validation.
void	removeChildrenAndResources(Session session) Remove all dependent objects and free all resources (files, blocks in files) of this object.
void	setBelongsToTable(boolean b)
void	setCacheSize(long cacheSize)
void	setCycle(boolean cycle)

从类继承的方法 org.h2.schema.SchemaObjectBase

getSchema, getSQL, initSchemaObjectBase, isHidden

从类继承的方法 org.h2.engine.DbObjectBase

getChildren, getComment, getDatabase, getId, getModificationId, getName, initDbObjectBase, invalidate, isTemporary, isValid, rename, setComment, setModified, setObjectName, setTemporary, toString

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

从接口继承的方法 org.h2.engine.DbObject

getChildren, getComment, getDatabase, getId, getName, isTemporary, rename, setComment, setTemporary

字段详细资料

DEFAULT_CACHE_SIZE

public static final int DEFAULT_CACHE_SIZE

The default cache size for sequences.

另请参阅:

常量字段值

构造器详细资料

Sequence

public Sequence(Schema schema,
                int id,
                String name,
                long startValue,
                long increment)

Creates a new sequence for an auto-increment column.

参数:

schema - the schema

id - the object id

name - the sequence name

startValue - the first value to return

increment - the increment count

Sequence

public Sequence(Schema schema,
                int id,
                String name,
                Long startValue,
                Long increment,
                Long cacheSize,
                Long minValue,
                Long maxValue,
                boolean cycle,
                boolean belongsToTable)

Creates a new sequence.

参数:

schema - the schema

id - the object id

name - the sequence name

startValue - the first value to return

increment - the increment count

cacheSize - the number of entries to pre-fetch

minValue - the minimum value

maxValue - the maximum value

cycle - whether to jump back to the min value if needed

belongsToTable - whether this sequence belongs to a table (for auto-increment columns)

方法详细资料

modify

public void modify(Long startValue,
                   Long minValue,
                   Long maxValue,
                   Long increment)

Allows the start value, increment, min value and max value 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).

参数:

startValue - the new start value (null if no change)

minValue - the new min value (null if no change)

maxValue - the new max value (null if no change)

increment - the new increment (null if no change)

getBelongsToTable

public boolean getBelongsToTable()

getIncrement

public long getIncrement()

getMinValue

public long getMinValue()

getMaxValue

public long getMaxValue()

getCycle

public boolean getCycle()

setCycle

public void setCycle(boolean cycle)

getDropSQL

public String getDropSQL()

从类复制的说明: DbObjectBase

Build a SQL statement to drop this object.

指定者:

getDropSQL 在接口中 DbObject

指定者:

getDropSQL 在类中 DbObjectBase

返回:

the SQL statement

getCreateSQLForCopy

public String getCreateSQLForCopy(Table table,
                                  String quotedName)

从接口复制的说明: DbObject

Build a SQL statement to re-create the object, or to create a copy of the object with a different name or referencing a different table

参数:

table - the new table

quotedName - the quoted name

返回:

the SQL statement

getCreateSQL

public String getCreateSQL()

从类复制的说明: DbObjectBase

Build a SQL statement to re-create this object.

指定者:

getCreateSQL 在接口中 DbObject

指定者:

getCreateSQL 在类中 DbObjectBase

返回:

the SQL statement

getNext

public long getNext(Session session)

Get the next value for this sequence.

参数:

session - the session

返回:

the next value

flushWithoutMargin

public void flushWithoutMargin()

Flush the current value to disk.

flush

public void flush(Session session)

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

参数:

session - the session

close

public void close()

Flush the current value to disk and close this object.

getType

public int getType()

从接口复制的说明: DbObject

Get the object type.

返回:

the object type

removeChildrenAndResources

public void removeChildrenAndResources(Session session)

从类复制的说明: DbObjectBase

Remove all dependent objects and free all resources (files, blocks in files) of this object.

指定者:

removeChildrenAndResources 在接口中 DbObject

指定者:

removeChildrenAndResources 在类中 DbObjectBase

参数:

session - the session

checkRename

public void checkRename()

从类复制的说明: DbObjectBase

Check if this object can be renamed. System objects may not be renamed.

指定者:

checkRename 在接口中 DbObject

指定者:

checkRename 在类中 DbObjectBase

getCurrentValue

public long getCurrentValue()

setBelongsToTable

public void setBelongsToTable(boolean b)

setCacheSize

public void setCacheSize(long cacheSize)

getCacheSize

public long getCacheSize()