Java Doc for DatabaseInformationFull.java in  » Database-DBMS » hsql » org » hsqldb » Java Source Code / Java DocumentationJava Source Code and Java Documentation

author:
   boucherb@users
version:
   1.8.0
since:
   1.7.2

Function

The AUTHORIZATIONS table has one row for each <role name> and one row for each <authorization identifier > referenced in the Information Schema.

Each row is a Class privilege description with the following columns:

 CLASS_CAT    VARCHAR   catalog in which the class is defined
 CLASS_SCHEM  VARCHAR   schema in which the class is defined
 CLASS_NAME   VARCHAR   fully qualified name of class
 GRANTOR      VARCHAR   grantor of access
 GRANTEE      VARCHAR   grantee of access
 PRIVILEGE    VARCHAR   name of access: {"EXECUTE" | "TRIGGER"}
 IS_GRANTABLE VARCHAR   grantable?: {"YES" | "NO" | NULL (unknown)}
 

Function

The COLLATIONS table has one row for each character collation descriptor.

Function

Contains a representation of the role authorization descriptors.

Definition

 CREATE TABLE ROLE_AUTHORIZATION_DESCRIPTORS (
 ROLE_NAME INFORMATION_SCHEMA.SQL_IDENTIFIER,
 GRANTEE INFORMATION_SCHEMA.SQL_IDENTIFIER,
 GRANTOR INFORMATION_SCHEMA.SQL_IDENTIFIER,
 IS_GRANTABLE INFORMATION_SCHEMA.CHARACTER_DATA
 CONSTRAINT ROLE_AUTHORIZATION_DESCRIPTORS_IS_GRANTABLE_CHECK
 CHECK ( IS_GRANTABLE IN
 ( 'YES', 'NO' ) ),
 CONSTRAINT ROLE_AUTHORIZATION_DESCRIPTORS_PRIMARY_KEY
 PRIMARY KEY ( ROLE_NAME, GRANTEE ),
 CONSTRAINT ROLE_AUTHORIZATION_DESCRIPTORS_CHECK_ROLE_NAME
 CHECK ( ROLE_NAME IN
 ( SELECT AUTHORIZATION_NAME
 FROM AUTHORIZATIONS
 WHERE AUTHORIZATION_TYPE = 'ROLE' ) ),
 CONSTRAINT ROLE_AUTHORIZATION_DESCRIPTORS_FOREIGN_KEY_AUTHORIZATIONS_GRANTOR
 FOREIGN KEY ( GRANTOR )
 REFERENCES AUTHORIZATIONS,
 CONSTRAINT ROLE_AUTHORIZATION_DESCRIPTORS_FOREIGN_KEY_AUTHORIZATIONS_GRANTEE
 FOREIGN KEY ( GRANTEE )
 REFERENCES AUTHORIZATIONS
 )
 

1. The value of ROLE_NAME is the <role name> of some <role granted> by the <grant role statement> or the <role name> of a <role definition>.

Function

The SCHEMATA table has one row for each schema.

The rows report the following {key,value} pairs:

 KEY (VARCHAR)       VALUE (VARCHAR)
 ------------------- ---------------
 SESSION_ID          the id of the calling session
 AUTOCOMMIT          YES: session is in autocommit mode, else NO
 USER                the name of user connected in the calling session
 (was READ_ONLY)
 SESSION_READONLY    TRUE: session is in read-only mode, else FALSE
 (new)
 DATABASE_READONLY   TRUE: database is in read-only mode, else FALSE
 MAXROWS             the MAXROWS setting in the calling session
 DATABASE            the name of the database
 IDENTITY            the last identity value used by calling session
 

Parameters:
  db - the database for which to produce system tables.
throws:
  HsqlException - if a database access error occurs.

Currently two types of alias are reported: DOMAIN alaises (alternate names for column data types when issuing "CREATE TABLE" DDL) and ROUTINE aliases (alternate names that can be used when invoking routines as SQL functions or stored procedures).

Each row is an alias description with the following columns:

 OBJECT_TYPE  VARCHAR   type of the aliased object
 OBJECT_CAT   VARCHAR   catalog of the aliased object
 OBJECT_SCHEM VARCHAR   schema of the aliased object
 OBJECT_NAME  VARCHAR   simple identifier of the aliased object
 ALIAS_CAT    VARCHAR   catalog in which alias is defined
 ALIAS_SCHEM  VARCHAR   schema in which alias is defined
 ALIAS        VARCHAR   alias for the indicated object
 

Note: Up to and including HSQLDB 1.7.2, user-defined aliases are supported only for SQL function and stored procedure calls (indicated by the value "ROUTINE" in the OBJECT_TYPE column), and there is no syntax for dropping aliases, only for creating them.

a Table object describing the accessisblealiases in the context of the calling session
throws:
  HsqlException - if an error occurs while producing the table

Function

The AUTHORIZATIONS table has one row for each <role name> and one row for each <authorization identifier > referenced in the Information Schema. These are the <role name>s and <authorization identifier>s that may grant privileges as well as those that may create a schema, or currently own a schema created through a <schema definition>.

Definition

 CREATE TABLE AUTHORIZATIONS (
 AUTHORIZATION_NAME INFORMATION_SCHEMA.SQL_IDENTIFIER,
 AUTHORIZATION_TYPE INFORMATION_SCHEMA.CHARACTER_DATA
 CONSTRAINT AUTHORIZATIONS_AUTHORIZATION_TYPE_NOT_NULL
 NOT NULL
 CONSTRAINT AUTHORIZATIONS_AUTHORIZATION_TYPE_CHECK
 CHECK ( AUTHORIZATION_TYPE IN ( 'USER', 'ROLE' ) ),
 CONSTRAINT AUTHORIZATIONS_PRIMARY_KEY
 PRIMARY KEY (AUTHORIZATION_NAME)
 )
 

