org.apache.flink.table.descriptors

Class HBase

java.lang.Object

org.apache.flink.table.descriptors.DescriptorBase

org.apache.flink.table.descriptors.ConnectorDescriptor

org.apache.flink.table.descriptors.HBase

All Implemented Interfaces:

Descriptor

@PublicEvolving
public class HBase
extends ConnectorDescriptor

Connector descriptor for Apache HBase.

Constructor Summary

Constructors

Constructor and Description
HBase()

Method Summary

Modifier and Type	Method and Description
HBase	properties(Properties properties) Sets the configuration properties for HBase Configuration.
HBase	property(String key, String value) Adds a configuration property for HBase Configuration.
HBase	tableName(String tableName) Set the HBase table name, Required.
protected Map<String,String>	toConnectorProperties() Converts this descriptor into a set of connector properties.
HBase	version(String version) Set the Apache HBase version to be used.
HBase	writeBufferFlushInterval(String interval) Set an interval when to flushing buffered requesting if the interval passes, in milliseconds.
HBase	writeBufferFlushMaxRows(int writeBufferFlushMaxRows) Set threshold when to flush buffered request based on the number of rows currently added.
HBase	writeBufferFlushMaxSize(String maxSize) Set threshold when to flush buffered request based on the memory byte size of rows currently added.
HBase	zookeeperNodeParent(String zookeeperNodeParent) Set the zookeeper node parent path of HBase cluster.
HBase	zookeeperQuorum(String zookeeperQuorum) Set the zookeeper quorum address to connect the HBase cluster.

Methods inherited from class org.apache.flink.table.descriptors.ConnectorDescriptor

isFormatNeeded, toProperties

Methods inherited from class org.apache.flink.table.descriptors.DescriptorBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HBase

public HBase()

Method Detail

version

public HBase version(String version)

Set the Apache HBase version to be used. Required.

Parameters:

version - HBase version. E.g., "1.4.3".

tableName

public HBase tableName(String tableName)

Set the HBase table name, Required.

Parameters:

tableName - Name of HBase table. E.g., "testNamespace:testTable", "testDefaultTable"

zookeeperQuorum

public HBase zookeeperQuorum(String zookeeperQuorum)

Set the zookeeper quorum address to connect the HBase cluster. Required.

Parameters:

zookeeperQuorum - zookeeper quorum address to connect the HBase cluster. E.g., "localhost:2181,localhost:2182,localhost:2183".

zookeeperNodeParent

public HBase zookeeperNodeParent(String zookeeperNodeParent)

Set the zookeeper node parent path of HBase cluster. Default to use "/hbase", Optional.

Parameters:

zookeeperNodeParent - zookeeper node path of hbase cluster. E.g, "/hbase/example-root-znode".

writeBufferFlushMaxSize

public HBase writeBufferFlushMaxSize(String maxSize)

Set threshold when to flush buffered request based on the memory byte size of rows currently added. Default to 2mb. Optional.

Parameters:

maxSize - the maximum size (using the syntax of MemorySize).

writeBufferFlushMaxRows

public HBase writeBufferFlushMaxRows(int writeBufferFlushMaxRows)

Set threshold when to flush buffered request based on the number of rows currently added. Defaults to not set, i.e. won't flush based on the number of buffered rows. Optional.

Parameters:

writeBufferFlushMaxRows - number of added rows when begin the request flushing.

writeBufferFlushInterval

public HBase writeBufferFlushInterval(String interval)

Set an interval when to flushing buffered requesting if the interval passes, in milliseconds. Defaults to not set, i.e. won't flush based on flush interval. Optional.

Parameters:

interval - flush interval. The string should be in format "{length value}{time unit label}" E.g, "123ms", "1 s", If no time unit label is specified, it will be considered as milliseconds. For more details about the format, please see TimeUtils.parseDuration(String)}.

properties

public HBase properties(Properties properties)

Sets the configuration properties for HBase Configuration. Resets previously set properties.

Parameters:

properties - The configuration properties for HBase Configuration.

property

public HBase property(String key,
                      String value)

Adds a configuration property for HBase Configuration.

Parameters:

key - property key for the HBase Configuration

value - property value for the HBase Configuration

toConnectorProperties

protected Map<String,String> toConnectorProperties()

Description copied from class: ConnectorDescriptor

Converts this descriptor into a set of connector properties. Usually prefixed with ConnectorDescriptorValidator.CONNECTOR.

Specified by:

toConnectorProperties in class ConnectorDescriptor