org.apache.flink.connector.hbase.util

Class HBaseTableSchema

java.lang.Object

org.apache.flink.connector.hbase.util.HBaseTableSchema

All Implemented Interfaces:

Serializable

@Internal
public class HBaseTableSchema
extends Object
implements Serializable

Helps to specify an HBase Table's schema.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HBaseTableSchema()

Method Summary

Modifier and Type	Method and Description
void	addColumn(String family, String qualifier, Class<?> clazz) Adds a column defined by family, qualifier, and type to the table schema.
void	addColumn(String family, String qualifier, DataType type)
DataType	convertToDataType() Converts this HBaseTableSchema to DataType, the fields are consisted of families and rowkey, the order is in the definition order (i.e.
boolean	equals(Object o)
static HBaseTableSchema	fromDataType(DataType physicalRowType) Construct a HBaseTableSchema from a DataType.
byte[][]	getFamilyKeys() Returns the HBase identifiers of all registered column families.
String[]	getFamilyNames() Returns the names of all registered column families.
DataType[]	getQualifierDataTypes(String family)
byte[][]	getQualifierKeys(String family) Returns the HBase identifiers of all registered column qualifiers for a specific column family.
String[]	getQualifierNames(String family) Returns the names of all registered column qualifiers of a specific column family.
Optional<DataType>	getRowKeyDataType()
int	getRowKeyIndex() Returns field index of row key in the table schema.
Optional<String>	getRowKeyName() Returns optional value of row key name.
Optional<TypeInformation<?>>	getRowKeyTypeInfo() Returns the optional type information of row key.
int	hashCode()
void	setCharset(String charset) Sets the charset for value strings and HBase identifiers.
void	setRowKey(String rowKeyName, Class<?> clazz) Sets row key information in the table schema.
void	setRowKey(String rowKeyName, DataType type)

Methods inherited from class java.lang.Object

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

Constructor Detail

HBaseTableSchema

public HBaseTableSchema()

Method Detail

addColumn

public void addColumn(String family,
                      String qualifier,
                      Class<?> clazz)

Adds a column defined by family, qualifier, and type to the table schema.

Parameters:

family - the family name

qualifier - the qualifier name

clazz - the data type of the qualifier

addColumn

public void addColumn(String family,
                      String qualifier,
                      DataType type)

setRowKey

public void setRowKey(String rowKeyName,
                      Class<?> clazz)

Sets row key information in the table schema.

Parameters:

rowKeyName - the row key field name

clazz - the data type of the row key

setRowKey

public void setRowKey(String rowKeyName,
                      DataType type)

setCharset

public void setCharset(String charset)

Sets the charset for value strings and HBase identifiers.

Parameters:

charset - the charset for value strings and HBase identifiers.

getFamilyNames

public String[] getFamilyNames()

Returns the names of all registered column families.

Returns:

The names of all registered column families.

getFamilyKeys

public byte[][] getFamilyKeys()

Returns the HBase identifiers of all registered column families.

Returns:

The HBase identifiers of all registered column families.

getQualifierNames

public String[] getQualifierNames(String family)

Returns the names of all registered column qualifiers of a specific column family.

Parameters:

family - The name of the column family for which the column qualifier names are returned.

Returns:

The names of all registered column qualifiers of a specific column family.

getQualifierKeys

public byte[][] getQualifierKeys(String family)

Returns the HBase identifiers of all registered column qualifiers for a specific column family.

Parameters:

family - The name of the column family for which the column qualifier identifiers are returned.

Returns:

The HBase identifiers of all registered column qualifiers for a specific column family.

getQualifierDataTypes

public DataType[] getQualifierDataTypes(String family)

getRowKeyIndex

public int getRowKeyIndex()

Returns field index of row key in the table schema. Returns -1 if row key is not set.

getRowKeyTypeInfo

public Optional<TypeInformation<?>> getRowKeyTypeInfo()

Returns the optional type information of row key. Returns null if row key is not set.

getRowKeyDataType

public Optional<DataType> getRowKeyDataType()

getRowKeyName

public Optional<String> getRowKeyName()

Returns optional value of row key name. The row key name is the field name in hbase schema which can be queried in Flink SQL.

convertToDataType

public DataType convertToDataType()

Converts this HBaseTableSchema to DataType, the fields are consisted of families and rowkey, the order is in the definition order (i.e. calling addColumn(String, String, Class) and setRowKey(String, Class)). The family field is a composite type which is consisted of qualifiers.

Returns:

the DataType derived from the HBaseTableSchema.

fromDataType

public static HBaseTableSchema fromDataType(DataType physicalRowType)

Construct a HBaseTableSchema from a DataType.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object