1. The values of AUTHORIZATION_TYPE have the following meanings:

   USER	The value of AUTHORIZATION_NAME is a known <user identifier>.
   NO	The value of AUTHORIZATION_NAME is a <role name> defined by a <role definition>.

Currently, the row caching objects for which state is reported are:

1. the system-wide Cache object used by CACHED tables.
2. any TextCache objects in use by [TEMP] TEXT tables.

Each row is a cache object state description with the following columns:

 CACHE_FILE          VARCHAR   absolute path of cache data file
 MAX_CACHE_SIZE      INTEGER   maximum allowable cached Row objects
 MAX_CACHE_BYTE_SIZE INTEGER   maximum allowable size of cached Row objects
 CACHE_LENGTH        INTEGER   number of data bytes currently cached
 CACHE_SIZE          INTEGER   number of rows currently cached
 FREE_BYTES          INTEGER   total bytes in available file allocation units
 FREE_COUNT          INTEGER   total # of allocation units available
 FREE_POS            INTEGER   largest file position allocated + 1
 

Notes:

TextCache objects do not maintain a free list because deleted rows are only marked deleted and never reused. As such, the columns FREE_BYTES, SMALLEST_FREE_ITEM, LARGEST_FREE_ITEM, and FREE_COUNT are always reported as zero for rows reporting on TextCache objects.

Currently, CACHE_SIZE, FREE_BYTES, SMALLEST_FREE_ITEM, LARGEST_FREE_ITEM, FREE_COUNT and FREE_POS are the only dynamically changing values. All others are constant for the life of a cache object. In a future release, other column values may also change over the life of a cache object, as SQL syntax may eventually be introduced to allow runtime modification of certain cache properties.

a description of the current state of all row cachingobjects associated with the accessible tables of the database
throws:
  HsqlException - if an error occurs while producing the table

Definition:

 CREATE TABLE CHECK_COLUMN_USAGE (
 CONSTRAINT_CATALOG  VARCHAR NULL,
 CONSTRAINT_SCHEMA   VARCHAR NULL,
 CONSTRAINT_NAME     VARCHAR NOT NULL,
 TABLE_CATALOG       VARCHAR NULL,
 TABLE_SCHEMA        VARCHAR NULL,
 TABLE_NAME          VARCHAR NOT NULL,
 COLUMN_NAME         VARCHAR NOT NULL,
 UNIQUE( CONSTRAINT_CATALOG, CONSTRAINT_SCHEMA, CONSTRAINT_NAME,
 TABLE_CATALOG, TABLE_SCHEMA, TABLE_NAME, COLUMN_NAME )
 )
 

1. The values of CONSTRAINT_CATALOG, CONSTRAINT_SCHEMA, and CONSTRAINT_NAME are the catalog name, unqualified schema name, and qualified identifier, respectively, of the constraint being described.

2. The values of TABLE_CATALOG, TABLE_SCHEMA, TABLE_NAME, and COLUMN_NAME are the catalog name, unqualified schema name, qualified identifier, and column name, respectively, of a column identified by a <column reference> explicitly or implicitly contained in the <search condition> of the constraint being described.

Definition:

 CREATE TABLE SYSTEM_CHECK_ROUTINE_USAGE (
 CONSTRAINT_CATALOG      VARCHAR NULL,
 CONSTRAINT_SCHEMA       VARCHAR NULL,
 CONSTRAINT_NAME         VARCHAR NOT NULL,
 SPECIFIC_CATALOG        VARCHAR NULL,
 SPECIFIC_SCHEMA         VARCHAR NULL,
 SPECIFIC_NAME           VARCHAR NOT NULL,
 UNIQUE( CONSTRAINT_CATALOG, CONSTRAINT_SCHEMA, CONSTRAINT_NAME,
 SPECIFIC_CATALOG, SPECIFIC_SCHEMA, SPECIFIC_NAME )
 )
 

1. The CHECK_ROUTINE_USAGE table has one row for each SQL-invoked routine R identified as the subject routine of either a <routine invocation>, a <method reference>, a <method invocation>, or a <static method invocation> contained in an <assertion definition> or in the <check constraint definition> contained in either a <domain constraint> or a <table constraint definition>.

2. The values of CONSTRAINT_CATALOG, CONSTRAINT_SCHEMA, and CONSTRAINT_NAME are the catalog name, unqualified schema name, and qualified identifier, respectively, of the assertion or check constraint being described.

3. The values of SPECIFIC_CATALOG, SPECIFIC_SCHEMA, and SPECIFIC_NAME are the catalog name, unqualified schema name, and qualified identifier, respectively, of the specific name of R.

Definition:

 CREATE STABLE SYSTEM_CHECK_TABLE_USAGE (
 CONSTRAINT_CATALOG      VARCHAR NULL,
 CONSTRAINT_SCHEMA       VARCHAR NULL,
 CONSTRAINT_NAME         VARCHAR NOT NULL,
 TABLE_CATALOG           VARCHAR NULL,
 TABLE_SCHEMA            VARCHAR NOT NULL,
 TABLE_NAME INFORMATION_SCHEMA.SQL_IDENTIFIER,
 UNIQUE( CONSTRAINT_CATALOG, CONSTRAINT_SCHEMA, CONSTRAINT_NAME,
 TABLE_CATALOG, TABLE_SCHEMA, TABLE_NAME )
 )
 

1. The values of CONSTRAINT_CATALOG, CONSTRAINT_SCHEMA, and CONSTRAINT_NAME are the catalog name, unqualified schema name, and qualified identifier, respectively, of the constraint being described.

