org.h2.schema

类 Schema

java.lang.Object

org.h2.engine.DbObject

org.h2.schema.Schema

所有已实现的接口:

HasSQL

直接已知子类:

MetaSchema

public class Schema
extends DbObject

A schema as created by the SQL statement CREATE SCHEMA

字段概要

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

AGGREGATE, comment, COMMENT, CONSTANT, CONSTRAINT, database, DOMAIN, FUNCTION_ALIAS, INDEX, RIGHT, ROLE, SCHEMA, SEQUENCE, SETTING, SYNONYM, TABLE_OR_VIEW, trace, TRIGGER, USER

从接口继承的字段 org.h2.util.HasSQL

ADD_PLAN_INFORMATION, DEFAULT_SQL_FLAGS, NO_CASTS, QUOTE_ONLY_WHEN_REQUIRED, REPLACE_LOBS_FOR_TRACE, TRACE_SQL_FLAGS

构造器概要

构造器

构造器和说明
Schema(Database database, int id, String schemaName, RightOwner owner, boolean system) Create a new schema object.

方法概要

限定符和类型	方法和说明
void	add(SchemaObject obj) Add an object to this schema.
boolean	canDrop() Check if this schema can be dropped.
TableSynonym	createSynonym(CreateSynonymData data) Add a table synonym to the schema.
Table	createTable(CreateTableData data) Add a table to the schema.
TableLink	createTableLink(int id, String tableName, String driver, String url, String user, String password, String originalSchema, String originalTable, boolean emitUpdates, boolean force) Add a linked table to the schema.
UserAggregate	findAggregate(String name) Get the user defined aggregate function if it exists.
Constant	findConstant(String constantName) Try to find a user defined constant with this name.
Constraint	findConstraint(SessionLocal session, String name) Try to find a constraint with this name.
Domain	findDomain(String name) Get the domain if it exists, or null if not.
FunctionAlias	findFunction(String functionAlias) Try to find a user defined function with this name.
UserDefinedFunction	findFunctionOrAggregate(String name) Try to find a user defined function or aggregate function with the specified name.
Index	findIndex(SessionLocal session, String name) Try to find an index with this name.
Sequence	findSequence(String sequenceName) Try to find a sequence with this name.
Table	findTableOrView(SessionLocal session, String name) Try to find a table or view with this name.
TriggerObject	findTrigger(String name) Try to find a trigger with this name.
void	freeUniqueName(String name) Release a unique object name.
ArrayList<SchemaObject>	getAll(ArrayList<SchemaObject> addTo) Get all objects.
void	getAll(int type, ArrayList<SchemaObject> addTo) Get all objects of the given type.
Collection<Constant>	getAllConstants()
Collection<Constraint>	getAllConstraints()
Collection<Domain>	getAllDomains()
Collection<UserDefinedFunction>	getAllFunctionsAndAggregates()
Collection<Index>	getAllIndexes()
Collection<Sequence>	getAllSequences()
Collection<TableSynonym>	getAllSynonyms()
Collection<Table>	getAllTablesAndViews(SessionLocal session) Get all tables and views.
Collection<TriggerObject>	getAllTriggers()
ArrayList<DbObject>	getChildren() Get the list of dependent children (for tables, this includes indexes and so on).
Constant	getConstant(String constantName) Get the user defined constant with the given name.
Constraint	getConstraint(String name) Get the constraint with the given name.
String	getCreateSQL() Construct the CREATE ...
Domain	getDomain(String name) Get the domain with the given name.
Index	getIndex(String name) Get the index with the given name.
RightOwner	getOwner() Get the owner of this schema.
Sequence	getSequence(String sequenceName) Get the sequence with the given name.
TableSynonym	getSynonym(String name) Try to find a synonym with this name.
ArrayList<String>	getTableEngineParams() Get table engine params of this schema.
Table	getTableOrView(SessionLocal session, String name) Get the table or view with the given name.
Table	getTableOrViewByName(SessionLocal session, String name) Get the table with the given name, if any.
int	getType() Get the object type.
String	getUniqueConstraintName(SessionLocal session, Table table) Create a unique constraint name.
String	getUniqueDomainConstraintName(SessionLocal session, Domain domain) Create a unique constraint name.
String	getUniqueIndexName(SessionLocal session, Table table, String prefix) Create a unique index name.
boolean	isEmpty() Return whether is this schema is empty (does not contain any objects).
void	remove(SchemaObject obj) Remove an object from this schema.
void	removeChildrenAndResources(SessionLocal session) Delete all dependent children objects and resources of this object.
void	rename(SchemaObject obj, String newName) Rename an object.
void	reserveUniqueName(String name) Reserve a unique object name.
Table	resolveTableOrView(SessionLocal session, String name) Try to find a table or view with this name.
void	setTableEngineParams(ArrayList<String> tableEngineParams) Set table engine params of this schema.

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

