Tencent Cloud

Recent Pages

Lite HBase Instructions

Last updated: 2024-11-28 16:22:16
Overview
Access the EMR Serverless HBase instance via Shell, Java, and Golang for table creation and queries.
Preparations
An EMR Serverless HBase instance has been created and is in the running status.
A CVM instance sharing the same VPC and same subnet with the EMR Serverless HBase instance has been created (hereinafter referred to as the CVM client).
The Java environment has been installed, and environment variables have been configured on the CVM client. A JDK version 1.8 or above can be installed as required. If it is not installed, obtain the installation address and configure Java environment .
The Zookeeper address of the Serverless HBase instance has been obtained from the EMR Serverless HBase instance information page.
Note:
For more information on using the HBase API, see the Apache HBase official website: https://hbase.apache.org/2.4/apidocs/index.html
Using HBase Shell
Configuring Environment
1. Log in to the CVM client, then download the HBase client, extract it, and switch to the emr-serverless-hbase-client directory.
cd /usr/local
wget https://emr-serverless-hbase-1259353343.cos.ap-guangzhou.myqcloud.com/client/emr-serverless-hbase-client.tar.gz
tar -zxvf emr-serverless-hbase-client.tar.gz
cd emr-serverless-hbase-client
2. Modify the hbase.zookeeper.quorum parameter configuration in conf/hbase-site.xml. $quorum is the Zookeeper address.
vi conf/hbase-site.xml 
<property>
       <name>hbase.zookeeper.quorum</name>
        <value>$quorum</value>
</property>
HBase Basic Operations
1. Use the following command to enter the HBase Shell.
./bin/hbase shell
2. In the HBase Shell, type help to view basic usage information and example commands. You can use the following command to create a table.
hbase:001:0> create 'test', 'cf'
Created table test
Took 1.5703 seconds                                                                                                                    
=> Hbase::Table - test
3. After the table is created, you can use the list command to check if the table you created exists.
hbase:002:0> list 'test'
TABLE                                                                                                                                  
test                                                                                                                                   
1 row(s)
Took 0.0158 seconds   
=> ["test"]
4. Use the put command to add data to the table you created. Three values were inserted into the table you created. The first value "value1" was inserted into the column "cf:a" of the row "row1", and so forth.
hbase:003:0> put 'test', 'row1', 'cf:a', 'value1'
Took 0.1766 seconds                                                                                                                    
hbase:004:0> put 'test', 'row2', 'cf:b', 'value2'
Took 0.0160 seconds                                                                                                                    
hbase:005:0> put 'test', 'row3', 'cf:c', 'value3'
Took 0.0149 seconds    
5. Use the scan command to scan the entire table.
hbase:006:0> scan 'test'
ROW                                COLUMN+CELL                                                                                        
 row1                               column=cf:a, timestamp=2024-07-16T10:56:28.027, value=value1                                        
 row2                               column=cf:b, timestamp=2024-07-16T10:56:40.658, value=value2                                        
 row3                               column=cf:c, timestamp=2024-07-16T10:56:51.744, value=value3                                        
3 row(s)
Took 0.0682 seconds     
6. Use the get command to retrieve the value of a specified row in the table.
hbase:007:0> get 'test', 'row1'
COLUMN                              CELL                                                                                               
 cf:a                              timestamp=2024-07-16T10:56:28.027, value=value1                                                    
1 row(s)
Took 0.0361 seconds  
7. Use the drop command to delete a table. Before deleting it, you need to use the disable command to disable the table.
hbase:008:0> disable 'test'
Took 0.6919 seconds                                                                                                                    
hbase:009:0> drop 'test'
Took 0.3451 seconds   
8. Finally, you can use the exit command to close the HBase shell.
Using the Java API
Ensure that an appropriate JDK version is available in the development environment, and install and configure Maven's environment variables. If you are using an IDE, set the Maven-related configurations in the IDE. If needed, use the Tencent Cloud image source to accelerate Maven, and add the following repository mirror to the Maven configuration file settings.xml.
<mirror>
    <id>nexus-tencentyun</id>
    <mirrorOf>*</mirrorOf>
    <name>Nexus tencentyun</name>
   <url>http://mirrors.cloud.tencent.com/nexus/repository/maven-public/</url>