2. The values of TABLE_CATALOG, TABLE_SCHEMA, and TABLE_NAME are the catalog name, unqualified schema name, and qualified identifier, respectively, of a table identified by a <table name> simply contained in a <table reference> contained in the lt;search condition> of the constraint being described.

Each row is a Class privilege description with the following columns:

 CLASS_CAT    VARCHAR   catalog in which the class is defined
 CLASS_SCHEM  VARCHAR   schema in which the class is defined
 CLASS_NAME   VARCHAR   fully qualified name of class
 GRANTOR      VARCHAR   grantor of access
 GRANTEE      VARCHAR   grantee of access
 PRIVILEGE    VARCHAR   name of access: {"EXECUTE" | "TRIGGER"}
 IS_GRANTABLE VARCHAR   grantable?: {"YES" | "NO" | NULL (unknown)}
 

a Table object describing the visibleaccess rights for all accessible Java Classobjects defined within this database
throws:
  HsqlException - if an error occurs while producing the table

Function

The COLLATIONS table has one row for each character collation descriptor.

Definition

 CREATE TABLE COLLATIONS (
 COLLATION_CATALOG INFORMATION_SCHEMA.SQL_IDENTIFIER,
 COLLATION_SCHEMA INFORMATION_SCHEMA.SQL_IDENTIFIER,
 COLLATION_NAME INFORMATION_SCHEMA.SQL_IDENTIFIER,
 PAD_ATTRIBUTE INFORMATION_SCHEMA.CHARACTER_DATA
 CONSTRAINT COLLATIONS_PAD_ATTRIBUTE_CHECK
 CHECK ( PAD_ATTRIBUTE IN
 ( 'NO PAD', 'PAD SPACE' ) ),
 COLLATION_TYPE INFORMATION_SCHEMA.SQL_IDENTIFIER,
 COLLATION_DEFINITION INFORMATION_SCHEMA.CHARACTER_DATA,
 COLLATION_DICTIONARY INFORMATION_SCHEMA.CHARACTER_DATA,
 CHARACTER_REPERTOIRE_NAME INFORMATION_SCHEMA.SQL_IDENTIFIER
 CONSTRAINT CHARACTER_REPERTOIRE_NAME_NOT_NULL
 NOT NULL,
 CONSTRAINT COLLATIONS_PRIMARY_KEY
 PRIMARY KEY ( COLLATION_CATALOG, COLLATION_SCHEMA, COLLATION_NAME ),
 CONSTRAINT COLLATIONS_FOREIGN_KEY_SCHEMATA
 FOREIGN KEY ( COLLATION_CATALOG, COLLATION_SCHEMA )
 REFERENCES SCHEMATA
 )
 

Each row is a procedure column description with the following columns:

 PROCEDURE_CAT   VARCHAR   routine catalog
 PROCEDURE_SCHEM VARCHAR   routine schema
 PROCEDURE_NAME  VARCHAR   routine name
 COLUMN_NAME     VARCHAR   column/parameter name
 COLUMN_TYPE     SMALLINT  kind of column/parameter
 DATA_TYPE       SMALLINT  SQL type from DITypes
 TYPE_NAME       VARCHAR   SQL type name
 PRECISION       INTEGER   precision (length) of type
 LENGTH          INTEGER   transfer size, in bytes, if definitely known
 (roughly equivalent to BUFFER_SIZE for table
 columns)
 SCALE           SMALLINT  scale
 RADIX           SMALLINT  radix
 NULLABLE        SMALLINT  can column contain NULL?
 REMARKS         VARCHAR   explanatory comment on column
 SPECIFIC_NAME   VARCHAR   typically (but not restricted to) a
 fully qulified Java Method name and signature
 SEQ             INTEGER   The JDBC-specified order within
 runs of PROCEDURE_SCHEM, PROCEDURE_NAME,
 SPECIFIC_NAME, which is:
 return value (0), if any, first, followed
 by the parameter descriptions in call order
 (1..n1), followed by the result column
 descriptions in column number order
 (n1 + 1..n1 + n2)
 

a Table object describing thereturn, parameter and result columnsof the accessible routines definedwithin this database.
throws:
  HsqlException - if an error occurs while producing the table

 PROCEDURE_CAT     VARCHAR   catalog in which routine is defined
 PROCEDURE_SCHEM   VARCHAR   schema in which routine is defined
 PROCEDURE_NAME    VARCHAR   simple routine identifier
 NUM_INPUT_PARAMS  INTEGER   number of input parameters
 NUM_OUTPUT_PARAMS INTEGER   number of output parameters
 NUM_RESULT_SETS   INTEGER   number of result sets returned
 REMARKS           VARCHAR   explanatory comment on the routine
 PROCEDURE_TYPE    SMALLINT  { Unknown | No Result | Returns Result }
 ORIGIN            VARCHAR   {ALIAS |
 [BUILTIN | USER DEFINED] ROUTINE |
 [BUILTIN | USER DEFINED] TRIGGER |
 ...}
 SPECIFIC_NAME     VARCHAR   typically (but not restricted to) a
 a fully qualified Java Method name
 and signature
 

a Table object describing the accessibleroutines defined within the this database
throws:
  HsqlException - if an error occurs while producing the table

Reported properties include certain predefined Database properties file values as well as certain database scope attributes.

It is intended that all Database attributes and properties that can be set via the database properties file, JDBC connection properties or SQL SET/ALTER statements will eventually be reported here or, where more applicable, in an ANSI/ISO conforming feature info base table in the defintion schema.

Currently, the database properties reported are:

