Package io.github.flink.gcp.connector.bigtable.table

Class BigtableTableSchema.Family

java.lang.Object
io.github.flink.gcp.connector.bigtable.table.BigtableTableSchema.Family
Enclosing class:
BigtableTableSchema
@Internal public static final class BigtableTableSchema.Family extends Object
One column family: a ROW column whose nested fields are its qualifiers, or a MAP column whose entries are.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object o)
     
    int
    getIndex()
    Returns the position of the family's column in the physical row.
    org.apache.flink.table.types.logical.LogicalType
    getMapKeyType()
    Returns the declared type of a MAP family's keys, which are its qualifiers.
    org.apache.flink.table.types.logical.LogicalType
    getMapValueType()
    Returns the declared type of a MAP family's values, which are its cells.
    String
    getName()
    Returns the family name, which is the column name.
    List<BigtableTableSchema.Qualifier>
    getQualifiers()
    Returns the family's qualifiers, in DDL order; empty for a MAP family, whose qualifiers are its entries' keys and so are known only per row.
    int
    hashCode()
     
    boolean
    isMap()
    Returns whether the family is declared as a MAP rather than a ROW.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • getName

      public String getName()
      Returns the family name, which is the column name.

    • getIndex

      public int getIndex()
      Returns the position of the family's column in the physical row.

    • getQualifiers

      public List<BigtableTableSchema.Qualifier> getQualifiers()
      Returns the family's qualifiers, in DDL order; empty for a MAP family, whose qualifiers are its entries' keys and so are known only per row.

    • isMap

      public boolean isMap()
      Returns whether the family is declared as a MAP rather than a ROW.

    • getMapKeyType

      public org.apache.flink.table.types.logical.LogicalType getMapKeyType()
      Returns the declared type of a MAP family's keys, which are its qualifiers.
      Throws:
      IllegalStateException - if the family is a ROW

    • getMapValueType

      public org.apache.flink.table.types.logical.LogicalType getMapValueType()
      Returns the declared type of a MAP family's values, which are its cells.
      Throws:
      IllegalStateException - if the family is a ROW

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object