Package oracle.jdbc

Interface OracleResultSetMetaData

All Superinterfaces:
ResultSetMetaData, Wrapper
All Known Subinterfaces:
StructMetaData
public interface OracleResultSetMetaData extends ResultSetMetaData
An object that can be used to get information about the types and properties of the columns in a ResultSet object.

  • Method Details

    • isNCHAR

      boolean isNCHAR(int index) throws SQLException
      isNCHAR (int)
      Parameters:
      index - the column index
      Returns:
      true if the column is of type NCHAR/NVARCHAR/NCLOB false if the column is not of type NCHAR/NVARCHAR/NCLOB
      Throws:
      SQLException

    • getSecurityAttribute

      OracleResultSetMetaData.SecurityAttribute getSecurityAttribute(int indexOfColumnInResultSet) throws SQLException
      Returns the eXtensible Data Security (XDS) attribute of this column.
      Throws:
      SQLException
      See Also:
      • OracleResultSet.getAuthorizationIndicator

    • isColumnInvisible

      boolean isColumnInvisible(int indexOfColumnInResultSet) throws SQLException
      Returns the column visibility information of the specified column.

      An invisible column is a user defined/specified hidden column which can be later changed to visible. It is created as: 

           create table test_tab (col1 integer invisible, col2 integer);
      It can be modified later by using: 
           alter table test_tab modify (col1 visible);
      Parameters:
      indexOfColumnInResultSet - the column index
      Returns:
      true if the column is invisible false if the column is not invisible
      Throws:
      SQLException

    • isVariableScale

      boolean isVariableScale(int column) throws SQLException
      If the scale of Oracle NUMBER, FLOAT, DECIMAL and DOUBLE database datatype is unspecified this method returns true. Oracle database returns -127 if scale is unspecified.
      Parameters:
      column - the first column is 1, the second is 2, ...
      Returns:
      true if the column type has variable scale
      Throws:
      SQLException

    • isColumnJSON

      boolean isColumnJSON(int column) throws SQLException
      Returns true if the specified column contains JSON data otherwise returns false.

      A columns that always contains JSON data is a textual (VARCHAR2 or CLOB) or binary (BLOB) table column with an IS JSON check constraint or a view column that has an underlying JSON generation function .

      Parameters:
      column - the column index
      Returns:
      true if the column contains JSON data false if the column does not contain JSON data
      Throws:
      SQLException

    • getScale

      int getScale(int column) throws SQLException
      Gets the designated column's number of digits to the right of the decimal point.

      An Oracle NUMBER data type can be defined with a scale that ranges from -84 to 127. When the scale is not specified, the special value -127 will be returned by this method. It has no other meaning than to indicate that the scale isn't set.

      For data types that don't have a scale, the value 0 is returned.

      Specified by:
      getScale in interface ResultSetMetaData
      Parameters:
      column - the first column is 1, the second is 2, ...
      Returns:
      scale
      Throws:
      SQLException - if a database access error occurs

    • getDomainName

      String getDomainName(int column) throws SQLException
      Gets the domain name for input column index.
      Parameters:
      column - the column index
      Returns:
      the domain name for input column index
      Throws:
      SQLException

    • getDomainSchema

      String getDomainSchema(int column) throws SQLException
      Gets the domain schema for input column index.
      Parameters:
      column - the column index
      Returns:
      the domain schema for input column index
      Throws:
      SQLException

    • getAnnotations

      Map<String,String> getAnnotations(int column) 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. getAnnotations(int) is used for getting annotation associated with column. Please refer OracleDatabaseMetaData for table and view annotations.
      Parameters:
      column - the column index
      Returns:
      Returns annotations associated for the given column index.
      If there are no annotations then returns null.
      Throws:
      SQLException
      Since:
      23ai
      See Also:

    • getVectorMetaData

      VectorMetaData getVectorMetaData(int column) throws SQLException
      Returns the metadata for a VECTOR column, or null if the column is not a VECTOR.
      Parameters:
      column - the first column is 1, the second is 2, ...
      Returns:
      VECTOR column metadata, or null if the column is not a VECTOR.
      Throws:
      SQLException - if a database access error occurs
      Since:
      23.4