</mirror> 
Creating a Maven Project
Enter the directory where you want to create the project on the command line and run the following command to create a Maven project.
mvn archetype:generate -DgroupId=com.tencent.cloud-DartifactId=test-serverless-hbase -Dversion=1.0 -DarchetypeArtifactId=maven-archetype-quickstart-DarchetypeVersion=1.1
After creation, a project folder named test-serverless-hbase will be generated in the project directory. The file structure within is as follows. The pom.xml file is mainly used for dependency management and packaging configuration, while the Java folder contains your source code.
test-serverless-hbase
├── pom.xml
└── src
    ├── main
    │  └── java
    │      └── com
    │          └── tencent
    │               └── cloud
    │                   └── App.java
    └── test
        └── java
            └── com
                └── tencent
                    └── cloud
                        └── AppTest.java
Adding Configuration and Sample Code
Add Maven dependency, packaging, and compilation plugins to the pom.xml file.
<dependencies>
    <!-- https://mvnrepository.com/artifact/org.apache.hbase/hbase-client -->
    <dependency>
       <groupId>org.apache.hbase</groupId>
       <artifactId>hbase-client</artifactId>
        <version>2.4.5</version>
    </dependency>
 
    <!-- https://mvnrepository.com/artifact/log4j/log4j -->
    <dependency>
        <groupId>log4j</groupId>
       <artifactId>log4j</artifactId>
        <version>1.2.17</version>
    </dependency>
</dependencies>
<build>
    <plugins>
        <plugin>
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-compiler-plugin</artifactId>
           <version>3.10.1</version>
            <configuration>
                <source>8</source>
                <target>8</target>
               <encoding>utf-8</encoding>
            </configuration>
        </plugin>
        <plugin>
           <artifactId>maven-assembly-plugin</artifactId>
            <configuration>
                <descriptorRefs>
                   <descriptorRef>jar-with-dependencies</descriptorRef>
                </descriptorRefs>
                <archive>
                    <manifest>
                        <!-- Specify the class containing the main method entry point here. -->
                       <mainClass>com.tencent.cloud.App</mainClass>
                    </manifest>
                </archive>
            </configuration>
            <executions>
                <execution>
                   <id>make-assembly</id>
                   <phase>package</phase>
                    <goals>
                       <goal>single</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>
[Optional] If you encounter sample execution failures during debugging and need to obtain logs from standard output to pinpoint errors, or if you wish to save operation logs to the specified directory target/serverless-hbase.log, you can create a Java configuration directory named resources under the main folder, create a log4j.properties file within it, and add configuration details for the log4j log information printing module in the log4j.properties file.
log4j.rootLogger=INFO, stdout
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d %p [%c] - %m%n
log4j.appender.logfile=org.apache.log4j.FileAppender
log4j.appender.logfile.File=target/serverless-hbase.log
log4j.appender.logfile.layout=org.apache.log4j.PatternLayout
log4j.appender.logfile.layout.ConversionPattern=%d %p [%c] - %m%n
Sample code in App.java is as follows.
package com.tencent.cloud;
 
import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.hbase.*;
import org.apache.hadoop.hbase.client.*;
import org.apache.hadoop.hbase.util.Bytes;
 
import java.io.IOException;
 
/**
 * Access the serverless HBase instance through the HBase Java API.
 */