1. hsqldb.cache_file_scale - the scaling factor used to translate data and index structure file pointers
2. hsqldb.cache_scale - base-2 exponent scaling allowable cache row count
3. hsqldb.cache_size_scale - base-2 exponent scaling allowable cache byte count
4. hsqldb.cache_version -
5. hsqldb.catalogs - whether to report the database catalog (database uri)
6. hsqldb.compatible_version -
7. hsqldb.files_readonly - whether the database is in files_readonly mode
8. hsqldb.gc_interval - # new records forcing gc ({0|NULL}=>never)
9. hsqldb.max_nio_scale - scale factor for cache nio mapped buffers
10. hsqldb.nio_data_file - whether cache uses nio mapped buffers
11. hsqldb.original_version -
12. sql.enforce_strict_size - column length specifications enforced strictly (raise exception on overflow)?
13. textdb.all_quoted - default policy regarding whether to quote all character field values
14. textdb.cache_scale - base-2 exponent scaling allowable cache row count
15. textdb.cache_size_scale - base-2 exponent scaling allowable cache byte count
16. textdb.encoding - default TEXT table file encoding
17. textdb.fs - default field separator
18. textdb.vs - default varchar field separator
19. textdb.lvs - default long varchar field separator
20. textdb.ignore_first - default policy regarding whether to ignore the first line
21. textdb.quoted - default policy regarding treatement character field values that _may_ require quoting
22. IGNORECASE - create table VARCHAR_IGNORECASE?
23. LOGSIZSE - # bytes to which REDO log grows before auto-checkpoint
24. REFERENTIAL_INTEGITY - currently enforcing referential integrity?
25. SCRIPTFORMAT - 0 : TEXT, 1 : BINARY, ...
26. WRITEDELAY - does REDO log currently use buffered write strategy?

table describing database and session operating parametersand capabilities
throws:
  HsqlException - if an error occurs while producing the table

Function

Contains a representation of the role authorization descriptors.

Definition

 CREATE TABLE ROLE_AUTHORIZATION_DESCRIPTORS (
 ROLE_NAME INFORMATION_SCHEMA.SQL_IDENTIFIER,
 GRANTEE INFORMATION_SCHEMA.SQL_IDENTIFIER,
 GRANTOR INFORMATION_SCHEMA.SQL_IDENTIFIER,
 IS_GRANTABLE INFORMATION_SCHEMA.CHARACTER_DATA
 CONSTRAINT ROLE_AUTHORIZATION_DESCRIPTORS_IS_GRANTABLE_CHECK
 CHECK ( IS_GRANTABLE IN
 ( 'YES', 'NO' ) ),
 CONSTRAINT ROLE_AUTHORIZATION_DESCRIPTORS_PRIMARY_KEY
 PRIMARY KEY ( ROLE_NAME, GRANTEE ),
 CONSTRAINT ROLE_AUTHORIZATION_DESCRIPTORS_CHECK_ROLE_NAME
 CHECK ( ROLE_NAME IN
 ( SELECT AUTHORIZATION_NAME
 FROM AUTHORIZATIONS
 WHERE AUTHORIZATION_TYPE = 'ROLE' ) ),
 CONSTRAINT ROLE_AUTHORIZATION_DESCRIPTORS_FOREIGN_KEY_AUTHORIZATIONS_GRANTOR
 FOREIGN KEY ( GRANTOR )
 REFERENCES AUTHORIZATIONS,
 CONSTRAINT ROLE_AUTHORIZATION_DESCRIPTORS_FOREIGN_KEY_AUTHORIZATIONS_GRANTEE
 FOREIGN KEY ( GRANTEE )
 REFERENCES AUTHORIZATIONS
 )
 

1. The value of ROLE_NAME is the <role name> of some <role granted> by the <grant role statement> or the <role name> of a <role definition>.

2. The value of GRANTEE is an <authorization identifier>, possibly PUBLIC, or <role name> specified as a <grantee> contained in a <grant role statement>, or the <authorization identifier> of the current SQLsession when the <role definition> is executed.

3. The value of GRANTOR is the <authorization identifier> of the user or role who granted the role identified by ROLE_NAME to the user or role identified by the value of GRANTEE.

4. The values of IS_GRANTABLE have the following meanings:

   YES	The described role is grantable.
   NO	The described role is not grantable.

Function

The SCHEMATA table has one row for each schema.

Definition

 CREATE TABLE SCHEMATA (
 CATALOG_NAME INFORMATION_SCHEMA.SQL_IDENTIFIER,
 SCHEMA_NAME INFORMATION_SCHEMA.SQL_IDENTIFIER,
 SCHEMA_OWNER INFORMATION_SCHEMA.SQL_IDENTIFIER
 CONSTRAINT SCHEMA_OWNER_NOT_NULL
 NOT NULL,
 DEFAULT_CHARACTER_SET_CATALOG INFORMATION_SCHEMA.SQL_IDENTIFIER
 CONSTRAINT DEFAULT_CHARACTER_SET_CATALOG_NOT_NULL
 NOT NULL,
 DEFAULT_CHARACTER_SET_SCHEMA INFORMATION_SCHEMA.SQL_IDENTIFIER
 CONSTRAINT DEFAULT_CHARACTER_SET_SCHEMA_NOT_NULL
 NOT NULL,
 DEFAULT_CHARACTER_SET_NAME INFORMATION_SCHEMA.SQL_IDENTIFIER
 CONSTRAINT DEFAULT_CHARACTER_SET_NAME_NOT_NULL
 NOT NULL,
 SQL_PATH INFORMATION_SCHEMA.CHARACTER_DATA,
 CONSTRAINT SCHEMATA_PRIMARY_KEY
 PRIMARY KEY ( CATALOG_NAME, SCHEMA_NAME ),
 CONSTRAINT SCHEMATA_FOREIGN_KEY_AUTHORIZATIONS
 FOREIGN KEY ( SCHEMA_OWNER )
 REFERENCES AUTHORIZATIONS,
 CONSTRAINT SCHEMATA_FOREIGN_KEY_CATALOG_NAMES
 FOREIGN KEY ( CATALOG_NAME )
 REFERENCES CATALOG_NAMES
 )
 

