General Usage and Invocation

HBCK2 is typically run as a Java JAR file using the hbase command-line utility.

The general syntax for invoking HBCK2 is:

${HBASE_HOME}/bin/hbase --config <CONF_DIR> hbck -j <PATH_TO_HBCK2_JAR> [OPTIONS] COMMAND <ARGS>

Option	Description
${HBASE_HOME}/bin/hbase	The HBase command-line script.
--config <CONF_DIR>	(Optional) Specifies the directory containing HBase configuration files (e.g., /etc/hbase-conf).
hbck	The HBase subcommand used to invoke HBCK (version 2 in this case).
-j <PATH_TO_ HBCK2_JAR>	Specifies the path to the HBCK2 JAR file (e.g., ~/hbase-operator-tools/hbase-hbck2/target/hbase-hbck2-1.0.0-SNAPSHOT.jar).

Once invoked correctly, the command structure for HBCK2 itself follows:

hbase hbck -j <path to Hbck2 Jar> [OPTIONS] COMMAND <ARGS>

These options can be used with any HBCK2 command.

Option	Description
-d, --debug	Run with debug output.
-h, --help	Output this help message.
-p, --hbase.zookeeper.property.clientPort <arg>	Specify the client port of the HBase ZooKeeper ensemble.
-q, --hbase.zookeeper.quorum <arg>	Specify the HBase ZooKeeper ensemble (e.g., host1,host2,host3)
-s, --skip	Skip HBase version check (PleaseHoldException). Use with extreme caution, especially during Master initialization, as it can bypass critical compatibility checks.
-v, --version	Display the HBCK2 version.
-z, --zookeeper.znode.parent <arg>	Specify the parent znode of the HBase ZooKeeper ensemble (e.g., /hbase).

Last updated on Nov 13, 2025

Was this page helpful?