HBase
Read and write Apache HBase tables through its REST server: rows as MQL rows, scans by range, prefix or column, counts, updates and deletes. Typical uses: read big data tables, load rows into HBase.
hbase pinghbase infohbase databaseshbase collection_createhbase collection_createhbase collectionshbase collection_infohbase inserthbase inserthbase puthbase puthbase gethbase gethbase findhbase findhbase counthbase counthbase updatehbase updatehbase deletehbase deletehbase delete_wherehbase requesthbase requesthbase collection_drop

hbase ping <config>


Description

    Test the connection: {ok, version} (the version of the cluster)

Parameters

    config:   The HBase REST server configuration as JSON: url (http://127.0.0.1:8080; the REST server is started by hbase rest start), username and password (the name of a secret: secret set) for a gateway with basic authentication (Knox...), ca_file (a PEM file of a private CA, with https), allow_plain (false: a password over http is refused unless the host is localhost), timeout_ms (30000), max_bytes (64 MB, the largest answer) - String - required
admin
hbase ping "{\"url\": \"http://127.0.0.1:8080\"}"
mentdb
{"ok": true, "version": "2.6.7"}

hbase info <config>


Description

    The cluster: {cluster, rest, jvm, os, regions, requests, average_load, live_nodes, dead_nodes}

Parameters

    config:   The HBase REST server configuration as JSON: url (http://127.0.0.1:8080; the REST server is started by hbase rest start), username and password (the name of a secret: secret set) for a gateway with basic authentication (Knox...), ca_file (a PEM file of a private CA, with https), allow_plain (false: a password over http is refused unless the host is localhost), timeout_ms (30000), max_bytes (64 MB, the largest answer) - String - required
admin
hbase info "{\"url\": \"http://127.0.0.1:8080\"}"
mentdb
{"cluster": "2.6.7", "rest": "0.0.3", "jvm": "Eclipse Adoptium 11.0.26-11.0.26+4", "os": "Mac OS X 14.4 aarch64", "regions": 2, "requests": 138, "average_load": 2, "live_nodes": 1, "dead_nodes": 0}

hbase databases <config>


Description

    The namespaces

Parameters

    config:   The HBase REST server configuration as JSON: url (http://127.0.0.1:8080; the REST server is started by hbase rest start), username and password (the name of a secret: secret set) for a gateway with basic authentication (Knox...), ca_file (a PEM file of a private CA, with https), allow_plain (false: a password over http is refused unless the host is localhost), timeout_ms (30000), max_bytes (64 MB, the largest answer) - String - required
admin
hbase databases "{\"url\": \"http://127.0.0.1:8080\"}"
mentdb
["default", "hbase"]

hbase collection_create <config> <table>


Description

    Create a table with one column family cf (an existing table gets the families again). Returns {created}

Parameters

    config:   The HBase REST server configuration as JSON: url (http://127.0.0.1:8080; the REST server is started by hbase rest start), username and password (the name of a secret: secret set) for a gateway with basic authentication (Knox...), ca_file (a PEM file of a private CA, with https), allow_plain (false: a password over http is refused unless the host is localhost), timeout_ms (30000), max_bytes (64 MB, the largest answer) - String - required
    table:   The table, with its namespace if it is not default (sales:orders) - String - required
admin
hbase collection_create "{\"url\": \"http://127.0.0.1:8080\"}" "events"
mentdb
{"created": "events"}

hbase collection_create <config> <table> <options_json>


Description

    Create a table with options: families (names, or objects with name and attributes VERSIONS, TTL, COMPRESSION, BLOOMFILTER, IN_MEMORY, BLOCKCACHE, BLOCKSIZE, MIN_VERSIONS, KEEP_DELETED_CELLS, DATA_BLOCK_ENCODING, REPLICATION_SCOPE)

Parameters

    config:   The HBase REST server configuration as JSON: url (http://127.0.0.1:8080; the REST server is started by hbase rest start), username and password (the name of a secret: secret set) for a gateway with basic authentication (Knox...), ca_file (a PEM file of a private CA, with https), allow_plain (false: a password over http is refused unless the host is localhost), timeout_ms (30000), max_bytes (64 MB, the largest answer) - String - required
    table:   The table, with its namespace if it is not default (sales:orders) - String - required
    options_json:   The options - String - required
admin
hbase collection_create "{\"url\": \"http://127.0.0.1:8080\"}" "customers" "{\"families\": [\"info\", {\"name\": \"hist\", \"VERSIONS\": 3}]}"
mentdb
{"created": "customers"}

hbase collections <config>


Description

    The tables (with their namespace when it is not default)

Parameters

    config:   The HBase REST server configuration as JSON: url (http://127.0.0.1:8080; the REST server is started by hbase rest start), username and password (the name of a secret: secret set) for a gateway with basic authentication (Knox...), ca_file (a PEM file of a private CA, with https), allow_plain (false: a password over http is refused unless the host is localhost), timeout_ms (30000), max_bytes (64 MB, the largest answer) - String - required
admin
hbase collections "{\"url\": \"http://127.0.0.1:8080\"}"
mentdb
["customers", "events"]

hbase collection_info <config> <table>


Description

    The schema of a table: {name, families: [{name, VERSIONS, TTL, COMPRESSION...}], ...}

Parameters

    config:   The HBase REST server configuration as JSON: url (http://127.0.0.1:8080; the REST server is started by hbase rest start), username and password (the name of a secret: secret set) for a gateway with basic authentication (Knox...), ca_file (a PEM file of a private CA, with https), allow_plain (false: a password over http is refused unless the host is localhost), timeout_ms (30000), max_bytes (64 MB, the largest answer) - String - required
    table:   The table, with its namespace if it is not default (sales:orders) - String - required
admin
hbase collection_info "{\"url\": \"http://127.0.0.1:8080\"}" "customers"
mentdb
{"name": "customers", "families": [{"name": "hist", "INDEX_BLOCK_ENCODING": "NONE", "VERSIONS": "3", "KEEP_DELETED_CELLS": "FALSE", "DATA_BLOCK_ENCODING": "NONE", "TTL": "2147483647", "MIN_VERSIONS": "0", "REPLICATION_SCOPE": "0", "BLOOMFILTER": "ROW", "IN_MEMORY": "false", "COMPRESSION": "NONE", "BLOCKCACHE": "true", "BLOCKSIZE": "65536"}, {"name": "info", "INDEX_BLOCK_ENCODING": "NONE", "VERSIONS": "1", "KEEP_DELETED_CELLS": "FALSE", "DATA_BLOCK_ENCODING": "NONE", "TTL": "2147483647", "MIN_VERSIONS": "0", "REPLICATION_SCOPE": "0", "BLOOMFILTER": "ROW", "IN_MEMORY": "false", "COMPRESSION": "NONE", "BLOCKCACHE": "true", "BLOCKSIZE": "65536"}], "IS_META": "false", "hbase.store.file-tracker.impl": "DEFAULT"}

hbase insert <config> <table> <rows_json>


Description

    Write MQL rows: the row key in the field row, the cells in family:qualifier fields (null values skipped). One request per 1000 rows. Returns {inserted, errors}

Parameters

    config:   The HBase REST server configuration as JSON: url (http://127.0.0.1:8080; the REST server is started by hbase rest start), username and password (the name of a secret: secret set) for a gateway with basic authentication (Knox...), ca_file (a PEM file of a private CA, with https), allow_plain (false: a password over http is refused unless the host is localhost), timeout_ms (30000), max_bytes (64 MB, the largest answer) - String - required
    table:   The table, with its namespace if it is not default (sales:orders) - String - required
    rows_json:   The rows as a JSON array of objects - String - required
admin
hbase insert "{\"url\": \"http://127.0.0.1:8080\"}" "customers" "[{\"row\": \"c001\", \"info:name\": \"Zoé\", \"info:city\": \"Paris\", \"info:age\": 31}, {\"row\": \"c002\", \"info:name\": \"Marc\", \"info:city\": \"Lyon\", \"info:age\": 45}, {\"row\": \"c003\", \"info:name\": \"Ana\", \"info:city\": \"Paris\"}]"
mentdb
{"inserted": 3, "errors": []}

hbase insert <config> <table> <rows_json> <options_json>


Description

    Write rows with options: id_field (row), timestamp (milliseconds, the version of every cell), base64 (true: the values are given in base64, for binary data)

Parameters

    config:   The HBase REST server configuration as JSON: url (http://127.0.0.1:8080; the REST server is started by hbase rest start), username and password (the name of a secret: secret set) for a gateway with basic authentication (Knox...), ca_file (a PEM file of a private CA, with https), allow_plain (false: a password over http is refused unless the host is localhost), timeout_ms (30000), max_bytes (64 MB, the largest answer) - String - required
    table:   The table, with its namespace if it is not default (sales:orders) - String - required
    rows_json:   The rows as a JSON array of objects - String - required
    options_json:   The options - String - required
admin
hbase insert "{\"url\": \"http://127.0.0.1:8080\"}" "events" "[{\"id\": \"2026-11-17#0001\", \"cf:type\": \"login\", \"cf:user\": \"c001\"}, {\"id\": \"2026-11-17#0002\", \"cf:type\": \"order\", \"cf:user\": \"c002\"}, {\"id\": \"2026-11-18#0001\", \"cf:type\": \"login\", \"cf:user\": \"c003\"}]" "{\"id_field\": \"id\"}"
mentdb
{"inserted": 3, "errors": []}

hbase put <config> <table> <row> <document_json>


Description

    Write the cells of one row (the other cells of the row stay). Returns {id}

Parameters

    config:   The HBase REST server configuration as JSON: url (http://127.0.0.1:8080; the REST server is started by hbase rest start), username and password (the name of a secret: secret set) for a gateway with basic authentication (Knox...), ca_file (a PEM file of a private CA, with https), allow_plain (false: a password over http is refused unless the host is localhost), timeout_ms (30000), max_bytes (64 MB, the largest answer) - String - required
    table:   The table, with its namespace if it is not default (sales:orders) - String - required
    row:   The row key (UTF-8 text) - String - required
    document_json:   The cells as a JSON object {"family:qualifier": value} - String - required
admin
hbase put "{\"url\": \"http://127.0.0.1:8080\"}" "customers" "c004" "{\"info:name\": \"Léa\", \"info:city\": \"Saint-Denis\", \"info:tags\": [\"a\", \"b\"]}"
mentdb
{"id": "c004"}
a new version of a cell (fixed result: real Apache HBase 2.6.7, REST server)
admin
hbase put "{\"url\": \"http://127.0.0.1:8080\"}" "customers" "c001" "{\"hist:status\": \"new\"}"
mentdb
{"id": "c001"}
and another one (fixed result: real Apache HBase 2.6.7, REST server)
admin
hbase put "{\"url\": \"http://127.0.0.1:8080\"}" "customers" "c001" "{\"hist:status\": \"active\"}"
mentdb
{"id": "c001"}

hbase put <config> <table> <row> <document_json> <options_json>


Description

    Write one row with options: timestamp, base64

Parameters

    config:   The HBase REST server configuration as JSON: url (http://127.0.0.1:8080; the REST server is started by hbase rest start), username and password (the name of a secret: secret set) for a gateway with basic authentication (Knox...), ca_file (a PEM file of a private CA, with https), allow_plain (false: a password over http is refused unless the host is localhost), timeout_ms (30000), max_bytes (64 MB, the largest answer) - String - required
    table:   The table, with its namespace if it is not default (sales:orders) - String - required
    row:   The row key (UTF-8 text) - String - required
    document_json:   The cells as a JSON object - String - required
    options_json:   The options - String - required
admin
hbase put "{\"url\": \"http://127.0.0.1:8080\"}" "customers" "c004" "{\"info:photo\": \"iVBORw0KGgo=\"}" "{\"base64\": true}"
mentdb
{"id": "c004"}

hbase get <config> <table> <row>


Description

    Read one row: {row, family:qualifier...} with the last version of each cell; null when it does not exist

Parameters

    config:   The HBase REST server configuration as JSON: url (http://127.0.0.1:8080; the REST server is started by hbase rest start), username and password (the name of a secret: secret set) for a gateway with basic authentication (Knox...), ca_file (a PEM file of a private CA, with https), allow_plain (false: a password over http is refused unless the host is localhost), timeout_ms (30000), max_bytes (64 MB, the largest answer) - String - required
    table:   The table, with its namespace if it is not default (sales:orders) - String - required
    row:   The row key (UTF-8 text) - String - required
admin
hbase get "{\"url\": \"http://127.0.0.1:8080\"}" "customers" "c001"
mentdb
{"row": "c001", "hist:status": "active", "info:age": "31", "info:city": "Paris", "info:name": "Zoé"}
a binary value (fixed result: real Apache HBase 2.6.7, REST server)
admin
hbase get "{\"url\": \"http://127.0.0.1:8080\"}" "customers" "c004"
mentdb
{"row": "c004", "info:city": "Saint-Denis", "info:name": "Léa", "info:photo": "base64:iVBORw0KGgo=", "info:tags": "[\"a\", \"b\"]"}
no such row (fixed result: real Apache HBase 2.6.7, REST server)
admin
hbase get "{\"url\": \"http://127.0.0.1:8080\"}" "customers" "nothing"
mentdb
null

hbase get <config> <table> <row> <options_json>


Description

    Read one row with options: columns (families or family:qualifier), versions (more than 1 gives the cells), cells (true: rows {row, column, timestamp, value}), base64, id_field

Parameters

    config:   The HBase REST server configuration as JSON: url (http://127.0.0.1:8080; the REST server is started by hbase rest start), username and password (the name of a secret: secret set) for a gateway with basic authentication (Knox...), ca_file (a PEM file of a private CA, with https), allow_plain (false: a password over http is refused unless the host is localhost), timeout_ms (30000), max_bytes (64 MB, the largest answer) - String - required
    table:   The table, with its namespace if it is not default (sales:orders) - String - required
    row:   The row key (UTF-8 text) - String - required
    options_json:   The options - String - required
admin
hbase get "{\"url\": \"http://127.0.0.1:8080\"}" "customers" "c001" "{\"columns\": [\"info:name\"]}"
mentdb
{"row": "c001", "info:name": "Zoé"}
the versions of a cell (fixed result: real Apache HBase 2.6.7, REST server; the timestamps are those of the run)
admin
hbase get "{\"url\": \"http://127.0.0.1:8080\"}" "customers" "c001" "{\"columns\": [\"hist:status\"], \"versions\": 3}"
mentdb
[{"row": "c001", "column": "hist:status", "timestamp": 1794914757396, "value": "active"}, {"row": "c001", "column": "hist:status", "timestamp": 1794914757392, "value": "new"}]

hbase find <config> <table> <filter_json>


Description

    Scan the rows of a filter, 1000 rows at most

Parameters

    config:   The HBase REST server configuration as JSON: url (http://127.0.0.1:8080; the REST server is started by hbase rest start), username and password (the name of a secret: secret set) for a gateway with basic authentication (Knox...), ca_file (a PEM file of a private CA, with https), allow_plain (false: a password over http is refused unless the host is localhost), timeout_ms (30000), max_bytes (64 MB, the largest answer) - String - required
    table:   The table, with its namespace if it is not default (sales:orders) - String - required
    filter_json:   The filter as a JSON object: the range (prefix, or start_row and end_row: end excluded; start_time and end_time in milliseconds), column conditions {"info:city": "Paris"} or {"info:name": {"$gte": "M"}} with $eq $ne $gt $gte $lt $lte (comparison of the bytes, so "10" < "9"), filter (a native HBase REST filter in JSON, values in base64); {} for the whole table - String - required
admin
hbase find "{\"url\": \"http://127.0.0.1:8080\"}" "customers" "{}"
mentdb
[{"row": "c001", "hist:status": "active", "info:age": "31", "info:city": "Paris", "info:name": "Zoé"}, {"row": "c002", "info:age": "45", "info:city": "Lyon", "info:name": "Marc"}, {"row": "c003", "info:city": "Paris", "info:name": "Ana"}, {"row": "c004", "info:city": "Saint-Denis", "info:name": "Léa", "info:photo": "base64:iVBORw0KGgo=", "info:tags": "[\"a\", \"b\"]"}]
a column condition (fixed result: real Apache HBase 2.6.7, REST server)
admin
hbase find "{\"url\": \"http://127.0.0.1:8080\"}" "customers" "{\"info:city\": \"Paris\"}"
mentdb
[{"row": "c001", "hist:status": "active", "info:age": "31", "info:city": "Paris", "info:name": "Zoé"}, {"row": "c003", "info:city": "Paris", "info:name": "Ana"}]
a prefix of the row key (fixed result: real Apache HBase 2.6.7, REST server)
admin
hbase find "{\"url\": \"http://127.0.0.1:8080\"}" "events" "{\"prefix\": \"2026-11-17#\"}"
mentdb
[{"row": "2026-11-17#0001", "cf:type": "login", "cf:user": "c001"}, {"row": "2026-11-17#0002", "cf:type": "order", "cf:user": "c002"}]
a native REST filter (value in base64: c00) (fixed result: real Apache HBase 2.6.7, REST server)
admin
hbase find "{\"url\": \"http://127.0.0.1:8080\"}" "customers" "{\"filter\": {\"type\": \"PrefixFilter\", \"value\": \"YzAw\"}}"
mentdb
[{"row": "c001", "hist:status": "active", "info:age": "31", "info:city": "Paris", "info:name": "Zoé"}, {"row": "c002", "info:age": "45", "info:city": "Lyon", "info:name": "Marc"}, {"row": "c003", "info:city": "Paris", "info:name": "Ana"}, {"row": "c004", "info:city": "Saint-Denis", "info:name": "Léa", "info:photo": "base64:iVBORw0KGgo=", "info:tags": "[\"a\", \"b\"]"}]

hbase find <config> <table> <filter_json> <options_json>


Description

    Scan with options: limit (1000, 1000000 at most), columns (a condition column is read too, then left out of the rows), versions, cells, base64, batch (cells per read of the scanner, 1000), id_field. The answers of the scan are bounded by max_bytes in total

Parameters

    config:   The HBase REST server configuration as JSON: url (http://127.0.0.1:8080; the REST server is started by hbase rest start), username and password (the name of a secret: secret set) for a gateway with basic authentication (Knox...), ca_file (a PEM file of a private CA, with https), allow_plain (false: a password over http is refused unless the host is localhost), timeout_ms (30000), max_bytes (64 MB, the largest answer) - String - required
    table:   The table, with its namespace if it is not default (sales:orders) - String - required
    filter_json:   The filter as a JSON object: the range (prefix, or start_row and end_row: end excluded; start_time and end_time in milliseconds), column conditions {"info:city": "Paris"} or {"info:name": {"$gte": "M"}} with $eq $ne $gt $gte $lt $lte (comparison of the bytes, so "10" < "9"), filter (a native HBase REST filter in JSON, values in base64); {} for the whole table - String - required
    options_json:   The options - String - required
admin
hbase find "{\"url\": \"http://127.0.0.1:8080\"}" "customers" "{\"start_row\": \"c002\", \"end_row\": \"c004\"}" "{\"columns\": [\"info:name\"]}"
mentdb
[{"row": "c002", "info:name": "Marc"}, {"row": "c003", "info:name": "Ana"}]
the first two rows (fixed result: real Apache HBase 2.6.7, REST server)
admin
hbase find "{\"url\": \"http://127.0.0.1:8080\"}" "events" "{}" "{\"limit\": 2, \"id_field\": \"id\"}"
mentdb
[{"id": "2026-11-17#0001", "cf:type": "login", "cf:user": "c001"}, {"id": "2026-11-17#0002", "cf:type": "order", "cf:user": "c002"}]

hbase count <config> <table>


Description

    The number of rows of a table (the keys only are read)

Parameters

    config:   The HBase REST server configuration as JSON: url (http://127.0.0.1:8080; the REST server is started by hbase rest start), username and password (the name of a secret: secret set) for a gateway with basic authentication (Knox...), ca_file (a PEM file of a private CA, with https), allow_plain (false: a password over http is refused unless the host is localhost), timeout_ms (30000), max_bytes (64 MB, the largest answer) - String - required
    table:   The table, with its namespace if it is not default (sales:orders) - String - required
admin
hbase count "{\"url\": \"http://127.0.0.1:8080\"}" "customers"
mentdb
4

hbase count <config> <table> <filter_json>


Description

    The number of rows of a filter

Parameters

    config:   The HBase REST server configuration as JSON: url (http://127.0.0.1:8080; the REST server is started by hbase rest start), username and password (the name of a secret: secret set) for a gateway with basic authentication (Knox...), ca_file (a PEM file of a private CA, with https), allow_plain (false: a password over http is refused unless the host is localhost), timeout_ms (30000), max_bytes (64 MB, the largest answer) - String - required
    table:   The table, with its namespace if it is not default (sales:orders) - String - required
    filter_json:   The filter as a JSON object: the range (prefix, or start_row and end_row: end excluded; start_time and end_time in milliseconds), column conditions {"info:city": "Paris"} or {"info:name": {"$gte": "M"}} with $eq $ne $gt $gte $lt $lte (comparison of the bytes, so "10" < "9"), filter (a native HBase REST filter in JSON, values in base64); {} for the whole table - String - required
admin
hbase count "{\"url\": \"http://127.0.0.1:8080\"}" "events" "{\"prefix\": \"2026-11-17#\"}"
mentdb
2

hbase update <config> <table> <filter_json> <changes_json>


Description

    Write cells in every row of a filter (100000 rows at most). Returns {matched, modified}

Parameters

    config:   The HBase REST server configuration as JSON: url (http://127.0.0.1:8080; the REST server is started by hbase rest start), username and password (the name of a secret: secret set) for a gateway with basic authentication (Knox...), ca_file (a PEM file of a private CA, with https), allow_plain (false: a password over http is refused unless the host is localhost), timeout_ms (30000), max_bytes (64 MB, the largest answer) - String - required
    table:   The table, with its namespace if it is not default (sales:orders) - String - required
    filter_json:   The filter as a JSON object: the range (prefix, or start_row and end_row: end excluded; start_time and end_time in milliseconds), column conditions {"info:city": "Paris"} or {"info:name": {"$gte": "M"}} with $eq $ne $gt $gte $lt $lte (comparison of the bytes, so "10" < "9"), filter (a native HBase REST filter in JSON, values in base64); {} for the whole table - String - required
    changes_json:   The cells to write as a JSON object - String - required
admin
hbase update "{\"url\": \"http://127.0.0.1:8080\"}" "customers" "{\"info:city\": \"Paris\"}" "{\"info:segment\": \"vip\"}"
mentdb
{"matched": 2, "modified": 2}

hbase update <config> <table> <filter_json> <changes_json> <options_json>


Description

    Update with options: timestamp

Parameters

    config:   The HBase REST server configuration as JSON: url (http://127.0.0.1:8080; the REST server is started by hbase rest start), username and password (the name of a secret: secret set) for a gateway with basic authentication (Knox...), ca_file (a PEM file of a private CA, with https), allow_plain (false: a password over http is refused unless the host is localhost), timeout_ms (30000), max_bytes (64 MB, the largest answer) - String - required
    table:   The table, with its namespace if it is not default (sales:orders) - String - required
    filter_json:   The filter as a JSON object: the range (prefix, or start_row and end_row: end excluded; start_time and end_time in milliseconds), column conditions {"info:city": "Paris"} or {"info:name": {"$gte": "M"}} with $eq $ne $gt $gte $lt $lte (comparison of the bytes, so "10" < "9"), filter (a native HBase REST filter in JSON, values in base64); {} for the whole table - String - required
    changes_json:   The cells to write as a JSON object - String - required
    options_json:   The options - String - required
admin
hbase update "{\"url\": \"http://127.0.0.1:8080\"}" "events" "{\"cf:type\": \"login\"}" "{\"cf:checked\": true}" "{\"timestamp\": 1794900000000}"
mentdb
{"matched": 2, "modified": 2}

hbase delete <config> <table> <row>


Description

    Delete a row. Returns {deleted}: 1 when the REST server accepted it (HBase does not say if the row existed)

Parameters

    config:   The HBase REST server configuration as JSON: url (http://127.0.0.1:8080; the REST server is started by hbase rest start), username and password (the name of a secret: secret set) for a gateway with basic authentication (Knox...), ca_file (a PEM file of a private CA, with https), allow_plain (false: a password over http is refused unless the host is localhost), timeout_ms (30000), max_bytes (64 MB, the largest answer) - String - required
    table:   The table, with its namespace if it is not default (sales:orders) - String - required
    row:   The row key (UTF-8 text) - String - required
admin
hbase delete "{\"url\": \"http://127.0.0.1:8080\"}" "customers" "c004"
mentdb
{"deleted": 1}

hbase delete <config> <table> <row> <options_json>


Description

    Delete with options: column (a family, or family:qualifier), timestamp (with column: the versions up to it)

Parameters

    config:   The HBase REST server configuration as JSON: url (http://127.0.0.1:8080; the REST server is started by hbase rest start), username and password (the name of a secret: secret set) for a gateway with basic authentication (Knox...), ca_file (a PEM file of a private CA, with https), allow_plain (false: a password over http is refused unless the host is localhost), timeout_ms (30000), max_bytes (64 MB, the largest answer) - String - required
    table:   The table, with its namespace if it is not default (sales:orders) - String - required
    row:   The row key (UTF-8 text) - String - required
    options_json:   The options - String - required
admin
hbase delete "{\"url\": \"http://127.0.0.1:8080\"}" "customers" "c001" "{\"column\": \"hist:status\"}"
mentdb
{"deleted": 1}

hbase delete_where <config> <table> <filter_json>


Description

    Delete the rows of a filter (100000 rows at most; an empty filter is refused: drop and create the table). Returns {deleted, errors}: a row key which is not valid UTF-8 (or . or ..) cannot be addressed in a URL path of the REST server: it is not deleted and is listed in errors

Parameters

    config:   The HBase REST server configuration as JSON: url (http://127.0.0.1:8080; the REST server is started by hbase rest start), username and password (the name of a secret: secret set) for a gateway with basic authentication (Knox...), ca_file (a PEM file of a private CA, with https), allow_plain (false: a password over http is refused unless the host is localhost), timeout_ms (30000), max_bytes (64 MB, the largest answer) - String - required
    table:   The table, with its namespace if it is not default (sales:orders) - String - required
    filter_json:   The filter as a JSON object: the range (prefix, or start_row and end_row: end excluded; start_time and end_time in milliseconds), column conditions {"info:city": "Paris"} or {"info:name": {"$gte": "M"}} with $eq $ne $gt $gte $lt $lte (comparison of the bytes, so "10" < "9"), filter (a native HBase REST filter in JSON, values in base64); {} for the whole table - String - required
admin
hbase delete_where "{\"url\": \"http://127.0.0.1:8080\"}" "events" "{\"prefix\": \"2026-11-18#\"}"
mentdb
{"deleted": 1, "errors": []}

hbase request <config> <method> <path>


Description

    A raw HTTP request on the REST server (escape hatch). Returns the body of the answer ({status} when it is empty)

Parameters

    config:   The HBase REST server configuration as JSON: url (http://127.0.0.1:8080; the REST server is started by hbase rest start), username and password (the name of a secret: secret set) for a gateway with basic authentication (Knox...), ca_file (a PEM file of a private CA, with https), allow_plain (false: a password over http is refused unless the host is localhost), timeout_ms (30000), max_bytes (64 MB, the largest answer) - String - required
    method:   GET, POST, PUT, DELETE or HEAD - String - required
    path:   The path, like /status/cluster - String - required
admin
hbase request "{\"url\": \"http://127.0.0.1:8080\"}" "GET" "/version/cluster"
mentdb
{"Version":"2.6.7"}

hbase request <config> <method> <path> <body>


Description

    A raw HTTP request with a JSON body

Parameters

    config:   The HBase REST server configuration as JSON: url (http://127.0.0.1:8080; the REST server is started by hbase rest start), username and password (the name of a secret: secret set) for a gateway with basic authentication (Knox...), ca_file (a PEM file of a private CA, with https), allow_plain (false: a password over http is refused unless the host is localhost), timeout_ms (30000), max_bytes (64 MB, the largest answer) - String - required
    method:   GET, POST, PUT, DELETE or HEAD - String - required
    path:   The path - String - required
    body:   The JSON body - String - required
admin
hbase request "{\"url\": \"http://127.0.0.1:8080\"}" "POST" "/namespaces/sales" "{}"
mentdb
{"status": 201}

hbase collection_drop <config> <table>


Description

    Drop a table and its rows (disabled then deleted). Returns {dropped}

Parameters

    config:   The HBase REST server configuration as JSON: url (http://127.0.0.1:8080; the REST server is started by hbase rest start), username and password (the name of a secret: secret set) for a gateway with basic authentication (Knox...), ca_file (a PEM file of a private CA, with https), allow_plain (false: a password over http is refused unless the host is localhost), timeout_ms (30000), max_bytes (64 MB, the largest answer) - String - required
    table:   The table, with its namespace if it is not default (sales:orders) - String - required
admin
hbase collection_drop "{\"url\": \"http://127.0.0.1:8080\"}" "events"
mentdb
{"dropped": "events"}