org.postgresql.jdbc3.AbstractJdbc3DatabaseMetaData Maven / Gradle / Ivy

/*-------------------------------------------------------------------------
*
* Copyright (c) 2004-2014, PostgreSQL Global Development Group
*
*
*-------------------------------------------------------------------------
*/
package org.postgresql.jdbc3;


import java.sql.Connection;
import java.sql.DatabaseMetaData;
import java.sql.ResultSet;
import java.sql.SQLException;

import org.postgresql.core.ServerVersion;

public abstract class AbstractJdbc3DatabaseMetaData extends org.postgresql.jdbc2.AbstractJdbc2DatabaseMetaData
{

    public AbstractJdbc3DatabaseMetaData(AbstractJdbc3Connection conn)
    {
        super(conn);
    }


    /**
     * Retrieves whether this database supports savepoints.
     *
     * @return true if savepoints are supported;
     *     false otherwise
     * @exception SQLException if a database access error occurs
     * @since 1.4
     */
    public boolean supportsSavepoints() throws SQLException
    {
        return connection.haveMinimumServerVersion(ServerVersion.v8_0);
    }

    /**
     * Retrieves whether this database supports named parameters to callable
     * statements.
     *
     * @return true if named parameters are supported;
     *     false otherwise
     * @exception SQLException if a database access error occurs
     * @since 1.4
     */
    public boolean supportsNamedParameters() throws SQLException
    {
        return false;
    }

    /**
     * Retrieves whether it is possible to have multiple ResultSet objects
     * returned from a CallableStatement object
     * simultaneously.
     *
     * @return true if a CallableStatement object
     *     can return multiple ResultSet objects
     *     simultaneously; false otherwise
     * @exception SQLException if a datanase access error occurs
     * @since 1.4
     */
    public boolean supportsMultipleOpenResults() throws SQLException
    {
        return false;
    }

    /**
     * Retrieves whether auto-generated keys can be retrieved after
     * a statement has been executed.
     *
     * @return true if auto-generated keys can be retrieved
     *     after a statement has executed; false otherwise
     * @exception SQLException if a database access error occurs
     * @since 1.4
     */
    public boolean supportsGetGeneratedKeys() throws SQLException
    {
        // We don't support returning generated keys by column index,
        // but that should be a rarer case than the ones we do support.
        //
        return connection.haveMinimumServerVersion(ServerVersion.v8_2);
    }

    /**
     * Retrieves a description of the user-defined type (UDT) hierarchies defined in a
     * particular schema in this database. Only the immediate super type/
     * sub type relationship is modeled.
     * 
     * Only supertype information for UDTs matching the catalog,
     * schema, and type name is returned. The type name parameter
     * may be a fully-qualified name. When the UDT name supplied is a
     * fully-qualified name, the catalog and schemaPattern parameters are
     * ignored.
     * 

     * If a UDT does not have a direct super type, it is not listed here.
     * A row of the ResultSet object returned by this method
     * describes the designated UDT and a direct supertype. A row has the following
     * columns:
     * 

     * TYPE_CAT String => the UDT's catalog (may be null)
     * 
TYPE_SCHEM String => UDT's schema (may be null)
     * 
TYPE_NAME String => type name of the UDT
     * 
SUPERTYPE_CAT String => the direct super type's catalog 
     *        (may be null)
     * 
SUPERTYPE_SCHEM String => the direct super type's schema 
     *          (may be null)
     * 
SUPERTYPE_NAME String => the direct super type's name
     * 
     *
     * Note: If the driver does not support type hierarchies, an
     * empty result set is returned.
     *
     * @param catalog a catalog name; "" retrieves those without a catalog;
     *    null means drop catalog name from the selection criteria
     * @param schemaPattern a schema name pattern; "" retrieves those
     *    without a schema
     * @param typeNamePattern a UDT name pattern; may be a fully-qualified
     *    name
     * @return a ResultSet object in which a row gives information
     *     about the designated UDT
     * @throws SQLException if a database access error occurs
     * @since 1.4
     */
    public ResultSet getSuperTypes(String catalog, String schemaPattern,
                                   String typeNamePattern) throws SQLException
    {
        throw org.postgresql.Driver.notImplemented(this.getClass(), "getSuperTypes(String,String,String)");
    }

