Package com.apple.foundationdb.relational.api

Interface StructMetaData

All Superinterfaces:
Wrapper
All Known Subinterfaces:
RelationalResultSetMetaData
All Known Implementing Classes:
RelationalStructMetaData, StructResultSetMetaData
public interface StructMetaData extends Wrapper
Metadata describing what is in a RelationalStruct. As ResultSetMetaData is for ResultSet, so is this Interface for instances of Struct. The below is modeled on -- and a subset of -- ResultSetMetaData with a few extras such as getStructMetaData(int), getArrayMetaData(int) and getLeadingPhantomColumnCount(). Types returned by getColumnType(int) are Types.

  • Method Details

    • getTypeName

      String getTypeName() throws SQLException
      Returns the name of the struct type. The user can set the struct type name in SQL explicitly by using struct <name> (...) clause.
      For example: SELECT struct Foo (a, b) from T will give the struct (a, b) the name foo.
      Returns:
      The name of the struct type.
      Throws:
      SQLException

    • getColumnCount

      int getColumnCount() throws SQLException
      Throws:
      SQLException

    • isNullable

      int isNullable(int oneBasedColumn) throws SQLException
      Throws:
      SQLException

    • getColumnLabel

      String getColumnLabel(int oneBasedColumn) throws SQLException
      Throws:
      SQLException

    • getColumnName

      String getColumnName(int oneBasedColumn) throws SQLException
      Throws:
      SQLException

    • getSchemaName

      String getSchemaName(int oneBasedColumn) throws SQLException
      Throws:
      SQLException

    • getTableName

      String getTableName(int oneBasedColumn) throws SQLException
      Throws:
      SQLException

    • getCatalogName

      String getCatalogName(int oneBasedColumn) throws SQLException
      Throws:
      SQLException

    • getColumnType

      int getColumnType(int oneBasedColumn) throws SQLException
      Throws:
      SQLException

    • getColumnTypeName

      String getColumnTypeName(int oneBasedColumn) throws SQLException
      Throws:
      SQLException

    • getStructMetaData

      StructMetaData getStructMetaData(int oneBasedColumn) throws SQLException
      Get the Metadata for a nested struct type. If the column is not a struct type, this will throw an error.
      Parameters:
      oneBasedColumn - the position of the column, indexed at 1
      Returns:
      the metadata for the struct at column oneBasedColumn
      Throws:
      SQLException - if the type of the column is not a struct, or if something else goes wrong.

    • getArrayMetaData

      ArrayMetaData getArrayMetaData(int oneBasedColumn) throws SQLException
      Get the Metadata for an array type. If the column is not an array type, this will throw an error.
      Parameters:
      oneBasedColumn - the position of the column, indexed at 1
      Returns:
      the metadata for the array at column oneBasedColumn
      Throws:
      SQLException - if the type of the column is not an array, or if something else goes wrong.

    • getLeadingPhantomColumnCount

      default int getLeadingPhantomColumnCount()