checkRename, getComment, getCreateSQLForCopy, getCreateSQLForMeta, getDatabase, getDropSQL, getId, getModificationId, getName, getSQL, getSQL, invalidate, isTemporary, isValid, rename, setComment, setModified, setObjectName, setTemporary, toString

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

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

从接口继承的方法 org.h2.util.HasSQL

getTraceSQL

构造器详细资料

Schema

public Schema(Database database,
              int id,
              String schemaName,
              RightOwner owner,
              boolean system)

Create a new schema object.

参数:

database - the database

id - the object id

schemaName - the schema name

owner - the owner of the schema

system - if this is a system schema (such a schema can not be dropped)

方法详细资料

canDrop

public boolean canDrop()

Check if this schema can be dropped. System schemas can not be dropped.

返回:

true if it can be dropped

getCreateSQL

public String getCreateSQL()

从类复制的说明: DbObject

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

指定者:

getCreateSQL 在类中 DbObject

返回:

the SQL statement

getType

public int getType()

从类复制的说明: DbObject

Get the object type.

指定者:

getType 在类中 DbObject

返回:

the object type

isEmpty

public boolean isEmpty()

Return whether is this schema is empty (does not contain any objects).

返回:

true if this schema is empty, false otherwise

getChildren

public ArrayList<DbObject> getChildren()

从类复制的说明: DbObject

Get the list of dependent children (for tables, this includes indexes and so on).

覆盖:

getChildren 在类中 DbObject

返回:

the list of children, or null

removeChildrenAndResources

public void removeChildrenAndResources(SessionLocal session)

从类复制的说明: DbObject

Delete all dependent children objects and resources of this object.

指定者:

removeChildrenAndResources 在类中 DbObject

参数:

session - the session

getOwner

public RightOwner getOwner()

Get the owner of this schema.

返回:

the owner

getTableEngineParams

public ArrayList<String> getTableEngineParams()

Get table engine params of this schema.

返回:

default table engine params

setTableEngineParams

public void setTableEngineParams(ArrayList<String> tableEngineParams)

Set table engine params of this schema.

参数:

tableEngineParams - default table engine params

add

public void add(SchemaObject obj)

Add an object to this schema. This method must not be called within CreateSchemaObject; use Database.addSchemaObject() instead

参数:

obj - the object to add

rename

public void rename(SchemaObject obj,
                   String newName)

Rename an object.

参数:

obj - the object to rename

newName - the new name

findTableOrView

public Table findTableOrView(SessionLocal session,
                             String name)

Try to find a table or view with this name. This method returns null if no object with this name exists. Local temporary tables are also returned. Synonyms are not returned or resolved.

参数:

session - the session

name - the object name

返回:

the object or null

resolveTableOrView

public Table resolveTableOrView(SessionLocal session,
                                String name)

Try to find a table or view with this name. This method returns null if no object with this name exists. Local temporary tables are also returned. If a synonym with this name exists, the backing table of the synonym is returned

参数:

session - the session

name - the object name

返回:

the object or null

getSynonym

public TableSynonym getSynonym(String name)

Try to find a synonym with this name. This method returns null if no object with this name exists.

参数:

name - the object name

返回:

the object or null

findDomain

public Domain findDomain(String name)

Get the domain if it exists, or null if not.

参数:

name - the name of the domain

返回:

the domain or null

findIndex

public Index findIndex(SessionLocal session,
                       String name)

Try to find an index with this name. This method returns null if no object with this name exists.

参数:

session - the session

name - the object name

返回:

the object or null

findTrigger

public TriggerObject findTrigger(String name)

Try to find a trigger with this name. This method returns null if no object with this name exists.

参数:

name - the object name

返回:

the object or null

findSequence

public Sequence findSequence(String sequenceName)

Try to find a sequence with this name. This method returns null if no object with this name exists.

参数:

sequenceName - the object name

返回:

the object or null

findConstraint

public Constraint findConstraint(SessionLocal session,
                                 String name)

Try to find a constraint with this name. This method returns null if no object with this name exists.

参数:

session - the session

name - the object name

返回:

the object or null

findConstant

public Constant findConstant(String constantName)

Try to find a user defined constant with this name. This method returns null if no object with this name exists.

参数:

constantName - the object name

返回:

the object or null

findFunction

public FunctionAlias findFunction(String functionAlias)

Try to find a user defined function with this name. This method returns null if no object with this name exists.

参数:

functionAlias - the object name

返回:

the object or null

findAggregate

public UserAggregate findAggregate(String name)

Get the user defined aggregate function if it exists. This method returns null if no object with this name exists.

