Java libraries and HBase client extensions for accessing Google Cloud Bigtable
Java
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Google Cloud Bigtable HBase client for Java

Travis CI status Maven Stack Overflow

Google Cloud Bigtable is Google's NoSQL Big Data database service. It's the same database that powers many core Google services, including Search, Analytics, Maps, and Gmail.

Bigtable is designed to handle massive workloads at consistent low latency and high throughput, so it's a great choice for both operational and analytical applications, including IoT, user analytics, and financial data analysis.

Bigtable provisions and scales to hundreds of petabytes automatically, and can smoothly handle millions of operations per second. Changes to the deployment configuration are immediate, so there is no downtime during reconfiguration.

Bigtable integrates easily with popular Big Data tools like Hadoop, as well as Google Cloud Platform products like Cloud Dataflow and Dataproc. Plus, Bigtable supports the open-source, industry-standard HBase API, which makes it easy for development teams to get started.

Project setup, installation, and configuration

Prerequisites

Using the Java client

  • Add the appropriate Cloud Bigtable artifact dependencies to your Maven project.

    • bigtable-hbase-1.x: use for standalone applications where you are in control your dependencies.
    • bigtable-hbase-1.x-hadoop: use in hadoop environments
    • bigtable-hbase-1.x-mapreduce: use for map/reduce utilities
    • bigtable-hbase-1.x-shaded: use in environments (other than hadoop) that require older versions of protobuf, guava, etc.
    • bigtable-hbase-2.x: use for standalone applications where you are in control your dependencies. This includes an HBase async client.
    • bigtable-hbase-2.x-hadoop: use in hadoop environments
    • bigtable-hbase-2.x-shaded: use in environments (other than hadoop) that require older versions of protobuf, guava, etc.

    Maven:

    <dependency>
      <groupId>com.google.cloud.bigtable</groupId>
      <artifactId>bigtable-hbase-1.x</artifactId>
      <version>1.4.0</version>
    </dependency>

    Gradle:

    compile 'com.google.cloud.bigtable:bigtable-hbase-1.x:1.4.0'

    SBT:

    libraryDependencies += "com.google.cloud.bigtable" % "bigtable-hbase-1.x" % "1.4.0"
  • Refer to the Java samples documentation for detailed demonstrations of how to read and write data with Cloud Bigtable. The code for these samples is available in the Cloud Bigtable examples project.

Questions and discussions

If you have questions or run into issues with Google Cloud Bigtable or the client libraries, you can use any of the following forums:

You can also subscribe to google-cloud-bigtable-announce@ list to receive infrequent product and client library announcements.

Developing and testing

  1. Running mvn clean install will build and install Cloud Bigtable client artifacts to your local repository, and then run the unit tests.

  2. There is also a suite of integration tests that connect to a cluster you have access to via the authentication credentials that were loaded via the Google Cloud SDK configuration step (see above).

    Use the following command to run the Cloud Bigtable integration tests for HBase 1:

    mvn clean integration-test \
        -PbigtableIntegrationTest \
        -Dgoogle.bigtable.project.id=[your cloud project id] \
        -Dgoogle.bigtable.instance.id=[your cloud bigtable instance id]

    Use the following command to run the Cloud Bigtable integration tests for HBase 2:

    mvn clean integration-test \
        -PbigtableIntegrationTestH2 \
        -Dgoogle.bigtable.project.id=[your cloud project id] \
        -Dgoogle.bigtable.instance.id=[your cloud bigtable instance id]

    There are also tests that perform compatibility tests against an HBase Minicluster, which can be invoked with the following commands for HBase 1 and HBase 2 respectively:

    mvn clean integration-test -PhbaseLocalMiniClusterTest
    mvn clean integration-test -PhbaseLocalMiniClusterTestH2

    You can run those commands at the top of the project, or you can run then at the appropriate integration-tests project.

    Developer's NOTE: You can build the project faster by running the following command, and then run the integration test command from the appropriate integration test directory:

    mvn -pl bigtable-hbase-1.x-parent/bigtable-hbase-1.x-integration-tests \
    -pl bigtable-hbase-2.x-parent/bigtable-hbase-2.x-integration-tests \
    -am clean install

NOTE: This project uses extensive shading which IDEs have trouble with. To over come these issues, you can disable the with-shaded profile in your IDE to force it to resolve the dependencies from your local maven repository. When you disable that profile, you have to attach workspace sources to local maven repository jars.

Contributing changes

See CONTRIBUTING.md for more information on how to contribute to this project.

License

Apache 2.0; see LICENSE for details.