All Products
Search

This Product

    Lindorm:Install the HBase SDK

    Document Center

    Lindorm:Install the HBase SDK

    Last Updated:Mar 30, 2026

    To connect to LindormTable, install the ApsaraDB for HBase SDK for your language. The following instructions apply to the Java SDK. For C++, Python, and Go, see Use ApsaraDB for HBase SDK for a non-Java language to connect to LindormTable.

    Prerequisites

    Before you begin, ensure that you have:

    • Java Development Kit (JDK) V1.8 or later

    Important

    ApsaraDB for HBase SDK for Java does not support JDK 17. If you are running JDK 17, switch to a supported version before proceeding.

    Choose your SDK version

    The SDK version follows the same major version line as your existing open source HBase client:

    Current HBase client SDK dependency to add
    Open source HBase 1.x ApsaraDB for HBase 1.x (alihbase-client 1.8.8)
    Open source HBase 2.x ApsaraDB for HBase 2.x (alihbase-client 2.8.7)

    If this is a first-time installation (no existing HBase client), use the latest version in the lineage that matches your project's target HBase API. For example, if you are building against HBase 1.x APIs and the latest ApsaraDB for HBase version is 1.8.8, install 1.8.8.

    Note

    If your environment does not support the ApsaraDB for HBase client, or you typically connect to LindormTable through Hive, Spark, or Flink, use an open source HBase client instead. See Limitations when using an open source HBase client before proceeding.

    Add the Maven dependency

    Add the dependency that matches your SDK version to pom.xml.

    HBase 1.x — Maven:

    <dependency>
  <groupId>com.aliyun.hbase</groupId>
  <artifactId>alihbase-client</artifactId>
  <version>1.8.8</version>
</dependency>

    HBase 2.x — Maven:

    <dependency>
  <groupId>com.aliyun.hbase</groupId>
  <artifactId>alihbase-client</artifactId>
  <version>2.8.7</version>
</dependency>

    Next steps

    After installation, connect to LindormTable and start building:

    Important

    The ApsaraDB for HBase API for Java cannot access SQL tables. Verify your data table type before connecting.

    Limitations when using an open source HBase client

    If you use an open source HBase client instead of the ApsaraDB for HBase SDK, be aware of the following constraints:

    • VPC only: You can connect to LindormTable only through a virtual private cloud (VPC). Internet connections are not supported.

    • Single-zone instances only: Open source HBase clients cannot connect to Lindorm instances deployed across multiple zones.

    • Performance impact: Protocol conversion between the open source HBase protocol and LindormTable's native protocol may reduce performance.

    • Unavailable features: The following LindormTable features are not available: compressed transmission, request authentication, Access Control List (ACL), end-to-end tracing, and client configuration pushing and optimization.

    • LindormTable version requirement: LindormTable must be version 2.6.2.8 or later. To upgrade, see Upgrade the minor engine version of a Lindorm instance.

    • Client version range: The open source HBase client version must be 0.98 to 2.x.

    See also