    /**
     * Retrieves a description of the table hierarchies defined in a particular
     * schema in this database.
     *
     * 
Only supertable information for tables matching the catalog, schema
     * and table name are returned. The table name parameter may be a fully-
     * qualified name, in which case, the catalog and schemaPattern parameters
     * are ignored. If a table does not have a super table, it is not listed here.
     * Supertables have to be defined in the same catalog and schema as the
     * sub tables. Therefore, the type description does not need to include
     * this information for the supertable.
     *
     * 
Each type description has the following columns:
     * 

     * TABLE_CAT String => the type's catalog (may be null)
     * 
TABLE_SCHEM String => type's schema (may be null)
     * 
TABLE_NAME String => type name
     * 
SUPERTABLE_NAME String => the direct super type's name
     * 
     *
     * Note: If the driver does not support type hierarchies, an
     * empty result set is returned.
     *
     * @param catalog a catalog name; "" retrieves those without a catalog;
     *    null means drop catalog name from the selection criteria
     * @param schemaPattern a schema name pattern; "" retrieves those
     *    without a schema
     * @param tableNamePattern a table name pattern; may be a fully-qualified
     *    name
     * @return a ResultSet object in which each row is a type description
     * @throws SQLException if a database access error occurs
     * @since 1.4
     */
    public ResultSet getSuperTables(String catalog, String schemaPattern,
                                    String tableNamePattern) throws SQLException
    {
        throw org.postgresql.Driver.notImplemented(this.getClass(), "getSuperTables(String,String,String,String)");
    }

    /**
     * Retrieves a description of the given attribute of the given type
     * for a user-defined type (UDT) that is available in the given schema
     * and catalog.
     * 

     * Descriptions are returned only for attributes of UDTs matching the
     * catalog, schema, type, and attribute name criteria. They are ordered by
     * TYPE_SCHEM, TYPE_NAME and ORDINAL_POSITION. This description
     * does not contain inherited attributes.
     * 

     * The ResultSet object that is returned has the following
     * columns:
     * 

     * TYPE_CAT String => type catalog (may be null)
     * 
TYPE_SCHEM String => type schema (may be null)
     * 
TYPE_NAME String => type name
     * 
ATTR_NAME String => attribute name
     * 
DATA_TYPE short => attribute type SQL type from java.sql.Types
     * 
ATTR_TYPE_NAME String => Data source dependent type name.
     * For a UDT, the type name is fully qualified. For a REF, the type name is
     * fully qualified and represents the target type of the reference type.
     * 
ATTR_SIZE int => column size.  For char or date
     *  types this is the maximum number of characters; for numeric or
     *  decimal types this is precision.
     * 
DECIMAL_DIGITS int => the number of fractional digits
     * 
NUM_PREC_RADIX int => Radix (typically either 10 or 2)
     * 
NULLABLE int => whether NULL is allowed
     *  
     *   attributeNoNulls - might not allow NULL values
     *  
 attributeNullable - definitely allows NULL values
     *  
 attributeNullableUnknown - nullability unknown
     *  
     * 
REMARKS String => comment describing column (may be null)
     * 
ATTR_DEF String => default value (may be null)
     * 
SQL_DATA_TYPE int => unused
     * 
SQL_DATETIME_SUB int => unused
     * 
CHAR_OCTET_LENGTH int => for char types the
     *   maximum number of bytes in the column
     * 
ORDINAL_POSITION int => index of column in table
     *  (starting at 1)
     * 
IS_NULLABLE String => "NO" means column definitely
     *  does not allow NULL values; "YES" means the column might
     *  allow NULL values. An empty string means unknown.
     * 
SCOPE_CATALOG String => catalog of table that is the
     *  scope of a reference attribute (null if DATA_TYPE isn't REF)
     * 
SCOPE_SCHEMA String => schema of table that is the
     *  scope of a reference attribute (null if DATA_TYPE isn't REF)
     * 
SCOPE_TABLE String => table name that is the scope of a
     *  reference attribute (null if the DATA_TYPE isn't REF)
     * 
SOURCE_DATA_TYPE short => source type of a distinct type or user-generated
     *  Ref type,SQL type from java.sql.Types (null if DATA_TYPE
     *  isn't DISTINCT or user-generated REF)
     * 
     * @param catalog a catalog name; must match the catalog name as it
     *    is stored in the database; "" retrieves those without a catalog;
     *    null means that the catalog name should not be used to narrow
     *    the search
     * @param schemaPattern a schema name pattern; must match the schema name
     *    as it is stored in the database; "" retrieves those without a schema;
     *    null means that the schema name should not be used to narrow
     *    the search
     * @param typeNamePattern a type name pattern; must match the
     *    type name as it is stored in the database
     * @param attributeNamePattern an attribute name pattern; must match the attribute
     *    name as it is declared in the database
     * @return a ResultSet object in which each row is an
     *     attribute description
     * @exception SQLException if a database access error occurs
     * @since 1.4
     */
    public ResultSet getAttributes(String catalog, String schemaPattern,
                                   String typeNamePattern, String attributeNamePattern)
    throws SQLException
    {
        throw org.postgresql.Driver.notImplemented(this.getClass(), "getAttributes(String,String,String,String)");
    }