1. The value of CATALOG_NAME is the name of the catalog of the schema described by this row.

2. The value of SCHEMA_NAME is the unqualified schema name of the schema described by this row.

3. The values of SCHEMA_OWNER are the authorization identifiers that own the schemata.

4. The values of DEFAULT_CHARACTER_SET_CATALOG, DEFAULT_CHARACTER_SET_SCHEMA, and DEFAULT_CHARACTER_SET_NAME are the catalog name, unqualified schema name, and qualified identifier, respectively, of the default character set for columns and domains in the schemata.

5. Case:
   • If <schema path specification> was specified in the <schema definition> that defined the schema described by this row and the character representation of the <schema path specification> can be represented without truncation, then the value of SQL_PATH is that character representation.

   • Otherwise, the value of SQL_PATH is the null value.

The rows report the following {key,value} pairs:

 KEY (VARCHAR)       VALUE (VARCHAR)
 ------------------- ---------------
 SESSION_ID          the id of the calling session
 AUTOCOMMIT          YES: session is in autocommit mode, else NO
 USER                the name of user connected in the calling session
 (was READ_ONLY)
 SESSION_READONLY    TRUE: session is in read-only mode, else FALSE
 (new)
 DATABASE_READONLY   TRUE: database is in read-only mode, else FALSE
 MAXROWS             the MAXROWS setting in the calling session
 DATABASE            the name of the database
 IDENTITY            the last identity value used by calling session
 

a Table object describing theattributes of the connection associatedwith the current execution context
throws:
  HsqlException - if an error occurs while producing the table

Each row is a session state description with the following columns:

 SESSION_ID         INTEGER   session identifier
 CONNECTED          TIMESTAMP time at which session was created
 USER_NAME          VARCHAR   db user name of current session user
 IS_ADMIN           BOOLEAN   is session user an admin user?
 AUTOCOMMIT         BOOLEAN   is session in autocommit mode?
 READONLY           BOOLEAN   is session in read-only mode?
 MAXROWS            INTEGER   session's MAXROWS setting
 LAST_IDENTITY      INTEGER   last identity value used by this session
 TRANSACTION_SIZE   INTEGER   # of undo items in current transaction
 SCHEMA             VARCHAR   current schema for session
 

a Table object describing all visiblesessions
throws:
  HsqlException - if an error occurs while producing the table

Each row is a super table description with the following columns:

 TABLE_CAT       VARCHAR   the table's catalog
 TABLE_SCHEM     VARCHAR   table schema
 TABLE_NAME      VARCHAR   table name
 SUPERTABLE_NAME VARCHAR   the direct super table's name
 

a Table object describing the accessibledirect supertable (if any) of each accessibletable defined within this database
throws:
  HsqlException - if an error occurs while producing the table

Each row is a super type description with the following columns:

 TYPE_CAT        VARCHAR   the UDT's catalog
 TYPE_SCHEM      VARCHAR   UDT's schema
 TYPE_NAME       VARCHAR   type name of the UDT
 SUPERTYPE_CAT   VARCHAR   the direct super type's catalog
 SUPERTYPE_SCHEM VARCHAR   the direct super type's schema
 SUPERTYPE_NAME  VARCHAR   the direct super type's name
 

a Table object describing the accessibledirect supertype (if any) of each accessibleuser-defined type (UDT) defined within this database
throws:
  HsqlException - if an error occurs while producing the table

It effectively contains a representation of the table constraint descriptors.

Definition:

 CREATE TABLE SYSTEM_TABLE_CONSTRAINTS (
 CONSTRAINT_CATALOG      VARCHAR NULL,
 CONSTRAINT_SCHEMA       VARCHAR NULL,
 CONSTRAINT_NAME         VARCHAR NOT NULL,
 CONSTRAINT_TYPE         VARCHAR NOT NULL,
 TABLE_CATALOG           VARCHAR NULL,
 TABLE_SCHEMA            VARCHAR NULL,
 TABLE_NAME              VARCHAR NOT NULL,
 IS_DEFERRABLE           VARCHAR NOT NULL,
 INITIALLY_DEFERRED      VARCHAR NOT NULL,
 CHECK ( CONSTRAINT_TYPE IN
 ( 'UNIQUE', 'PRIMARY KEY',
 'FOREIGN KEY', 'CHECK' ) ),
 CHECK ( ( IS_DEFERRABLE, INITIALLY_DEFERRED ) IN
 ( VALUES ( 'NO',  'NO'  ),
 ( 'YES', 'NO'  ),
 ( 'YES', 'YES' ) ) )
 )
 

1. The values of CONSTRAINT_CATALOG, CONSTRAINT_SCHEMA, and CONSTRAINT_NAME are the catalog name, unqualified schema name, and qualified identifier, respectively, of the constraint being described. If the <table constraint definition> or <add table constraint definition> that defined the constraint did not specify a <constraint name>, then the values of CONSTRAINT_CATALOG, CONSTRAINT_SCHEMA, and CONSTRAINT_NAME are implementation-defined.

2. The values of CONSTRAINT_TYPE have the following meanings:

   FOREIGN KEY	The constraint being described is a foreign key constraint.
   UNIQUE	The constraint being described is a unique constraint.
   PRIMARY KEY	The constraint being described is a primary key constraint.
   CHECK	The constraint being described is a check constraint.

