HBaseTableSchema (flink-connector-hbase 1.11.2 API)

java.lang.Object
- org.apache.flink.connector.hbase.util.HBaseTableSchema

所有已实现的接口:

Serializable
```
@Internal
public class HBaseTableSchema
extends Object
implements Serializable
```
Helps to specify an HBase Table's schema.

另请参阅:

序列化表格

构造器概要

构造器
构造器和说明

HBaseTableSchema()

构造器
构造器和说明
`HBaseTableSchema()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`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, org.apache.flink.table.types.DataType type)`
`org.apache.flink.table.api.TableSchema`	`convertsToTableSchema()` Converts this `HBaseTableSchema` to `TableSchema`, 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)`).
`static HBaseTableSchema`	`fromTableSchema(org.apache.flink.table.api.TableSchema schema)` Construct a `HBaseTableSchema` from a `TableSchema`.
`byte[][]`	`getFamilyKeys()` Returns the HBase identifiers of all registered column families.
`String[]`	`getFamilyNames()` Returns the names of all registered column families.
`HBaseTableSchema`	`getProjectedHBaseTableSchema(int[] projectedFields)` Gets a new hbase schema with the selected fields.
`org.apache.flink.table.types.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.
`org.apache.flink.api.common.typeinfo.TypeInformation<?>[]`	`getQualifierTypes(String family)` Returns the types of all registered column qualifiers of a specific column family.
`Optional<org.apache.flink.table.types.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<org.apache.flink.api.common.typeinfo.TypeInformation<?>>`	`getRowKeyTypeInfo()` Returns the optional type information of row key.
`String`	`getStringCharset()` Returns the charset for value strings and HBase identifiers.
`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, org.apache.flink.table.types.DataType type)`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - HBaseTableSchema
```
public HBaseTableSchema()
```
- 方法详细资料
  - addColumn
```
public void addColumn(String family,
                      String qualifier,
                      Class<?> clazz)
```
    Adds a column defined by family, qualifier, and type to the table schema.
    
    参数:
    
    family - the family name
    
    qualifier - the qualifier name
    
    clazz - the data type of the qualifier
  - addColumn
```
public void addColumn(String family,
                      String qualifier,
                      org.apache.flink.table.types.DataType type)
```
  - setRowKey
```
public void setRowKey(String rowKeyName,
                      Class<?> clazz)
```
    Sets row key information in the table schema.
    
    参数:
    
    rowKeyName - the row key field name
    
    clazz - the data type of the row key
  - setRowKey
```
public void setRowKey(String rowKeyName,
                      org.apache.flink.table.types.DataType type)
```
  - setCharset
```
public void setCharset(String charset)
```
    Sets the charset for value strings and HBase identifiers.
    
    参数:
    
    charset - the charset for value strings and HBase identifiers.
  - getFamilyNames
```
public String[] getFamilyNames()
```
    Returns the names of all registered column families.
    
    返回:
    
    The names of all registered column families.
  - getFamilyKeys
```
public byte[][] getFamilyKeys()
```
    Returns the HBase identifiers of all registered column families.
    
    返回:
    
    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.
    
    参数:
    
    family - The name of the column family for which the column qualifier names are returned.
    
    返回:
    
    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.
    
    参数:
    
    family - The name of the column family for which the column qualifier identifiers are returned.
    
    返回:
    
    The HBase identifiers of all registered column qualifiers for a specific column family.
  - getQualifierTypes
```
public org.apache.flink.api.common.typeinfo.TypeInformation<?>[] getQualifierTypes(String family)
```
    Returns the types of all registered column qualifiers of a specific column family.
    
    参数:
    
    family - The name of the column family for which the column qualifier types are returned.
    
    返回:
    
    The types of all registered column qualifiers of a specific column family.
  - getQualifierDataTypes
```
public org.apache.flink.table.types.DataType[] getQualifierDataTypes(String family)
```
  - getStringCharset
```
public String getStringCharset()
```
    Returns the charset for value strings and HBase identifiers.
    
    返回:
    
    The charset for value strings and HBase identifiers.
  - 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<org.apache.flink.api.common.typeinfo.TypeInformation<?>> getRowKeyTypeInfo()
```
    Returns the optional type information of row key. Returns null if row key is not set.
  - getRowKeyDataType
```
public Optional<org.apache.flink.table.types.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.
  - getProjectedHBaseTableSchema
```
public HBaseTableSchema getProjectedHBaseTableSchema(int[] projectedFields)
```
    Gets a new hbase schema with the selected fields.
  - convertsToTableSchema
```
public org.apache.flink.table.api.TableSchema convertsToTableSchema()
```
    Converts this HBaseTableSchema to TableSchema, 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.
    
    返回:
    
    the TableSchema derived from the HBaseTableSchema.
  - fromTableSchema
```
public static HBaseTableSchema fromTableSchema(org.apache.flink.table.api.TableSchema schema)
```
    Construct a HBaseTableSchema from a TableSchema.

类 HBaseTableSchema

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

HBaseTableSchema

方法详细资料

addColumn

addColumn

setRowKey

setRowKey

setCharset

getFamilyNames

getFamilyKeys

getQualifierNames

getQualifierKeys

getQualifierTypes

getQualifierDataTypes

getStringCharset

getRowKeyIndex

getRowKeyTypeInfo

getRowKeyDataType

getRowKeyName

getProjectedHBaseTableSchema

convertsToTableSchema

fromTableSchema