> For the complete documentation index, see [llms.txt](https://docs.selfuel.digital/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.selfuel.digital/data-integration-with-nexus/nexus-elements/connectors/source/hbase.md).

# Hbase

> Hbase Source Connector

### Description[​](https://seatunnel.apache.org/docs/2.3.7/connector-v2/source/Hbase#description) <a href="#description" id="description"></a>

Reads data from Apache Hbase.

### Key Features[​](https://seatunnel.apache.org/docs/2.3.7/connector-v2/source/Hbase#key-features) <a href="#key-features" id="key-features"></a>

* [x] &#x20;batch
* [ ] &#x20;stream
* [ ] &#x20;exactly-once
* [x] &#x20;schema projection
* [x] &#x20;parallelism
* [ ] &#x20;support user-defined split

### Options[​](https://seatunnel.apache.org/docs/2.3.7/connector-v2/source/Hbase#options) <a href="#options" id="options"></a>

| Name                 | Type    | Required | Default |
| -------------------- | ------- | -------- | ------- |
| zookeeper\_quorum    | string  | Yes      | -       |
| table                | string  | Yes      | -       |
| schema               | config  | Yes      | -       |
| hbase\_extra\_config | string  | No       | -       |
| caching              | int     | No       | -1      |
| batch                | int     | No       | -1      |
| cache\_blocks        | boolean | No       | false   |
| common-options       |         | No       | -       |

#### zookeeper\_quorum \[string][​](https://seatunnel.apache.org/docs/2.3.7/connector-v2/source/Hbase#zookeeper_quorum-string) <a href="#zookeeper_quorum-string" id="zookeeper_quorum-string"></a>

The zookeeper quorum for Hbase cluster hosts, e.g., "hadoop001:2181,hadoop002:2181,hadoop003:2181".

#### table \[string][​](https://seatunnel.apache.org/docs/2.3.7/connector-v2/source/Hbase#table-string) <a href="#table-string" id="table-string"></a>

The name of the table to write to, e.g., "nexus".

#### schema \[config][​](https://seatunnel.apache.org/docs/2.3.7/connector-v2/source/Hbase#schema-config) <a href="#schema-config" id="schema-config"></a>

Hbase stores data in byte arrays. Therefore, you need to configure the data types for each column in the table. For more information, see: [Schema Feature](/data-integration-with-nexus/nexus-elements/concept/schema-feature.md).

#### hbase\_extra\_config \[config][​](https://seatunnel.apache.org/docs/2.3.7/connector-v2/source/Hbase#hbase_extra_config-config) <a href="#hbase_extra_config-config" id="hbase_extra_config-config"></a>

Additional configurations for Hbase.

#### caching[​](https://seatunnel.apache.org/docs/2.3.7/connector-v2/source/Hbase#caching) <a href="#caching" id="caching"></a>

The caching parameter sets the number of rows fetched per server trip during scans. This reduces round-trips between client and server, improving scan efficiency. Default: -1.

#### batch[​](https://seatunnel.apache.org/docs/2.3.7/connector-v2/source/Hbase#batch) <a href="#batch" id="batch"></a>

The batch parameter sets the maximum number of columns returned per scan. This is useful for rows with many columns to avoid fetching excessive data at once, thus saving memory and improving performance.

#### cache\_blocks[​](https://seatunnel.apache.org/docs/2.3.7/connector-v2/source/Hbase#cache_blocks) <a href="#cache_blocks" id="cache_blocks"></a>

The cache\_blocks parameter determines whether to cache data blocks during scans. By default, HBase caches data blocks during scans. Setting this to false reduces memory usage during scans. Default in Nexus: false.

#### common-options[​](https://seatunnel.apache.org/docs/2.3.7/connector-v2/source/Hbase#common-options) <a href="#common-options" id="common-options"></a>

Common parameters for Source plugins, refer to [Source Common Options](/data-integration-with-nexus/nexus-elements/connectors/source/source-common-options.md).

### Example[​](https://seatunnel.apache.org/docs/2.3.7/connector-v2/source/Hbase#example) <a href="#example" id="example"></a>

```
source {
  Hbase {
    zookeeper_quorum = "hadoop001:2181,hadoop002:2181,hadoop003:2181" 
    table = "nexus_test" 
    caching = 1000 
    batch = 100 
    cache_blocks = false 
    schema = {
      columns = [
        { 
          name = "rowkey" 
          type = string 
        },
        {
          name = "columnFamily1:column1"
          type = boolean
        },
        {
          name = "columnFamily1:column2" 
          type = double
        },
        {
          name = "columnFamily2:column1"
          type = bigint
        }
      ]
    }
  }
}
```