public class App {
    public static void main(String[] args) throws IOException {
        // Obtain $quorum from the Zookeeper access address found in the access method module under the instance information page of the console.
        // Example: conf.set("hbase.zookeeper.quorum", "10.0.0.8,10.0.0.11,10.0.0.5");
        Configuration conf = HBaseConfiguration.create();
       conf.set("hbase.zookeeper.quorum", "$quorum");
 
        // Establish a connection between the EMR Serverless HBase client and the data.
        Connection connection = ConnectionFactory.createConnection(conf);
        Admin admin = connection.getAdmin();
 
        // Once the connection is established, you can access the serverless HBase instance using the HBase Java API.
        TableDescriptorBuilder tableBuilder = TableDescriptorBuilder.newBuilder(TableName.valueOf("test1"));
        ColumnFamilyDescriptor cf = ColumnFamilyDescriptorBuilder.of("cf");
        tableBuilder.setColumnFamily(cf);
        TableDescriptor table = tableBuilder.build();
 
        System.out.println("Creating Table.");
        if (admin.tableExists(table.getTableName())) {
           admin.disableTable(table.getTableName());
           admin.deleteTable(table.getTableName());
        }
        admin.createTable(table);
        System.out.println("Inserting Data.");
        Table table1 = connection.getTable(TableName.valueOf("test1"));
        Put put1 = new Put(Bytes.toBytes("row1"));
       put1.addColumn(Bytes.toBytes("cf"), Bytes.toBytes("a"),
               Bytes.toBytes("value1"));
Compiling Code and Packaging It for Upload
Use the local command line to enter the project directory and execute the following command to compile and package the project.
mvn package
The log printing build success indicates that the operation was successful. You can find the packaged JAR file in the target folder of the project directory. You need to upload the JAR file with the with-dependencies suffix to the CVM client using the file upload feature in the CVM instance console.
If the CVM client can be accessed via public IP address, you can also run the following command in the local command line mode to upload the file.
scp $localfile root@public IP address:$remotefolder
Here, $localfile is the path and the name of your local file; root is the username of the CVM server. You can look up the public IP address in the CVM client console. $remotefolder is the path where you want to store the file in the CVM server. After completing the upload, you can check whether the file is in the corresponding folder on the CVM client command line.
Executing the Sample and Checking the Results
Log in to the CVM client, switch to the corresponding folder, and use the following command to execute the sample.
java –jar $package.jar
After executing the code, if Done is output in the console, it indicates that all operations are completed. You can switch to the HBase shell and use the list command to check if the HBase table created using the API is successful. If successful, you can use the scan command to view the specific contents of the table.
hbase:001:0> list 'test1'
TABLE                                                                                                                                                                                     
test1                                                                                                                                                                                     
1 row(s)
Took 0.4315 seconds                                                                                                                                                                       
=> ["test1"]
hbase:002:0> scan 'test1'
ROW                                            COLUMN+CELL                                                                                                                               
 row1                                          column=cf:a, timestamp=2024-07-16T16:20:38.685, value=value1                                                                              
 row2                                          column=cf:b, timestamp=2024-07-16T16:20:38.690, value=value2                                                                              
 row3                                          column=cf:c, timestamp=2024-07-16T16:20:38.695, value=value3                                                                              
3 row(s)
Took 0.1231 seconds                                                                                                                                                                       
hbase:003:0> exit
Using the Golang API
Adding Environment and Sample Code
On the CVM client, install Golang and configure the environment variables. Take version go1.17.13 as an example.
cd /usr/local
wget https://go.dev/dl/go1.17.13.linux-amd64.tar.gz
tar -zxvf go1.17.13.linux-amd64.tar.gz
vi /etc/profile
 
Append to /etc/profile
export GO_HOME=/usr/local/go
export PATH=${GO_HOME}/bin:$PATH
Save and return to the command line.
 
source /etc/profile
Ensure that the Golang version is consistent in the development environment. Enter the project directory, and if there is no go.mod file in the project directory, execute the following command.
go mod init test-serverless-hbase
Download the appropriate gohbase dependency branch for the Golang version by (viewing the gohbase project address).
Golang Version
commit_id
1.22.x
731f0bdb6be56dfe0b5a5a79582161bc7fbed32b
1.18.x~1.21.x
1fee39f343954ca7501a6b8f25abd9f86eaf618b
1.13.x~1.17.x
05795eede1cb2442e6cc0313db93a4b544b49148
﻿
You can view more Golang version-specific commits in Commits · tsuna/gohbase · GitHub.
go env -w GOPROXY=https://goproxy.cn
go get github.com/tsuna/gohbase@commit_id
# Taking Version 1.17.13 as an Example: go get github.com/tsuna/gohbase@05795eede1cb2442e6cc0313db93a4b544b49148
Create a sample code file demo.go in the project directory. The project directory structure is as follows.
test-serverless-hbase/
├── demo.go
├── go.mod
└── go.sum
The sample code for demo.go is as follows.
package main
 
import (
         "context"
         "fmt"
         "github.com/tsuna/gohbase"
         "github.com/tsuna/gohbase/hrpc"
         "log"
)
 
func main() {
         // Obtain $quorum from the Zookeeper access address found in the access method module under the instance information page of the console.
         // Example: quorum := "10.0.0.8,10.0.0.11,10.0.0.5" 
         quorum := $quorum
         // Creating Table.
         tableName := "test2"
         var cfs = map[string]map[string]string{
                  "cf1": {
                          "MIN_VERSIONS": "1",
                  },
         }
         admin := gohbase.NewAdminClient(quorum)
         crt := hrpc.NewCreateTable(context.Background(), []byte(tableName), cfs)
         err := admin.CreateTable(crt)
         if err != nil {
                  log.Fatal(err)
         }
 
         client := gohbase.NewClient(quorum)
 
         // Write data.
         putRequest, err := hrpc.NewPutStr(context.Background(), tableName, "my_row_key", map[string]map[string][]byte{
                  "cf1": map[string][]byte{
                          "col1": []byte("value1"),
                          "col2": []byte("value2"),
                  },
         })
         if err != nil {
                  log.Fatal(err)
         }
Compiling Code and Packaging It for Upload
If your current development environment is a Linux environment, execute the following command in the command line.
go build demo.go
If it is a non-Linux environment, execute the following command, package it into a Linux file, and then switch back to the original environment to ensure other files compiled normally.
go env -w GOOS=linux
go build demo.go
In the project directory, you can see the compiled binary file named demo. Upload this file to the CVM client using the file upload feature in the CVM instance console.
If the CVM client can be accessed via public IP address, you can also run the following command in the local command line mode to upload the file.
scp $localfile root@public IP address:$remotefolder
Here, $localfile is the path and the name of your local file; root is the username of the CVM server. You can look up the public IP address in the CVM client console. $remotefolder is the path where you want to store the file in the CVM server. After completing the upload, you can check whether the file is in the corresponding folder on the CVM client command line.
Executing the Sample and Checking the Results
Switch to the target directory where the file is located, grant the permission to execute to this binary file, and execute it.
chmod +x demo
./demo
After running the code, switch to the HBase shell and check whether the HBase table created by using the API is successful via the list command. If successful, you can use the scan command to view the specific contents of the table.
hbase:001:0> list 'test2'
TABLE                                                                                                                            
test2                                                                                                                            
1 row(s)
Took 0.3814 seconds                                                                                                              
=> ["test2"]
hbase:002:0> scan 'test2'
ROW                               COLUMN+CELL                                                                                    
 my_row_key                       column=cf1:col1, timestamp=2024-07-17T21:16:49.302, value=value1                                
 my_row_key                       column=cf1:col2, timestamp=2024-07-17T21:16:49.302, value=value2                                
1 row(s)
Took 0.1268 seconds                                                                                                              
hbase:003:0> exit
﻿
﻿
Contact Us
Contact our sales team or business advisors to help your business.
Technical Support
Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.
7x24 Phone Support
tencent cloud

Recent Pages

Lite HBase Instructions

Overview

Preparations

Using HBase Shell

Configuring Environment

HBase Basic Operations

Using the Java API

Creating a Maven Project

Adding Configuration and Sample Code

Compiling Code and Packaging It for Upload

Executing the Sample and Checking the Results

Using the Golang API

Adding Environment and Sample Code

Compiling Code and Packaging It for Upload

Executing the Sample and Checking the Results

Was this page helpful?

Was this page helpful?

Golang Version	commit_id
1.22.x	731f0bdb6be56dfe0b5a5a79582161bc7fbed32b
1.18.x~1.21.x	1fee39f343954ca7501a6b8f25abd9f86eaf618b
1.13.x~1.17.x	05795eede1cb2442e6cc0313db93a4b544b49148
tencent cloud

Sign Up

Log in

Recent Pages

Lite HBase Instructions

Overview

Preparations

Using HBase Shell

Configuring Environment

HBase Basic Operations

Using the Java API

Creating a Maven Project

Adding Configuration and Sample Code

Compiling Code and Packaging It for Upload

Executing the Sample and Checking the Results

Using the Golang API

Adding Environment and Sample Code

Compiling Code and Packaging It for Upload

Executing the Sample and Checking the Results

Was this page helpful?

Was this page helpful?
