Package oracle.jdbc

Interface OracleResultSetMetaData

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

    • Field Summary

      • Fields inherited from interface java.sql.ResultSetMetaData

        columnNoNulls, columnNullable, columnNullableUnknown

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getDomainName​(int column)
      Gets the domain name for input column index.
      java.lang.String getDomainSchema​(int column)
      Gets the domain schema for input column index.
      int getScale​(int column)
      Gets the designated column's number of digits to the right of the decimal point.
      OracleResultSetMetaData.SecurityAttribute getSecurityAttribute​(int indexOfColumnInResultSet)
      Returns the eXtensible Data Security (XDS) attribute of this column.
      boolean isColumnInvisible​(int indexOfColumnInResultSet)
      Returns the column visibility information of the specified column.
      boolean isColumnJSON​(int column)
      Returns true if the specified column contains JSON data otherwise returns false.
      boolean isNCHAR​(int index)
      isNCHAR (int)
      boolean isVariableScale​(int column)
      If the scale of Oracle NUMBER, FLOAT, DECIMAL and DOUBLE database datatype is unspecified this method returns true.

      • Methods inherited from interface java.sql.ResultSetMetaData

        getCatalogName, getColumnClassName, getColumnCount, getColumnDisplaySize, getColumnLabel, getColumnName, getColumnType, getColumnTypeName, getPrecision, getSchemaName, getTableName, isAutoIncrement, isCaseSensitive, isCurrency, isDefinitelyWritable, isNullable, isReadOnly, isSearchable, isSigned, isWritable

      • Methods inherited from interface java.sql.Wrapper

        isWrapperFor, unwrap

    • Method Detail

      • isNCHAR

        boolean isNCHAR​(int index)
         throws java.sql.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:
        java.sql.SQLException

      • getSecurityAttribute

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

      • isColumnInvisible

        boolean isColumnInvisible​(int indexOfColumnInResultSet)
                   throws java.sql.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:
        java.sql.SQLException

      • isVariableScale

        boolean isVariableScale​(int column)
                 throws java.sql.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:
        java.sql.SQLException

      • isColumnJSON

        boolean isColumnJSON​(int column)
              throws java.sql.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:
        java.sql.SQLException

      • getScale

        int getScale​(int column)
      throws java.sql.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 java.sql.ResultSetMetaData
        Parameters:
        column - the first column is 1, the second is 2, ...
        Returns:
        scale
        Throws:
        java.sql.SQLException - if a database access error occurs

      • getDomainName

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

      • getDomainSchema

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