Module org.itsallcode.jdbc
Package org.itsallcode.jdbc.metadata

Record Class TableMetaData

java.lang.Object
java.lang.Record
org.itsallcode.jdbc.metadata.TableMetaData
Record Components:
tableCatalog - table catalog (may be null)
tableSchema - table schema (may be null)
tableName - table name
tableType - table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM".
remarks - explanatory comment on the table (may be null)
typeCatalog - the types catalog (may be null)
typeSchema - the types schema (may be null)
typeName - type name (may be null)
selfReferencingColumnName - name of the designated "identifier" column of a typed table (may be null)
refGeneration - specifies how values in SELF_REFERENCING_COL_NAME are created. Values are "SYSTEM", "USER", "DERIVED". (may be null)
public record TableMetaData(String tableCatalog, String tableSchema, String tableName, String tableType, String remarks, String typeCatalog, String typeSchema, String typeName, String selfReferencingColumnName, String refGeneration) extends Record
Description of a table.
See Also:

  • Constructor Details

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • tableCatalog

      public String tableCatalog()
      Returns the value of the tableCatalog record component.
      Returns:
      the value of the tableCatalog record component

    • tableSchema

      public String tableSchema()
      Returns the value of the tableSchema record component.
      Returns:
      the value of the tableSchema record component

    • tableName

      public String tableName()
      Returns the value of the tableName record component.
      Returns:
      the value of the tableName record component

    • tableType

      public String tableType()
      Returns the value of the tableType record component.
      Returns:
      the value of the tableType record component

    • remarks

      public String remarks()
      Returns the value of the remarks record component.
      Returns:
      the value of the remarks record component

    • typeCatalog

      public String typeCatalog()
      Returns the value of the typeCatalog record component.
      Returns:
      the value of the typeCatalog record component

    • typeSchema

      public String typeSchema()
      Returns the value of the typeSchema record component.
      Returns:
      the value of the typeSchema record component

    • typeName

      public String typeName()
      Returns the value of the typeName record component.
      Returns:
      the value of the typeName record component

    • selfReferencingColumnName

      public String selfReferencingColumnName()
      Returns the value of the selfReferencingColumnName record component.
      Returns:
      the value of the selfReferencingColumnName record component

    • refGeneration

      public String refGeneration()
      Returns the value of the refGeneration record component.
      Returns:
      the value of the refGeneration record component