3. The values of TABLE_CATALOG, TABLE_SCHEMA, and TABLE_NAME are the catalog name, the unqualified schema name, and the qualified identifier of the name of the table to which the table constraint being described applies.

4. The values of IS_DEFERRABLE have the following meanings:

   YES	The table constraint is deferrable.
   NO	The table constraint is not deferrable.

5. The values of INITIALLY_DEFERRED have the following meanings:

   YES	The table constraint is initially deferred.
   NO	The table constraint is initially immediate.

Each row is a description of the attributes that defines its TEXT TABLE, with the following columns:

 TABLE_CAT                 VARCHAR   table's catalog name
 TABLE_SCHEM               VARCHAR   table's simple schema name
 TABLE_NAME                VARCHAR   table's simple name
 DATA_SOURCE_DEFINITION    VARCHAR   the "spec" proption of the table's
 SET TABLE ... SOURCE DDL declaration
 FILE_PATH                 VARCHAR   absolute file path.
 FILE_ENCODING             VARCHAR   endcoding of table's text file
 FIELD_SEPARATOR           VARCHAR   default field separator
 VARCHAR_SEPARATOR         VARCAHR   varchar field separator
 LONGVARCHAR_SEPARATOR     VARCHAR   longvarchar field separator
 IS_IGNORE_FIRST           BOOLEAN   ignores first line of file?
 IS_QUOTED                 BOOLEAN   fields are quoted if necessary?
 IS_ALL_QUOTED             BOOLEAN   all fields are quoted?
 IS_DESC                   BOOLEAN   read rows starting at end of file?
 

a Table object describing the text attributesof the accessible text tables defined within this database
throws:
  HsqlException - if an error occurs while producing the table

Each column usage description has the following columns:

 TRIGGER_CAT   VARCHAR   Trigger catalog.
 TRIGGER_SCHEM VARCHAR   Trigger schema.
 TRIGGER_NAME  VARCHAR   Trigger name.
 TABLE_CAT     VARCHAR   Catalog of table on which the trigger is defined.
 TABLE_SCHEM   VARCHAR   Schema of table on which the trigger is defined.
 TABLE_NAME    VARCHAR   Table on which the trigger is defined.
 COLUMN_NAME   VARCHAR   Name of the column used in the trigger.
 COLUMN_LIST   VARCHAR   Specified in UPDATE clause?: ("Y" | "N"}
 COLUMN_USAGE  VARCHAR   {"NEW" | "OLD" | "IN" | "OUT" | "IN OUT"}
 

a Table object describing of the usageof accessible columns in accessible triggersdefined within this database
throws:
  HsqlException - if an error occurs while producing the table

Each row is a trigger description with the following columns:

 TRIGGER_CAT       VARCHAR   Trigger catalog.
 TRIGGER_SCHEM     VARCHAR   Trigger Schema.
 TRIGGER_NAME      VARCHAR   Trigger Name.
 TRIGGER_TYPE      VARCHAR   {("BEFORE" | "AFTER") + [" EACH ROW"] }
 TRIGGERING_EVENT  VARCHAR   {"INSERT" | "UPDATE" | "DELETE"}
 (future?: "INSTEAD OF " + ("SELECT" | ...))
 TABLE_CAT         VARCHAR   Table's catalog.
 TABLE_SCHEM       VARCHAR   Table's schema.
 BASE_OBJECT_TYPE  VARCHAR   "TABLE"
 (future?: "VIEW" | "SCHEMA" | "DATABASE")
 TABLE_NAME        VARCHAR   Table on which trigger is defined
 COLUMN_NAME       VARCHAR   NULL (future?: nested table column name)
 REFERENCING_NAMES VARCHAR   ROW, OLD, NEW, etc.
 WHEN_CLAUSE       VARCHAR   Condition firing trigger (NULL => always)
 STATUS            VARCHAR   {"ENABLED" | "DISABLED"}
 DESCRIPTION       VARCHAR   typically, the trigger's DDL
 ACTION_TYPE       VARCHAR   "CALL" (future?: embedded language name)
 TRIGGER_BODY      VARCHAR   Statement(s) executed
 

a Table object describing the accessibletriggers defined within this database.
throws:
  HsqlException - if an error occurs while producing the table

This description does not contain inherited attributes.

Each row is a user-defined type attributes description with the following columns:

 TYPE_CAT          VARCHAR   type catalog
 TYPE_SCHEM        VARCHAR   type schema
 TYPE_NAME         VARCHAR   type name
 ATTR_NAME         VARCHAR   attribute name
 DATA_TYPE         SMALLINT  attribute's SQL type from DITypes
 ATTR_TYPE_NAME    VARCHAR   UDT: fully qualified type name
 REF: fully qualified type name of target type of
 the reference type.
 ATTR_SIZE         INTEGER   column size.
 char or date types => maximum number of characters;
 numeric or decimal types => precision.
 DECIMAL_DIGITS    INTEGER   # of fractional digits (scale) of number type
 NUM_PREC_RADIX    INTEGER   Radix of number type
 NULLABLE          INTEGER   whether NULL is allowed
 REMARKS           VARCHAR   comment describing attribute
 ATTR_DEF          VARCHAR   default attribute value
 SQL_DATA_TYPE     INTEGER   expected value of SQL CLI SQL_DESC_TYPE in the SQLDA
 SQL_DATETIME_SUB  INTEGER   DATETIME/INTERVAL => datetime/interval subcode
 CHAR_OCTET_LENGTH INTEGER   for char types:  max bytes in column
 ORDINAL_POSITION  INTEGER   index of column in table (starting at 1)
 IS_NULLABLE       VARCHAR   "NO" => strictly no NULL values;
 "YES" => maybe NULL values;
 "" => unknown.
 SCOPE_CATALOG     VARCHAR   catalog of REF attribute scope table or NULL
 SCOPE_SCHEMA      VARCHAR   schema of REF attribute scope table or NULL
 SCOPE_TABLE       VARCHAR   name of REF attribute scope table or NULL
 SOURCE_DATA_TYPE  SMALLINT  For DISTINCT or user-generated REF DATA_TYPE:
 source SQL type from DITypes
 For other DATA_TYPE values:  NULL
 