    /**
     * Retrieves whether this database supports the given result set holdability.
     *
     * @param holdability one of the following constants:
     *   ResultSet.HOLD_CURSORS_OVER_COMMIT or
     *   ResultSet.CLOSE_CURSORS_AT_COMMIT
     * @return true if so; false otherwise
     * @exception SQLException if a database access error occurs
     * @see Connection
     * @since 1.4
     */
    public boolean supportsResultSetHoldability(int holdability) throws SQLException
    {
        return true;
    }

    /**
     * Retrieves the default holdability of this ResultSet
     * object.
     *
     * @return the default holdability; either
     *     ResultSet.HOLD_CURSORS_OVER_COMMIT or
     *     ResultSet.CLOSE_CURSORS_AT_COMMIT
     * @exception SQLException if a database access error occurs
     * @since 1.4
     */
    public int getResultSetHoldability() throws SQLException
    {
        return ResultSet.HOLD_CURSORS_OVER_COMMIT;
    }

    /**
     * Retrieves the major version number of the underlying database.
     *
     * @return the underlying database's major version
     * @exception SQLException if a database access error occurs
     * @since 1.4
     */
    public int getDatabaseMajorVersion() throws SQLException
    {
        return connection.getServerMajorVersion();
    }

    /**
     * Retrieves the minor version number of the underlying database.
     *
     * @return underlying database's minor version
     * @exception SQLException if a database access error occurs
     * @since 1.4
     */
    public int getDatabaseMinorVersion() throws SQLException
    {
        return connection.getServerMinorVersion();
    }

    /**
     * Retrieves the major JDBC version number for this
     * driver.
     *
     * @return JDBC version major number
     * @exception SQLException if a database access error occurs
     * @since 1.4
     */
    public int getJDBCMajorVersion() throws SQLException
    {
        return 3; // This class implements JDBC 3.0
    }

    /**
     * Retrieves the minor JDBC version number for this
     * driver.
     *
     * @return JDBC version minor number
     * @exception SQLException if a database access error occurs
     * @since 1.4
     */
    public int getJDBCMinorVersion() throws SQLException
    {
        return 0; // This class implements JDBC 3.0
    }

    /**
     * Indicates whether the SQLSTATEs returned by SQLException.getSQLState
     * is X/Open (now known as Open Group) SQL CLI or SQL99.
     * @return the type of SQLSTATEs, one of:
     *    sqlStateXOpen or
     *    sqlStateSQL99
     * @throws SQLException if a database access error occurs
     * @since 1.4
     */
    public int getSQLStateType() throws SQLException
    {
        return DatabaseMetaData.sqlStateSQL99;
    }

    /**
     * Indicates whether updates made to a LOB are made on a copy or directly
     * to the LOB.
     * @return true if updates are made to a copy of the LOB;
     *     false if updates are made directly to the LOB
     * @throws SQLException if a database access error occurs
     * @since 1.4
     */
    public boolean locatorsUpdateCopy() throws SQLException
    {
        /*
         * Currently LOB's aren't updateable at all, so it doesn't
         * matter what we return.  We don't throw the notImplemented
         * Exception because the 1.5 JDK's CachedRowSet calls this
         * method regardless of wether large objects are used.
         */ 
        return true;
    }

    /**
     * Retrieves weather this database supports statement pooling.
     *
     * @return true is so;
     false otherwise
     * @throws SQLExcpetion if a database access error occurs
     * @since 1.4
     */
    public boolean supportsStatementPooling() throws SQLException
    {
        return false;
    }

    public ResultSet getColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern) throws SQLException
    {
        return getColumns(3, catalog, schemaPattern, tableNamePattern, columnNamePattern);
    }

    public ResultSet getSchemas() throws SQLException
    {
        return getSchemas(3, null, null);
    }
}