Package oracle.jdbc

Interface AdditionalDatabaseMetaData

All Superinterfaces:
DatabaseMetaData, Wrapper
All Known Implementing Classes:
OracleDatabaseMetaData
public interface AdditionalDatabaseMetaData extends DatabaseMetaData
This interface defines additional Oracle specific methods for DatabaseMetaData. Rightfully it should be called OracleDatabaseMetaData, but that name is already used by the class that implements DatabaseMetaData for the Oracle JDBC drivers. That class implements this interface. Best practice is to use the standard Java interface, java.sql.DatabaseMetaData. If your app requires access to the additional Oracle specific information then cast the result of getDatabaseMetaData to this type, AdditionalDatabaseMetaData. Use of the class OracleDatabaseMetaData is not recommended and will cause ClassCastException if used with some new Oracle JDBC features.
Since:
11.2.0.3.0

  • Method Details

    • getOracleTypeMetaData

      OracleTypeMetaData getOracleTypeMetaData(String sqlTypeName) throws SQLException
      Return the type metadata for a named type. Use this instead of the various Descriptor classes and methods. Use of the Descriptor classes and methods such as oracle.sql.TypeDescriptor, is not recommended and will cause ClassCastException if used with some new Oracle JDBC features.
      Parameters:
      sqlTypeName - the name of the type
      Returns:
      the metadata for the type
      Throws:
      SQLException - if the type does not exist or some other error occurs
      Since:
      11.2.0.3.0

    • getLobMaxLength

      long getLobMaxLength() throws SQLException
      The max size of a lob on the server for this connection. Note that the actual size available for a particular lob will depend on the specific storage allocation.
      Returns:
      Max size of lob.
      Throws:
      SQLException
      Since:
      11.2.0.3.0

    • getAuditBanner

      String getAuditBanner() throws SQLException
      Returns the audit banner on this connection.
      Returns:
      String containing the audit banner or a null String if there isn't one available on this connection.
      Throws:
      SQLException - if there is any issue while retrieving the banner

    • getAccessBanner

      String getAccessBanner() throws SQLException
      Returns the access banner on this connection.
      Returns:
      String containing the access banner or a null String if there isn't one available on this connection.
      Throws:
      SQLException - if there is any issue while retrieving the banner

    • getAnnotations

      default Map<String,String> getAnnotations(String objectName, String columnName, String domainName, String domainOwner) throws SQLException
      Since 23ai, annotations can be specified to schema objects such as tables, views and columns. Annotations is a mechanism to store application metadata centrally in the database. Annotations can be specified at creation time or at modification time. An individual annotation has a name and an optional value. Both the name and the value are freeform text fields. A schema object can have multiple annotations. This method returns annotation associated with the specified column. Returns null if there are no annotation for the given column.
      Parameters:
      objectName - Table / View Name
      columnName - Name of the column
      domainName - Domain Name [Optional, can be null]
      domainOwner - Domain Owner [Optional, can be null]
      Throws:
      SQLException
      See Also:

    • getAnnotations

      default Map<String,String> getAnnotations(String objectName, String domainName, String domainOwner) throws SQLException
      Since 23ai, annotations can be specified to schema objects such as tables, views and columns. Annotations is a mechanism to store application metadata centrally in the database. Annotations can be specified at creation time or at modification time. An individual annotation has a name and an optional value. Both the name and the value are freeform text fields. A schema object can have multiple annotations. This method returns annotation associated with the specified table or view. Returns null if there are no annotation for the given object.
      Parameters:
      objectName - Table / View Name
      domainName - Domain Name [Optional, can be null]
      domainOwner - Domain Owner [Optional, can be null]
      Throws:
      SQLException

    • isDualityView

      boolean isDualityView(String viewName) throws SQLException
      Checks whether the view mentioned exists and is a JSON Duality view
      Parameters:
      viewName - the view that needs to be checked
      Returns:
      true if the view exists and is a JSON Duality view, false otherwise
      Throws:
      SQLException

    • getJsonSchema

      ResultSet getJsonSchema(String viewName) throws SQLException
      Gets the schema of the JSON Duality view
      Parameters:
      viewName - the view whose schema is to be extracted
      Returns:
      Schema of the JSON Duality view if exists
      Throws:
      SQLException - if the json duality view does not exist