a Table object describing the accessibleattrubutes of the accessible user-defined type(UDT) objects defined within this database
throws:
  HsqlException - if an error occurs while producing the table

Schema-specific UDTs may have type JAVA_OBJECT, STRUCT, or DISTINCT.

Each row is a UDT descripion with the following columns:

1. TYPE_CAT VARCHAR => the type's catalog
2. TYPE_SCHEM VARCHAR => type's schema
3. TYPE_NAME VARCHAR => type name
4. CLASS_NAME VARCHAR => Java class name
5. DATA_TYPE VARCHAR => type value defined in DITypes; one of JAVA_OBJECT, STRUCT, or DISTINCT
6. REMARKS VARCHAR => explanatory comment on the type
7. BASE_TYPESMALLINT => type code of the source type of a DISTINCT type or the type that implements the user-generated reference type of the SELF_REFERENCING_COLUMN of a structured type as defined in DITypes (null if DATA_TYPE is not DISTINCT or not STRUCT with REFERENCE_GENERATION = USER_DEFINED)

Note: Currently, neither the HSQLDB engine or the JDBC driver support UDTs, so an empty table is returned.

a Table object describing the accessibleuser-defined types defined in this database
throws:
  HsqlException - if an error occurs while producing the table

It effectively contains a representation of the usage privilege descriptors.

Definition:

 CREATE TABLE SYSTEM_USAGE_PRIVILEGES (
 GRANTOR         VARCHAR NOT NULL,
 GRANTEE         VARCHAR NOT NULL,
 OBJECT_CATALOG  VARCHAR NULL,
 OBJECT_SCHEMA   VARCHAR NULL,
 OBJECT_NAME     VARCHAR NOT NULL,
 OBJECT_TYPE     VARCHAR NOT NULL
 CHECK ( OBJECT_TYPE IN (
 'DOMAIN',
 'CHARACTER SET',
 'COLLATION',
 'TRANSLATION',
 'SEQUENCE' ) ),
 IS_GRANTABLE    VARCHAR NOT NULL
 CHECK ( IS_GRANTABLE IN ( 'YES', 'NO' ) ),
 UNIQUE( GRANTOR, GRANTEE, OBJECT_CATALOG,
 OBJECT_SCHEMA, OBJECT_NAME, OBJECT_TYPE )
 )
 

1. The value of GRANTOR is the <authorization identifier> of the user or role who granted usage privileges on the object of the type identified by OBJECT_TYPE that is identified by OBJECT_CATALOG, OBJECT_SCHEMA, and OBJECT_NAME, to the user or role identified by the value of GRANTEE forthe usage privilege being described.

2. The value of GRANTEE is the <authorization identifier> of some user or role, or PUBLIC to indicate all users, to whom the usage privilege being described is granted.

3. The values of OBJECT_CATALOG, OBJECT_SCHEMA, and OBJECT_NAME are the catalog name, unqualified schema name, and qualified identifier, respectively, of the object to which the privilege applies.

4. The values of OBJECT_TYPE have the following meanings:

   DOMAIN	The object to which the privilege applies is a domain.
   CHARACTER SET	The object to which the privilege applies is a character set.
   COLLATION	The object to which the privilege applies is a collation.
   TRANSLATION	The object to which the privilege applies is a transliteration.
   SEQUENCE	The object to which the privilege applies is a sequence generator.

5. The values of IS_GRANTABLE have the following meanings:

   YES	The privilege being described was granted WITH GRANT OPTION and is thus grantable.
   NO	The privilege being described was not granted WITH GRANT OPTION and is thus not grantable.

Each row is a version column description with the following columns:

1. SCOPE SMALLINT => is not used
2. COLUMN_NAME VARCHAR => column name
3. DATA_TYPE SMALLINT => SQL data type from java.sql.Types
4. TYPE_NAME SMALLINT => Data source dependent type name
5. COLUMN_SIZE INTEGER => precision
6. BUFFER_LENGTH INTEGER => length of column value in bytes
7. DECIMAL_DIGITS SMALLINT => scale
8. PSEUDO_COLUMN SMALLINT => is this a pseudo column like an Oracle ROWID:
   (as defined in java.sql.DatabaseMetadata)
   • versionColumnUnknown - may or may not be pseudo column
   • versionColumnNotPseudo - is NOT a pseudo column
   • versionColumnPseudo - is a pseudo column

Note: Currently, the HSQLDB engine does not support version columns, so an empty table is returned.

a Table object describing the columnsthat are automatically updated when any valuein a row is updated
throws:
  HsqlException - if an error occurs while producing the table

Each row is a description of the query expression that defines its view, with the following columns:

 TABLE_CATALOG    VARCHAR     name of view's defining catalog.
 TABLE_SCHEMA     VARCHAR     unqualified name of view's defining schema.
 TABLE_NAME       VARCHAR     the simple name of the view.
 VIEW_DEFINITION  VARCHAR     the character representation of the
 <query expression> contained in the
 corresponding <view descriptor>.
 CHECK_OPTION     VARCHAR     {"CASCADED" | "LOCAL" | "NONE"}
 IS_UPDATABLE     VARCHAR     {"YES" | "NO"}
 VALID            BOOLEAN     Always TRUE: VIEW_DEFINITION currently
 represents a valid <query expression>.
 

