wuchong commented on a change in pull request #12386: URL: https://github.com/apache/flink/pull/12386#discussion_r433604088
########## File path: docs/dev/table/connectors/hbase.md ########## @@ -0,0 +1,291 @@ +--- +title: "HBase SQL Connector" +nav-title: HBase +nav-parent_id: sql-connectors +nav-pos: 9 +--- +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +--> + +<span class="label label-primary">Scan Source: Bounded</span> +<span class="label label-primary">Lookup Source: Sync Mode</span> +<span class="label label-primary">Sink: Batch</span> +<span class="label label-primary">Sink: Streaming Upsert Mode</span> + +* This will be replaced by the TOC +{:toc} + +The HBase connector allows for reading from and writing to an HBase cluster. This document describes how to setup the HBase Connector to run SQL queries against HBase. + +The connector can operate in upsert mode for exchange changelog messages with the external system using a primary key defined on the DDL. But the primary key can only be defined on the HBase rowkey field. If the PRIMARY KEY clause is not declared, the HBase connector will take rowkey as the primary key by default. + +<span class="label label-danger">Attention</span> HBase as a Lookup Source does not use any caching; data is always queried directly through the HBase client. + +Dependencies +------------ + +In order to setup the HBase connector, the following table provide dependency information for both projects using a build automation tool (such as Maven or SBT) and SQL Client with SQL JAR bundles. + +{% if site.is_stable %} + +| HBase Version | Maven dependency | SQL Client JAR | +| :------------------ | :-------------------------------------------------------- | :----------------------| +| 1.4.x | `flink-connector-hbase{{site.scala_version_suffix}}` | [Download](https://repo.maven.apache.org/maven2/org/apache/flink/flink-connector-hbase{{site.scala_version_suffix}}/{{site.version}}/flink-connector-hbase{{site.scala_version_suffix}}-{{site.version}}.jar) | + +{% else %} + +The dependency table is only available for stable releases. + +{% endif %} + +How to create an HBase table +---------------- + +All the column families in HBase table must be declared as ROW type, the field name maps to the column family name, and the nested field names map to the column qualifier names. There is no need to declare all the families and qualifiers in the schema, users can declare what’s necessary. Except the ROW type fields, the only one field of atomic type (e.g. STRING, BIGINT) will be recognized as HBase rowkey. The rowkey field can be arbitrary name. + +<div class="codetabs" markdown="1"> +<div data-lang="SQL" markdown="1"> +{% highlight sql %} +CREATE TABLE hTable ( + rowkey INT, + family1 ROW<q1 INT>, + family2 ROW<q2 STRING, q3 BIGINT>, + family3 ROW<q4 DOUBLE, q5 BOOLEAN, q6 STRING>, + PRIMARY KEY (rowkey) NOT ENFORCED +) WITH ( + 'connector' = 'hbase-1.4', + 'table-name' = 'mytable', + 'zookeeper.quorum' = 'localhost:2121' +) +{% endhighlight %} +</div> +</div> + +Connector Options +---------------- + +<table class="table table-bordered"> + <thead> + <tr> + <th class="text-left" style="width: 25%">Option</th> + <th class="text-center" style="width: 8%">Required</th> + <th class="text-center" style="width: 7%">Default</th> + <th class="text-center" style="width: 10%">Type</th> + <th class="text-center" style="width: 50%">Description</th> + </tr> + </thead> + <tbody> + <tr> + <td><h5>connector</h5></td> + <td>required</td> + <td style="word-wrap: break-word;">(none)</td> + <td>String</td> + <td>Specify what connector to use, here should be 'hbase-1.4'.</td> + </tr> + <tr> + <td><h5>table-name</h5></td> + <td>required</td> + <td style="word-wrap: break-word;">(none)</td> + <td>String</td> + <td>The name of HBase table to connect.</td> + </tr> + <tr> + <td><h5>zookeeper.quorum</h5></td> + <td>required</td> + <td style="word-wrap: break-word;">(none)</td> + <td>String</td> + <td>The HBase Zookeeper quorum.</td> + </tr> + <tr> + <td><h5>zookeeper.znode.parent</h5></td> + <td>optional</td> + <td style="word-wrap: break-word;">/hbase</td> + <td>String</td> + <td>The root dir in Zookeeper for HBase cluster</td> + </tr> + <tr> + <td><h5>null-string-literal</h5></td> + <td>optional</td> + <td style="word-wrap: break-word;">null</td> + <td>String</td> + <td>Representation for null values for string fields. HBase source and sink encodes/decodes empty bytes as null values for all types except string type.</td> + </tr> + <tr> + <td><h5>sink.buffer-flush.max-size</h5></td> + <td>optional</td> + <td style="word-wrap: break-word;">2mb</td> + <td>MemorySize</td> + <td>Writing option, determines how many size in memory of buffered rows to insert per round trip. + This can improve performance for writing data to HBase database, but may increase the latency. Review comment: I changed this to `maximum size in memory of buffered rows for each writing request`, I think we should make the `size in memory` more visible to users, what do you think? ########## File path: docs/dev/table/connectors/hbase.md ########## @@ -0,0 +1,291 @@ +--- +title: "HBase SQL Connector" +nav-title: HBase +nav-parent_id: sql-connectors +nav-pos: 9 +--- +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +--> + +<span class="label label-primary">Scan Source: Bounded</span> +<span class="label label-primary">Lookup Source: Sync Mode</span> +<span class="label label-primary">Sink: Batch</span> +<span class="label label-primary">Sink: Streaming Upsert Mode</span> + +* This will be replaced by the TOC +{:toc} + +The HBase connector allows for reading from and writing to an HBase cluster. This document describes how to setup the HBase Connector to run SQL queries against HBase. + +The connector can operate in upsert mode for exchange changelog messages with the external system using a primary key defined on the DDL. But the primary key can only be defined on the HBase rowkey field. If the PRIMARY KEY clause is not declared, the HBase connector will take rowkey as the primary key by default. + +<span class="label label-danger">Attention</span> HBase as a Lookup Source does not use any caching; data is always queried directly through the HBase client. + +Dependencies +------------ + +In order to setup the HBase connector, the following table provide dependency information for both projects using a build automation tool (such as Maven or SBT) and SQL Client with SQL JAR bundles. + +{% if site.is_stable %} + +| HBase Version | Maven dependency | SQL Client JAR | +| :------------------ | :-------------------------------------------------------- | :----------------------| +| 1.4.x | `flink-connector-hbase{{site.scala_version_suffix}}` | [Download](https://repo.maven.apache.org/maven2/org/apache/flink/flink-connector-hbase{{site.scala_version_suffix}}/{{site.version}}/flink-connector-hbase{{site.scala_version_suffix}}-{{site.version}}.jar) | + +{% else %} + +The dependency table is only available for stable releases. + +{% endif %} + +How to create an HBase table +---------------- + +All the column families in HBase table must be declared as ROW type, the field name maps to the column family name, and the nested field names map to the column qualifier names. There is no need to declare all the families and qualifiers in the schema, users can declare what’s necessary. Except the ROW type fields, the only one field of atomic type (e.g. STRING, BIGINT) will be recognized as HBase rowkey. The rowkey field can be arbitrary name. + +<div class="codetabs" markdown="1"> +<div data-lang="SQL" markdown="1"> +{% highlight sql %} +CREATE TABLE hTable ( + rowkey INT, + family1 ROW<q1 INT>, + family2 ROW<q2 STRING, q3 BIGINT>, + family3 ROW<q4 DOUBLE, q5 BOOLEAN, q6 STRING>, + PRIMARY KEY (rowkey) NOT ENFORCED +) WITH ( + 'connector' = 'hbase-1.4', + 'table-name' = 'mytable', + 'zookeeper.quorum' = 'localhost:2121' +) +{% endhighlight %} +</div> +</div> + +Connector Options +---------------- + +<table class="table table-bordered"> + <thead> + <tr> + <th class="text-left" style="width: 25%">Option</th> + <th class="text-center" style="width: 8%">Required</th> + <th class="text-center" style="width: 7%">Default</th> + <th class="text-center" style="width: 10%">Type</th> + <th class="text-center" style="width: 50%">Description</th> + </tr> + </thead> + <tbody> + <tr> + <td><h5>connector</h5></td> + <td>required</td> + <td style="word-wrap: break-word;">(none)</td> + <td>String</td> + <td>Specify what connector to use, here should be 'hbase-1.4'.</td> + </tr> + <tr> + <td><h5>table-name</h5></td> + <td>required</td> + <td style="word-wrap: break-word;">(none)</td> + <td>String</td> + <td>The name of HBase table to connect.</td> + </tr> + <tr> + <td><h5>zookeeper.quorum</h5></td> + <td>required</td> + <td style="word-wrap: break-word;">(none)</td> + <td>String</td> + <td>The HBase Zookeeper quorum.</td> + </tr> + <tr> + <td><h5>zookeeper.znode.parent</h5></td> + <td>optional</td> + <td style="word-wrap: break-word;">/hbase</td> + <td>String</td> + <td>The root dir in Zookeeper for HBase cluster</td> + </tr> + <tr> + <td><h5>null-string-literal</h5></td> + <td>optional</td> + <td style="word-wrap: break-word;">null</td> + <td>String</td> + <td>Representation for null values for string fields. HBase source and sink encodes/decodes empty bytes as null values for all types except string type.</td> + </tr> + <tr> + <td><h5>sink.buffer-flush.max-size</h5></td> + <td>optional</td> + <td style="word-wrap: break-word;">2mb</td> + <td>MemorySize</td> + <td>Writing option, determines how many size in memory of buffered rows to insert per round trip. + This can improve performance for writing data to HBase database, but may increase the latency. + </td> + </tr> + <tr> + <td><h5>sink.buffer-flush.max-rows</h5></td> + <td>optional</td> + <td style="word-wrap: break-word;">(none)</td> + <td>Integer</td> + <td>Writing option, determines how many number of rows to insert per round trip. + This can improve performance for writing data to HBase database, but may increase the latency. Review comment: I changed this to `maximum number of rows to buffer for each writing request`. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