参数:

name - the name of the user defined aggregate function

返回:

the aggregate function or null

findFunctionOrAggregate

public UserDefinedFunction findFunctionOrAggregate(String name)

Try to find a user defined function or aggregate function with the specified name. This method returns null if no object with this name exists.

参数:

name - the object name

返回:

the object or null

reserveUniqueName

public void reserveUniqueName(String name)

Reserve a unique object name.

参数:

name - the object name

freeUniqueName

public void freeUniqueName(String name)

Release a unique object name.

参数:

name - the object name

getUniqueConstraintName

public String getUniqueConstraintName(SessionLocal session,
                                      Table table)

Create a unique constraint name.

参数:

session - the session

table - the constraint table

返回:

the unique name

getUniqueDomainConstraintName

public String getUniqueDomainConstraintName(SessionLocal session,
                                            Domain domain)

Create a unique constraint name.

参数:

session - the session

domain - the constraint domain

返回:

the unique name

getUniqueIndexName

public String getUniqueIndexName(SessionLocal session,
                                 Table table,
                                 String prefix)

Create a unique index name.

参数:

session - the session

table - the indexed table

prefix - the index name prefix

返回:

the unique name

getTableOrView

public Table getTableOrView(SessionLocal session,
                            String name)

Get the table or view with the given name. Local temporary tables are also returned.

参数:

session - the session

name - the table or view name

返回:

the table or view

抛出:

DbException - if no such object exists

getDomain

public Domain getDomain(String name)

Get the domain with the given name.

参数:

name - the domain name

返回:

the domain

抛出:

DbException - if no such object exists

getIndex

public Index getIndex(String name)

Get the index with the given name.

参数:

name - the index name

返回:

the index

抛出:

DbException - if no such object exists

getConstraint

public Constraint getConstraint(String name)

Get the constraint with the given name.

参数:

name - the constraint name

返回:

the constraint

抛出:

DbException - if no such object exists

getConstant

public Constant getConstant(String constantName)

Get the user defined constant with the given name.

参数:

constantName - the constant name

返回:

the constant

抛出:

DbException - if no such object exists

getSequence

public Sequence getSequence(String sequenceName)

Get the sequence with the given name.

参数:

sequenceName - the sequence name

返回:

the sequence

抛出:

DbException - if no such object exists

getAll

public ArrayList<SchemaObject> getAll(ArrayList<SchemaObject> addTo)

Get all objects.

参数:

addTo - list to add objects to, or null to allocate a new list

返回:

the specified list with added objects, or a new (possibly empty) list with all objects

getAll

public void getAll(int type,
                   ArrayList<SchemaObject> addTo)

Get all objects of the given type.

参数:

type - the object type

addTo - list to add objects to

getAllDomains

public Collection<Domain> getAllDomains()

getAllConstraints

public Collection<Constraint> getAllConstraints()

getAllConstants

public Collection<Constant> getAllConstants()

getAllSequences

public Collection<Sequence> getAllSequences()

getAllTriggers

public Collection<TriggerObject> getAllTriggers()

getAllTablesAndViews

public Collection<Table> getAllTablesAndViews(SessionLocal session)

Get all tables and views.

参数:

session - the session, null to exclude meta tables

返回:

a (possible empty) list of all objects

getAllIndexes

public Collection<Index> getAllIndexes()

getAllSynonyms

public Collection<TableSynonym> getAllSynonyms()

getAllFunctionsAndAggregates

public Collection<UserDefinedFunction> getAllFunctionsAndAggregates()

getTableOrViewByName

public Table getTableOrViewByName(SessionLocal session,
                                  String name)

Get the table with the given name, if any.

参数:

session - the session

name - the table name

返回:

the table or null if not found

remove

public void remove(SchemaObject obj)

Remove an object from this schema.

参数:

obj - the object to remove

createTable

public Table createTable(CreateTableData data)

Add a table to the schema.

参数:

data - the create table information

返回:

the created Table object

createSynonym

public TableSynonym createSynonym(CreateSynonymData data)

Add a table synonym to the schema.

参数:

data - the create synonym information

返回:

the created TableSynonym object

createTableLink

public TableLink createTableLink(int id,
                                 String tableName,
                                 String driver,
                                 String url,
                                 String user,
                                 String password,
                                 String originalSchema,
                                 String originalTable,
                                 boolean emitUpdates,
                                 boolean force)

Add a linked table to the schema.

参数:

id - the object id

tableName - the table name of the alias

driver - the driver class name

url - the database URL

user - the user name

password - the password

originalSchema - the schema name of the target table

originalTable - the table name of the target table

emitUpdates - if updates should be emitted instead of delete/insert

force - create the object even if the database can not be accessed

返回:

the TableLink object