a tabular description of the text source of allView objects accessible tothe user.
throws:
  HsqlException - if an error occurs while producing the table

Definition:

 CREATE TABLE SYSTEM_VIEW_COLUMN_USAGE (
 VIEW_CATALOG    VARCHAR NULL,
 VIEW_SCHEMA     VARCHAR NULL,
 VIEW_NAME       VARCHAR NOT NULL,
 TABLE_CATALOG   VARCHAR NULL,
 TABLE_SCHEMA    VARCHAR NULL,
 TABLE_NAME      VARCHAR NOT NULL,
 COLUMN_NAME     VARCHAR NOT NULL,
 UNIQUE ( VIEW_CATALOG, VIEW_SCHEMA, VIEW_NAME,
 TABLE_CATALOG, TABLE_SCHEMA, TABLE_NAME,
 COLUMN_NAME )
 )
 

1. The values of VIEW_CATALOG, VIEW_SCHEMA, and VIEW_NAME are the catalog name, unqualified schema name, and qualified identifier, respectively, of the view being described.

2. The values of TABLE_CATALOG, TABLE_SCHEMA, TABLE_NAME, and COLUMN_NAME are the catalog name, unqualified schema name, qualified identifier, and column name, respectively, of a column of a table that is explicitly or implicitly referenced in the <query expression> of the view being described.

Definition

 CREATE TABLE VIEW_ROUTINE_USAGE (
 TABLE_CATALOG       VARCHAR NULL,
 TABLE_SCHEMA        VARCHAR NULL,
 TABLE_NAME          VARCHAR NOT NULL,
 SPECIFIC_CATALOG    VARCHAR NULL,
 SPECIFIC_SCHEMA     VARCHAR NULL,
 SPECIFIC_NAME       VARCHAR NOT NULL,
 UNIQUE( TABLE_CATALOG, TABLE_SCHEMA, TABLE_NAME,
 SPECIFIC_CATALOG, SPECIFIC_SCHEMA,
 SPECIFIC_NAME )
 )
 

1. The values of TABLE_CATALOG, TABLE_SCHEMA, and TABLE_NAME are the catalog name, unqualified schema name, and qualified identifier, respectively, of the viewed table being described.

2. The values of SPECIFIC_CATALOG, SPECIFIC_SCHEMA, and SPECIFIC_NAME are the catalog name, unqualified schema name, and qualified identifier, respectively, of the specific name of R.

Definition

 CREATE TABLE SYSTEM_VIEW_TABLE_USAGE (
 VIEW_CATALOG    VARCHAR NULL,
 VIEW_SCHEMA     VARCHAR NULL,
 VIEW_NAME       VARCHAR NULL,
 TABLE_CATALOG   VARCHAR NULL,
 TABLE_SCHEMA    VARCHAR NULL,
 TABLE_NAME      VARCHAR NULL,
 UNIQUE( VIEW_CATALOG, VIEW_SCHEMA, VIEW_NAME,
 TABLE_CATALOG, TABLE_SCHEMA, TABLE_NAME )
 )
 

1. The values of VIEW_CATALOG, VIEW_SCHEMA, and VIEW_NAME are the catalog name, unqualified schema name, and qualified identifier, respectively, of the view being described.

2. The values of TABLE_CATALOG, TABLE_SCHEMA, and TABLE_NAME are the catalog name, unqualified schema name, and qualified identifier, respectively, of a table identified by a <table name> simply contained in a <table reference> that is contained in the <query expression> of the view being described.

Parameters:
  t - the table in which the rows are to be inserted
Parameters:
  l - the list of procedure name aliases to which thespecified column values apply
Parameters:
  cat - the procedure's catalog name
Parameters:
  schem - the procedure's schema name
Parameters:
  pName - the procedure's simple base (non-alias) name
Parameters:
  cName - the procedure column name
Parameters:
  cType - the column type (return, parameter, result)
Parameters:
  dType - the column's data type code
Parameters:
  tName - the column's canonical data type name
Parameters:
  prec - the column's precision
Parameters:
  len - the column's buffer length
Parameters:
  scale - the column's scale (decimal digits)
Parameters:
  radix - the column's numeric precision radix
Parameters:
  nullability - the column's java.sql.DatbaseMetaDatanullabiliy code
Parameters:
  remark - a human-readable remark regarding the column
Parameters:
  specificName - the specific name of the procedure(typically but not limited toa fully qualified Java Method name and signature)
Parameters:
  seq - helper value to back JDBC contract sort order
throws:
  HsqlException - if there is problem inserting the specified rowsin the table

Parameters:
  t - the table into which the specified rows will eventuallybe inserted
Parameters:
  l - the list of procedure name aliases to which the specified columnvalues apply
Parameters:
  cat - the procedure catalog name
Parameters:
  schem - the procedure schema name
Parameters:
  pName - the base (non-alias) procedure name
Parameters:
  ip - the procedure input parameter count
Parameters:
  op - the procedure output parameter count
Parameters:
  rs - the procedure result column count
Parameters:
  remark - a human-readable remark regarding the procedure
Parameters:
  pType - the procedure type code, indicating whether it is afunction, procedure, or uncatagorized (i.e. returnsa value, does not return a value, or it is unknownif it returns a value)
Parameters:
  origin - origin of the procedure, e.g.(["BUILTIN" | "USER DEFINED"] "ROUTINE" | "TRIGGER") | "ALIAS", etc.
Parameters:
  specificName - the specific name of the procedure(typically but not limited to afully qualified Java Method name and signature)
throws:
  HsqlException - if there is problem inserting the specified rowsin the table

Parameters:
  tableIndex - index identifying the system table to generate
throws:
  HsqlException - if a database access error occurs the system table corresponding to the specified index