sqlrelaydatabasemetadata.java

适合于Unix/Linux下的一个持久数据库连接池

     *    10. SCALE short => scale
     *    11. RADIX short => radix
     *    12. NULLABLE short => can it contain NULL?
     *            * procedureNoNulls - does not allow NULL values
     *            * procedureNullable - allows NULL values
     *            * procedureNullableUnknown - nullability unknown
     *    13. REMARKS String => comment describing parameter/column 
     *
     *  Note: Some databases may not return the column descriptions for a 
     *  procedure. Additional columns beyond REMARKS can be defined by the 
     *  database.
     *
     *  Parameters:
     *  catalog - a catalog name;
     *      "" retrieves those without a catalog;
     *      null means drop catalog name from the selection criteria
     *  schemaPattern - a schema name pattern;
     *      "" retrieves those without a schema
     *  procedureNamePattern - a procedure name pattern
     *  columnNamePattern - a column name pattern
     *
     *  Returns:
     *  ResultSet - each row is a stored procedure parameter or column
     *    description
     *
     *  Throws:
     *  SQLException if a database-access error occurs.
     *
     *  See Also:
     *  getSearchStringEscape
     */
    public abstract ResultSet getProcedureColumns(String catalog,
                                                   String schemaPattern,
                                                   String procedureNamePattern,
                                                   String columnNamePattern)
                                                        throws SQLException {
    }
    
    /**
     *  Get a description of tables available in a catalog.
     *
     *  Only table descriptions matching the catalog, schema, table name and
     *  type criteria are returned. They are ordered by TABLE_TYPE,
     *  TABLE_SCHEM and TABLE_NAME.
     *
     *  Each table description has the following columns:
     *
     *     1. TABLE_CAT String => table catalog (may be null)
     *     2. TABLE_SCHEM String => table schema (may be null)
     *     3. TABLE_NAME String => table name
     *     4. TABLE_TYPE String => table type. Typical types are "TABLE",
     *        "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY",
     *        "ALIAS", "SYNONYM".
     *     5. REMARKS String => explanatory comment on the table 
     *
     *  Note: Some databases may not return information for all tables.
     *
     *  Parameters:
     *  catalog - a catalog name;
     *      "" retrieves those without a catalog;
     *      null means drop catalog name from the selection criteria
     *  schemaPattern - a schema name pattern;
     *      "" retrieves those without a schema
     *  tableNamePattern - a table name pattern
     *  types - a list of table types to include;
     *      null returns all types
     *
     *  Returns:
     *  ResultSet - each row is a table description
     *
     *  Throws:
     *  SQLException if a database-access error occurs.
     *
     *  See Also:
     *  getSearchStringEscape
     */
    public abstract ResultSet getTables(String catalog,
                                         String schemaPattern,
                                         String tableNamePattern,
                                         String types[]) throws SQLException {
    }
    
    /**
     *  Get the schema names available in this database. The results are
     *  ordered by schema name.
     *
     *  The schema column is:
     *
     *     1. TABLE_SCHEM String => schema name 
     *
     *  Returns:
     *  ResultSet - each row has a single String column that is a schema name
     *
     *  Throws: SQLException if a database-access error occurs.
     */
    public abstract ResultSet getSchemas() throws SQLException
    
    /**
     *  Get the catalog names available in this database. The results are
     *  ordered by catalog name.
     *
     *  The catalog column is:
     *
     *     1. TABLE_CAT String => catalog name 
     *
     *  Returns:
     *  ResultSet - each row has a single String column that is a catalog name
     *
     *  Throws: SQLException
     *  if a database-access error occurs.
     */
    public abstract ResultSet getCatalogs() throws SQLException {
    }
    
    /**
     *  Get the table types available in this database. The results are ordered 
     *  by table type.
     *
     *  The table type is:
     *
     *     1. TABLE_TYPE String => table type. Typical types are "TABLE", 
     *          "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY",
     *          "ALIAS", "SYNONYM". 
     *
     *  Returns:
     *  ResultSet - each row has a single String column that is a table type
     *
     *  Throws: SQLException
     *  if a database-access error occurs.
     */
    public abstract ResultSet getTableTypes() throws SQLException {
    }
    
    /**
     *  Get a description of table columns available in a catalog.
     *
     *  Only column descriptions matching the catalog, schema, table and column
     *  name criteria are returned. They are ordered by TABLE_SCHEM, TABLE_NAME 
     *  and ORDINAL_POSITION.
     *
     *  Each column description has the following columns:
     *
     *     1. TABLE_CAT String => table catalog (may be null)
     *     2. TABLE_SCHEM String => table schema (may be null)
     *     3. TABLE_NAME String => table name
     *     4. COLUMN_NAME String => column name
     *     5. DATA_TYPE short => SQL type from java.sql.Types
     *     6. TYPE_NAME String => Data source dependent type name
     *     7. COLUMN_SIZE int => column size. For char or date types this is the
     *        maximum number of characters, for numeric or decimal types this is
     *        precision.
     *     8. BUFFER_LENGTH is not used.
     *     9. DECIMAL_DIGITS int => the number of fractional digits
     *    10. NUM_PREC_RADIX int => Radix (typically either 10 or 2)
     *    11. NULLABLE int => is NULL allowed?
     *            * columnNoNulls - might not allow NULL values
     *            * columnNullable - definitely allows NULL values
     *            * columnNullableUnknown - nullability unknown
     *    12. REMARKS String => comment describing column (may be null)
     *    13. COLUMN_DEF String => default value (may be null)
     *    14. SQL_DATA_TYPE int => unused
     *    15. SQL_DATETIME_SUB int => unused
     *    16. CHAR_OCTET_LENGTH int => for char types the maximum number of
     *        bytes in the column
     *    17. ORDINAL_POSITION int => index of column in table (starting at 1)
     *    18. IS_NULLABLE String => "NO" means column definitely does not allow
     *        NULL values; "YES" means the column might allow NULL values. An
     *        empty string means nobody knows. 
     *
     *  Parameters:
     *  catalog -
     *    a catalog name;
     *    "" retrieves those without a catalog;
     *    null means drop catalog name from the selection criteria
     *  schemaPattern -
     *    a schema name pattern;
     *    "" retrieves those without a schema
     *  tableNamePattern -
     *    a table name pattern
     *  columnNamePattern -
     *    a column name pattern
     *
     *  Returns:
     *  ResultSet - each row is a column description
     *
     *  Throws:
     *  SQLException if a database-access error occurs.
     *
     *  See Also:
     *  getSearchStringEscape
     */
    public abstract ResultSet getColumns(String catalog,
                                          String schemaPattern,
                                          String tableNamePattern,
                                          String columnNamePattern)
                                                        throws SQLException {
    }
    
    /**
     *  Get a description of the access rights for a table's columns.
     *
     *  Only privileges matching the column name criteria are returned. They
     *  are ordered by COLUMN_NAME and PRIVILEGE.
     *
     *  Each privilige description has the following columns:
     *
     *     1. TABLE_CAT String => table catalog (may be null)
     *     2. TABLE_SCHEM String => table schema (may be null)
     *     3. TABLE_NAME String => table name
     *     4. COLUMN_NAME String => column name
     *     5. GRANTOR => grantor of access (may be null)
     *     6. GRANTEE String => grantee of access
     *     7. PRIVILEGE String => name of access (SELECT, INSERT, UPDATE,
     *          REFRENCES, ...)
     *     8. IS_GRANTABLE String => "YES" if grantee is permitted to grant to 
     *          others; "NO" if not; null if unknown 
     *
     *  Parameters:
     *  catalog - a catalog name;
     *    "" retrieves those without a catalog;
     *    null means drop catalog name from the selection criteria
     *  schema - a schema name;
     *    "" retrieves those without a schema
     *  table - a table name
     *  columnNamePattern - a column name pattern
     *
     *  Returns:
     *  ResultSet - each row is a column privilege description
     *
     *  Throws:
     *  SQLException if a database-access error occurs.
     *
     *  See Also:
     *  getSearchStringEscape
     */
    public abstract ResultSet getColumnPrivileges(String catalog,
                                                   String schema,
                                                   String table,
                                                   String columnNamePattern)
                                                        throws SQLException {
    }
    
    /**
     *  Get a description of the access rights for each table available in a
     *  catalog. Note that a table privilege applies to one or more columns in
     *  the table. It would be wrong to assume that this priviledge applies to
     *  all columns (this may be true for some systems but is not true for all.)
     *
     *  Only privileges matching the schema and table name criteria are
     *  returned. They are ordered by TABLE_SCHEM, TABLE_NAME, and PRIVILEGE.
     *
     *  Each privilige description has the following columns:
     *
     *     1. TABLE_CAT String => table catalog (may be null)
     *     2. TABLE_SCHEM String => table schema (may be null)
     *     3. TABLE_NAME String => table name
     *     4. GRANTOR => grantor of access (may be null)
     *     5. GRANTEE String => grantee of access
     *     6. PRIVILEGE String => name of access (SELECT, INSERT, UPDATE,
     *        REFRENCES, ...)
     *     7. IS_GRANTABLE String => "YES" if grantee is permitted to grant to
     *         others; "NO" if not; null if unknown 
     *
     *  Parameters:
     *  catalog - a catalog name;
     *    "" retrieves those without a catalog;
     *    null means drop catalog name from the selection criteria
     *  schemaPattern - a schema name pattern;
     *    "" retrieves those without a schema
     *  tableNamePattern - a table name pattern
     *
     *  Returns:
     *  ResultSet - each row is a table privilege description
     *
     *  Throws:
     *  SQLException if a database-access error occurs.
     *
     *  See Also:
     *  getSearchStringEscape
     */
    public abstract ResultSet getTablePrivileges(String catalog,
                                                  String schemaPattern,
                                                  String tableNamePattern)
                                                        throws SQLException {
    }
    
    /**
     *  Get a description of a table's optimal set of columns that uniquely
     *  identifies a row. They are ordered by SCOPE.
     *
     *  Each column description has the following columns:
     *
     *     1. SCOPE short => actual scope of result
     *            * bestRowTemporary - very temporary, while using row
     *            * bestRowTransaction - valid for remainder of current
     *                                   transaction
     *            * bestRowSession - valid for remainder of current session
     *     2. COLUMN_NAME String => column name
     *     3. DATA_TYPE short => SQL data type from java.sql.Types
     *     4. TYPE_NAME String => Data source dependent type name
     *     5. COLUMN_SIZE int => precision
     *     6. BUFFER_LENGTH int => not used
     *     7. DECIMAL_DIGITS short => scale
     *     8. PSEUDO_COLUMN short => is this a pseudo column like an Oracle
     *                               ROWID
     *            * bestRowUnknown - may or may not be pseudo column
     *            * bestRowNotPseudo - is NOT a pseudo column
     *           * bestRowPseudo - is a pseudo column
     *
     *  Parameters:
     *  catalog - a catalog name;
     *    "" retrieves those without a catalog;
     *    null means drop catalog name from the selection criteria
     *  schema - a schema name;
     *    "" retrieves those without a schema
     *  table - a table name
     *  scope - the scope of interest; use same values as SCOPE
     *  nullable - include columns that are nullable?
     *
     *  Returns:
     *  ResultSet - each row is a column description
     *
     *  Throws:
     *  SQLException if a database-access error occurs.
     */
    public abstract ResultSet getBestRowIdentifier(String catalog,
                                                    String schema,
                                                    String table,
                                                    int scope,
                                                    boolean nullable)
                                                        throws SQLException {
    }
    
    /**
     *  Get a description of a table's columns that are automatically updated
     *  when any value in a row is updated. They are unordered.
     *
     *  Each column description has the following columns:
     *
     *     1. SCOPE short => is not used
     *     2. COLUMN_NAME String => column name
     *     3. DATA_TYPE short => SQL data type from java.sql.Types
     *     4. TYPE_NAME String => Data source dependent type name
     *     5. COLUMN_SIZE int => precision
     *     6. BUFFER_LENGTH int => length of column value in bytes
     *     7. DECIMAL_DIGITS short => scale
     *     8. PSEUDO_COLUMN short => is this a pseudo column like an Oracle
     *                               ROWID
     *            * versionColumnUnknown - may or may not be pseudo column
     *            * versionColumnNotPseudo - is NOT a pseudo column
     *            * versionColumnPseudo - is a pseudo column
     *
     *  Parameters:
     *  catalog - a catalog name;
     *    "" retrieves those without a catalog;
     *    null means drop catalog name from the selection criteria
     *  schema - a schema name;
     *    "" retrieves those without a schema
     *  table - a table name
     *
     *  Returns:
     *  ResultSet - each row is a column description
     *
     *  Throws:
     *  SQLException if a database-access error occurs.
     */
    public abstract ResultSet getVersionColumns(String catalog,
                                                 String schema,
                                                 String table)
                                                    throws SQLException {
    }
    
    /**
     *  Get a description of a table's primary key columns. They are ordered by
     *  COLUMN_NAME.
     *
     *  Each primary key column description has the following columns:
     *
     *     1. TABLE_CAT String => table catalog (may be null)
     *     2. TABLE_SCHEM String => table schema (may be null)
     *     3. TABLE_NAME String => table name
     *     4. COLUMN_NAME String => column name
     *     5. KEY_SEQ short => sequence number within primary key
     *     6. PK_NAME String => primary key name (may be null) 
     *
     *  Parameters:
     *  catalog - a catalog name;
     *    "" retrieves those without a catalog;
     *    null means drop catalog name from the selection criteria
     *  schema - a schema name pattern;
     *    "" retrieves those without a schema
     *  table - a table name
     *
     *  Returns:
     *  ResultSet - each row is a primary key column description
     *
     *  Throws: SQLException
     *  if a database-access error occurs.
     */
    public abstract ResultSet getPrimaryKeys(String catalog,
                                              String schema,
                                              String table) throws SQLException {
    }
    
    /**
     *  Get a description of the primary key columns that are referenced by a
     *  table's foreign key columns (the primary keys imported by a table). 
     *  They are ordered by PKTABLE_CAT, PKTABLE_SCHEM, PKTABLE_NAME, and
     *  KEY_SEQ.
     *
     *  Each primary key column description has the following columns:
     *
     *     1. PKTABLE_CAT String => primary key table catalog being imported
     *          (may be null)
     *     2. PKTABLE_SCHEM String => primary key table schema being imported
     *          (may be null)
     *     3. PKTABLE_NAME String => primary key table name being imported
     *     4. PKCOLUMN_NAME String => primary key column name being imported
     *     5. FKTABLE_CAT String => foreign key table catalog (may be null)
     *     6. FKTABLE_SCHEM String => foreign key table schema (may be null)
     *     7. FKTABLE_NAME String => foreign key table name
     *     8. FKCOLUMN_NAME String => foreign key column name
     *     9. KEY_SEQ short => sequence number within foreign key
     *    10. UPDATE_RULE short => What happens to foreign key when primary is
     *          updated:
     *            * importedNoAction - do not allow update of primary key if it 
     *                                 has been imported
     *            * importedKeyCascade - change imported key to agree with 
     *                                   primary key update
     *            * importedKeySetNull - change imported key to NULL if its
     *                                   primary key has been updated
     *            * importedKeySetDefault - change imported key to default
     *                                      values if its primary key has been
     *                                      updated
     *            * importedKeyRestrict - same as importedKeyNoAction (for ODBC 
     *