cluster: Operate on a Kudu clusterksck: Check the health of a Kudu cluster By default, ksck checks that master and tablet server processes are running, and that table metadata is consistent. Use the 'checksum' flag to check that tablet data is consistent (also see the 'tables' and 'tablets' flags). Use the 'checksum_snapshot' along with 'checksum' if the table or tablets are actively receiving inserts or updates. Use the 'verbose' flag to output detailed information on cluster status even if no inconsistency is found in metadata.
Usage:
kudu cluster ksck <master_addresses> [-checksum_cache_blocks] [-checksum_scan] [-checksum_scan_concurrency=<concurrency>] [-nochecksum_snapshot] [-checksum_timeout_sec=<sec>] [-color=<color>] [-noconsensus] [-fetch_info_concurrency=<concurrency>] [-ksck_format=<format>] [-sections=<sections>] [-tables=<tables>] [-tablets=<tablets>]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
master_addresses |
Either comma-separated list of Kudu master addresses where each address is of form 'hostname:port', or a cluster name if it has been configured in ${KUDU_CONFIG}/kudurc |
string |
none |
checksum_cache_blocks (optional) |
Should the checksum scanners cache the read blocks |
bool |
|
checksum_scan (optional) |
Perform a checksum scan on data in the cluster. |
bool |
|
checksum_scan_concurrency (optional) |
Number of concurrent checksum scans to execute per tablet server. |
int32 |
|
checksum_snapshot (optional) |
Should the checksum scanner use a snapshot scan? |
bool |
|
checksum_timeout_sec (optional) |
Maximum total seconds to wait for a checksum scan to complete before timing out. |
int32 |
|
color (optional) |
Specifies whether output should be colorized. The default value 'auto' colorizes output if the output is a terminal. The other valid values are 'always' or 'never'. |
string |
|
consensus (optional) |
Whether to check the consensus state from each tablet against the master. |
bool |
|
fetch_info_concurrency (optional) |
Number of threads to fetch info concurrently. |
int32 |
|
ksck_format (optional) |
Output format for ksck. Available options are 'plain_concise', 'plain_full', 'json_pretty', and 'json_compact'. 'plain_concise' format is plain text, omitting most information about healthy tablets. 'plain_full' is plain text with all results included. 'json_pretty' produces pretty-printed json. 'json_compact' produces json suitable for parsing by other programs. 'json_pretty' and 'json_compact' differ in format, not content. |
string |
|
sections (optional) |
Sections to print (comma-separated list of sections, available sections are: MASTER_SUMMARIES, TSERVER_SUMMARIES, VERSION_SUMMARIES, TABLET_SUMMARIES, TABLE_SUMMARIES, CHECKSUM_RESULTS and TOTAL_COUNT.) If not specified, print all sections. |
string |
|
tables (optional) |
Tables to include (comma-separated list of table names)If not specified, includes all tables. |
string |
none |
tablets (optional) |
Tablets to check (comma-separated list of IDs) If not specified, checks all tablets. |
string |
none |
rebalance: Move tablet replicas between tablet servers to balance replica counts for each table and for the cluster as a whole. The rebalancing tool moves tablet replicas between tablet servers, in the same manner as the 'kudu tablet change_config move_replica' command, attempting to balance the count of replicas per table on each tablet server, and after that attempting to balance the total number of replicas per tablet server.
Usage:
kudu cluster rebalance <master_addresses> [-disable_policy_fixer] [-disable_cross_location_rebalancing] [-disable_intra_location_rebalancing] [-fetch_info_concurrency=<concurrency>] [-ignored_tservers=<tservers>] [-load_imbalance_threshold=<threshold>] [-max_moves_per_server=<server>] [-max_run_time_sec=<sec>] [-max_staleness_interval_sec=<sec>] [-move_single_replicas=<replicas>] [-output_replica_distribution_details] [-report_only] [-tables=<tables>]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
master_addresses |
Either comma-separated list of Kudu master addresses where each address is of form 'hostname:port', or a cluster name if it has been configured in ${KUDU_CONFIG}/kudurc |
string |
none |
disable_policy_fixer (optional) |
In case of multi-location cluster, whether to detect and fix placement policy violations. Fixing placement policy violations involves moving tablet replicas across different locations of the cluster. This setting is applicable to multi-location clusters only. |
bool |
|
disable_cross_location_rebalancing (optional) |
In case of multi-location cluster, whether to move tablet replicas between locations in attempt to spread tablet replicas among location evenly (equalizing loads of locations throughout the cluster). This setting is applicable to multi-location clusters only. |
bool |
|
disable_intra_location_rebalancing (optional) |
In case of multi-location cluster, whether to rebalance tablet replica distribution within each location. This setting is applicable to multi-location clusters only. |
bool |
|
fetch_info_concurrency (optional) |
Number of threads to fetch info concurrently. |
int32 |
|
ignored_tservers (optional) |
UUIDs of tablet servers to ignore while rebalancing the cluster (comma-separated list). If specified, allow to run the rebalancing when some tablet servers in 'ignored_tservers' are unhealthy. If not specified, allow to run the rebalancing only when all tablet servers are healthy. |
string |
none |
load_imbalance_threshold (optional) |
The threshold for the per-table location load imbalance. The threshold is used during the cross-location rebalancing phase. If the measured cross-location load imbalance for a table is greater than the specified threshold, the rebalancer tries to move table’s replicas to reduce the imbalance. The recommended range for the threshold is [0.5, …) with the default value of 1.0. The threshold represents a policy wrt what to prefer: either ideal balance of the cross-location load on per-table basis (lower threshold value) or minimum number of replica movements between locations (greater threshold value). The default value is empirically proven to be a good choice between 'ideal' and 'good enough' replica distributions. |
double |
|
max_moves_per_server (optional) |
Maximum number of replica moves to perform concurrently on one tablet server: 'move from' and 'move to' are counted as separate move operations. |
uint32 |
|
max_run_time_sec (optional) |
Maximum time to run the rebalancing, in seconds. Specifying 0 means not imposing any limit on the rebalancing run time. |
int64 |
|
max_staleness_interval_sec (optional) |
Maximum duration of the 'staleness' interval, when the rebalancer cannot make any progress in scheduling new moves and no prior scheduled moves are left, even if re-synchronizing against the cluster’s state again and again. Such a staleness usually happens in case of a persistent problem with the cluster or when some unexpected concurrent activity is present (such as automatic recovery of failed replicas, etc.) |
uint32 |
|
move_single_replicas (optional) |
Whether to move single replica tablets (i.e. replicas of tablets of replication factor 1). Acceptable values are: 'auto', 'enabled', 'disabled'. The value of 'auto' means turn it on/off depending on the replica management scheme and Kudu version. |
string |
|
output_replica_distribution_details (optional) |
Whether to output details on per-table and per-server replica distribution |
bool |
|
report_only (optional) |
Whether to report on table- and cluster-wide replica distribution skew and exit without doing any actual rebalancing |
bool |
|
tables (optional) |
Tables to include (comma-separated list of table names)If not specified, includes all tables. |
string |
none |
diagnose: Diagnostic tools for Kudu servers and clustersparse_stacks: Parse sampled stack traces out of a diagnostics log Usage:
kudu diagnose parse_stacks <path>…
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
path… |
path to log file(s) to parse |
string |
none |
fs: Operate on a local Kudu filesystemcheck: Check a Kudu filesystem for inconsistencies Usage:
kudu fs check [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>] [-repair]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
fs_data_dirs (optional) |
Comma-separated list of directories with data blocks. If this is not specified, fs_wal_dir will be used as the sole data block directory. |
string |
none |
fs_metadata_dir (optional) |
Directory with metadata. If this is not specified, for compatibility with Kudu 1.6 and below, Kudu will check the first entry of fs_data_dirs for metadata and use it as the metadata directory if any exists. If none exists, fs_wal_dir will be used as the metadata directory. |
string |
none |
fs_wal_dir (optional) |
Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs |
string |
none |
repair (optional) |
Repair any inconsistencies in the filesystem. |
bool |
|
format: Format a new Kudu filesystem Usage:
kudu fs format [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>] [-uuid=<uuid>]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
fs_data_dirs (optional) |
Comma-separated list of directories with data blocks. If this is not specified, fs_wal_dir will be used as the sole data block directory. |
string |
none |
fs_metadata_dir (optional) |
Directory with metadata. If this is not specified, for compatibility with Kudu 1.6 and below, Kudu will check the first entry of fs_data_dirs for metadata and use it as the metadata directory if any exists. If none exists, fs_wal_dir will be used as the metadata directory. |
string |
none |
fs_wal_dir (optional) |
Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs |
string |
none |
uuid (optional) |
The uuid to use in the filesystem. If not provided, one is generated |
string |
none |
list: List metadata for on-disk tablets, rowsets, blocks, and cfiles This tool is useful for discovering and gathering information about on-disk data. Many field types can be added to the results with the --columns flag, and results can be filtered to a specific table, tablet, rowset, column, or block through flags.
Note: adding any of the 'cfile' fields to --columns will cause the tool to read on-disk metadata for each CFile in the result set, which could require large amounts of I/O when many results are returned.
Usage:
kudu fs list [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>] [-table_id=<id>] [-table_name=<name>] [-tablet_id=<id>] [-rowset_id=<id>] [-column_id=<id>] [-block_id=<id>] [-columns=<columns>] [-format=<format>] [-noh]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
fs_data_dirs (optional) |
Comma-separated list of directories with data blocks. If this is not specified, fs_wal_dir will be used as the sole data block directory. |
string |
none |
fs_metadata_dir (optional) |
Directory with metadata. If this is not specified, for compatibility with Kudu 1.6 and below, Kudu will check the first entry of fs_data_dirs for metadata and use it as the metadata directory if any exists. If none exists, fs_wal_dir will be used as the metadata directory. |
string |
none |
fs_wal_dir (optional) |
Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs |
string |
none |
table_id (optional) |
Restrict output to a specific table by id |
string |
none |
table_name (optional) |
Restrict output to a specific table by name |
string |
none |
tablet_id (optional) |
Restrict output to a specific tablet |
string |
none |
rowset_id (optional) |
Restrict output to a specific rowset |
int64 |
|
column_id (optional) |
Restrict output to a specific column |
int32 |
|
block_id (optional) |
Restrict output to a specific block |
uint64 |
|
columns (optional) |
Comma-separated list of fields to include in output. Possible values: table, table-id, tablet-id, partition, rowset-id, block-id, block-kind, column, column-id, cfile-data-type, cfile-nullable, cfile-encoding, cfile-compression, cfile-num-values, cfile-size, cfile-incompatible-features, cfile-compatible-features, cfile-min-key, cfile-max-key, cfile-delta-stats |
string |
|
format (optional) |
Format to use for printing list output tables. Possible values: pretty, space, tsv, csv, and json |
string |
|
h (optional) |
Pretty-print values in human-readable units |
bool |
|
update_dirs: Updates the set of data directories in an existing Kudu filesystem If a data directory is in use by a tablet and is removed, the operation will fail unless --force is also used
Usage:
kudu fs update_dirs [-force] [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
force (optional) |
If true, permits the removal of a data directory that is configured for use by existing tablets. Those tablets will fail the next time the server is started |
bool |
|
fs_data_dirs (optional) |
Comma-separated list of directories with data blocks. If this is not specified, fs_wal_dir will be used as the sole data block directory. |
string |
none |
fs_metadata_dir (optional) |
Directory with metadata. If this is not specified, for compatibility with Kudu 1.6 and below, Kudu will check the first entry of fs_data_dirs for metadata and use it as the metadata directory if any exists. If none exists, fs_wal_dir will be used as the metadata directory. |
string |
none |
fs_wal_dir (optional) |
Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs |
string |
none |
dump: Dump a Kudu filesystemblock: Dump the binary contents of a data block This performs no parsing or interpretation of the data stored in the block but rather outputs its binary contents directly.
Usage:
kudu fs dump block <block_id> [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
block_id |
block identifier |
string |
none |
fs_data_dirs (optional) |
Comma-separated list of directories with data blocks. If this is not specified, fs_wal_dir will be used as the sole data block directory. |
string |
none |
fs_metadata_dir (optional) |
Directory with metadata. If this is not specified, for compatibility with Kudu 1.6 and below, Kudu will check the first entry of fs_data_dirs for metadata and use it as the metadata directory if any exists. If none exists, fs_wal_dir will be used as the metadata directory. |
string |
none |
fs_wal_dir (optional) |
Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs |
string |
none |
cfile: Dump the contents of a CFile (column file) This interprets the contents of a CFile-formatted block and outputs the decoded row data.
Usage:
kudu fs dump cfile <block_id> [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>] [-noprint_meta] [-noprint_rows]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
block_id |
block identifier |
string |
none |
fs_data_dirs (optional) |
Comma-separated list of directories with data blocks. If this is not specified, fs_wal_dir will be used as the sole data block directory. |
string |
none |
fs_metadata_dir (optional) |
Directory with metadata. If this is not specified, for compatibility with Kudu 1.6 and below, Kudu will check the first entry of fs_data_dirs for metadata and use it as the metadata directory if any exists. If none exists, fs_wal_dir will be used as the metadata directory. |
string |
none |
fs_wal_dir (optional) |
Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs |
string |
none |
print_meta (optional) |
Include metadata in output |
bool |
|
print_rows (optional) |
Print each row in the CFile |
bool |
|
tree: Dump the tree of a Kudu filesystem Usage:
kudu fs dump tree [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
fs_data_dirs (optional) |
Comma-separated list of directories with data blocks. If this is not specified, fs_wal_dir will be used as the sole data block directory. |
string |
none |
fs_metadata_dir (optional) |
Directory with metadata. If this is not specified, for compatibility with Kudu 1.6 and below, Kudu will check the first entry of fs_data_dirs for metadata and use it as the metadata directory if any exists. If none exists, fs_wal_dir will be used as the metadata directory. |
string |
none |
fs_wal_dir (optional) |
Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs |
string |
none |
uuid: Dump the UUID of a Kudu filesystem Usage:
kudu fs dump uuid [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
fs_data_dirs (optional) |
Comma-separated list of directories with data blocks. If this is not specified, fs_wal_dir will be used as the sole data block directory. |
string |
none |
fs_metadata_dir (optional) |
Directory with metadata. If this is not specified, for compatibility with Kudu 1.6 and below, Kudu will check the first entry of fs_data_dirs for metadata and use it as the metadata directory if any exists. If none exists, fs_wal_dir will be used as the metadata directory. |
string |
none |
fs_wal_dir (optional) |
Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs |
string |
none |
hms: Operate on remote Hive Metastorescheck: Check metadata consistency between Kudu and the Hive Metastore catalogs Usage:
kudu hms check <master_addresses> [-hive_metastore_sasl_enabled] [-hive_metastore_uris=<uris>] [-noignore_other_clusters]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
master_addresses |
Either comma-separated list of Kudu master addresses where each address is of form 'hostname:port', or a cluster name if it has been configured in ${KUDU_CONFIG}/kudurc |
string |
none |
hive_metastore_sasl_enabled (optional) |
Configures whether Thrift connections to the Hive Metastore use SASL (Kerberos) security. Only takes effect when --hive_metastore_uris is set, otherwise the configuration from the Kudu master is used. The configured value must match the the hive.metastore.sasl.enabled option in the Hive Metastore configuration. |
bool |
|
hive_metastore_uris (optional) |
Address of the Hive Metastore instance(s). If not set, the configuration from the Kudu master is used, so this flag should not be overriden in typical situations. The provided port must be for the HMS Thrift service. If a port is not provided, defaults to 9083. If the HMS is deployed in an HA configuration, multiple comma-separated addresses should be supplied. The configured value must match the Hive hive.metastore.uris configuration. |
string |
none |
ignore_other_clusters (optional) |
Whether to ignore entirely separate Kudu clusters, as indicated by a different set of master addresses. |
bool |
|
downgrade: Downgrade the metadata to legacy format for Kudu and the Hive Metastores Usage:
kudu hms downgrade <master_addresses> [-hive_metastore_sasl_enabled] [-hive_metastore_uris=<uris>]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
master_addresses |
Either comma-separated list of Kudu master addresses where each address is of form 'hostname:port', or a cluster name if it has been configured in ${KUDU_CONFIG}/kudurc |
string |
none |
hive_metastore_sasl_enabled (optional) |
Configures whether Thrift connections to the Hive Metastore use SASL (Kerberos) security. Only takes effect when --hive_metastore_uris is set, otherwise the configuration from the Kudu master is used. The configured value must match the the hive.metastore.sasl.enabled option in the Hive Metastore configuration. |
bool |
|
hive_metastore_uris (optional) |
Address of the Hive Metastore instance(s). If not set, the configuration from the Kudu master is used, so this flag should not be overriden in typical situations. The provided port must be for the HMS Thrift service. If a port is not provided, defaults to 9083. If the HMS is deployed in an HA configuration, multiple comma-separated addresses should be supplied. The configured value must match the Hive hive.metastore.uris configuration. |
string |
none |
fix: Fix automatically-repairable metadata inconsistencies in the Kudu and Hive Metastore catalogs Usage:
kudu hms fix <master_addresses> [-dryrun] [-drop_orphan_hms_tables] [-nocreate_missing_hms_tables] [-nofix_inconsistent_tables] [-noupgrade_hms_tables] [-hive_metastore_sasl_enabled] [-hive_metastore_uris=<uris>] [-noignore_other_clusters]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
master_addresses |
Either comma-separated list of Kudu master addresses where each address is of form 'hostname:port', or a cluster name if it has been configured in ${KUDU_CONFIG}/kudurc |
string |
none |
dryrun (optional) |
Print a message for each fix, but do not make modifications to Kudu or the Hive Metastore. |
bool |
|
drop_orphan_hms_tables (optional) |
Drop orphan Hive Metastore tables which refer to non-existent Kudu tables. |
bool |
|
create_missing_hms_tables (optional) |
Create a Hive Metastore table for each Kudu table which is missing one. |
bool |
|
fix_inconsistent_tables (optional) |
Fix tables whose Kudu and Hive Metastore metadata differ. If the table name is different, the table is renamed in Kudu to match the HMS. If the columns or other metadata is different the HMS is updated to match Kudu. |
bool |
|
upgrade_hms_tables (optional) |
Upgrade Hive Metastore tables from the legacy Impala metadata format to the new Kudu metadata format. |
bool |
|
hive_metastore_sasl_enabled (optional) |
Configures whether Thrift connections to the Hive Metastore use SASL (Kerberos) security. Only takes effect when --hive_metastore_uris is set, otherwise the configuration from the Kudu master is used. The configured value must match the the hive.metastore.sasl.enabled option in the Hive Metastore configuration. |
bool |
|
hive_metastore_uris (optional) |
Address of the Hive Metastore instance(s). If not set, the configuration from the Kudu master is used, so this flag should not be overriden in typical situations. The provided port must be for the HMS Thrift service. If a port is not provided, defaults to 9083. If the HMS is deployed in an HA configuration, multiple comma-separated addresses should be supplied. The configured value must match the Hive hive.metastore.uris configuration. |
string |
none |
ignore_other_clusters (optional) |
Whether to ignore entirely separate Kudu clusters, as indicated by a different set of master addresses. |
bool |
|
list: List the Kudu table HMS entries Usage:
kudu hms list <master_addresses> [-columns=<columns>] [-format=<format>]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
master_addresses |
Either comma-separated list of Kudu master addresses where each address is of form 'hostname:port', or a cluster name if it has been configured in ${KUDU_CONFIG}/kudurc |
string |
none |
columns (optional) |
Comma-separated list of HMS entry fields to include in output. Possible values: database, table, type, owner, kudu.table_name, kudu.table_id, kudu.master_addresses, storage_handler |
string |
|
format (optional) |
Format to use for printing list output tables. Possible values: pretty, space, tsv, csv, and json |
string |
|
precheck: Check that the Kudu cluster is prepared to enable the Hive Metastore integration Usage:
kudu hms precheck <master_addresses>
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
master_addresses |
Either comma-separated list of Kudu master addresses where each address is of form 'hostname:port', or a cluster name if it has been configured in ${KUDU_CONFIG}/kudurc |
string |
none |
local_replica: Operate on local tablet replicas via the local filesystemcopy_from_remote: Copy a tablet replica from a remote server Usage:
kudu local_replica copy_from_remote <tablet_id> <source> [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
tablet_id |
Tablet Identifier |
string |
none |
source |
Source RPC address of form hostname:port |
string |
none |
fs_data_dirs (optional) |
Comma-separated list of directories with data blocks. If this is not specified, fs_wal_dir will be used as the sole data block directory. |
string |
none |
fs_metadata_dir (optional) |
Directory with metadata. If this is not specified, for compatibility with Kudu 1.6 and below, Kudu will check the first entry of fs_data_dirs for metadata and use it as the metadata directory if any exists. If none exists, fs_wal_dir will be used as the metadata directory. |
string |
none |
fs_wal_dir (optional) |
Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs |
string |
none |
data_size: Summarize the data size/space usage of the given local replica(s). Usage:
kudu local_replica data_size <tablet_id_pattern> [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>] [-format=<format>]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
tablet_id_pattern |
Tablet identifier pattern. This argument supports basic glob syntax: '*' matches 0 or more wildcard characters. |
string |
none |
fs_data_dirs (optional) |
Comma-separated list of directories with data blocks. If this is not specified, fs_wal_dir will be used as the sole data block directory. |
string |
none |
fs_metadata_dir (optional) |
Directory with metadata. If this is not specified, for compatibility with Kudu 1.6 and below, Kudu will check the first entry of fs_data_dirs for metadata and use it as the metadata directory if any exists. If none exists, fs_wal_dir will be used as the metadata directory. |
string |
none |
fs_wal_dir (optional) |
Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs |
string |
none |
format (optional) |
Format to use for printing list output tables. Possible values: pretty, space, tsv, csv, and json |
string |
|
delete: Delete a tablet replica from the local filesystem. By default, leaves a tombstone record. Usage:
kudu local_replica delete <tablet_id> [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>] [-clean_unsafe]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
tablet_id |
Tablet Identifier |
string |
none |
fs_data_dirs (optional) |
Comma-separated list of directories with data blocks. If this is not specified, fs_wal_dir will be used as the sole data block directory. |
string |
none |
fs_metadata_dir (optional) |
Directory with metadata. If this is not specified, for compatibility with Kudu 1.6 and below, Kudu will check the first entry of fs_data_dirs for metadata and use it as the metadata directory if any exists. If none exists, fs_wal_dir will be used as the metadata directory. |
string |
none |
fs_wal_dir (optional) |
Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs |
string |
none |
clean_unsafe (optional) |
Delete the local replica completely, not leaving a tombstone. This is not guaranteed to be safe because it also removes the consensus metadata (including Raft voting record) for the specified tablet, which violates the Raft vote durability requirements. |
bool |
|
list: Show list of tablet replicas in the local filesystem Usage:
kudu local_replica list [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>] [-list_detail]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
fs_data_dirs (optional) |
Comma-separated list of directories with data blocks. If this is not specified, fs_wal_dir will be used as the sole data block directory. |
string |
none |
fs_metadata_dir (optional) |
Directory with metadata. If this is not specified, for compatibility with Kudu 1.6 and below, Kudu will check the first entry of fs_data_dirs for metadata and use it as the metadata directory if any exists. If none exists, fs_wal_dir will be used as the metadata directory. |
string |
none |
fs_wal_dir (optional) |
Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs |
string |
none |
list_detail (optional) |
Print partition info for the local replicas |
bool |
|
cmeta: Operate on a local tablet replica’s consensus metadata fileprint_replica_uuids: Print all tablet replica peer UUIDs found in a tablet’s Raft configuration Usage:
kudu local_replica cmeta print_replica_uuids <tablet_id> [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
tablet_id |
Tablet Identifier |
string |
none |
fs_data_dirs (optional) |
Comma-separated list of directories with data blocks. If this is not specified, fs_wal_dir will be used as the sole data block directory. |
string |
none |
fs_metadata_dir (optional) |
Directory with metadata. If this is not specified, for compatibility with Kudu 1.6 and below, Kudu will check the first entry of fs_data_dirs for metadata and use it as the metadata directory if any exists. If none exists, fs_wal_dir will be used as the metadata directory. |
string |
none |
fs_wal_dir (optional) |
Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs |
string |
none |
rewrite_raft_config: Rewrite a tablet replica’s Raft configuration Usage:
kudu local_replica cmeta rewrite_raft_config <tablet_id> <peers>… [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
tablet_id |
Tablet Identifier |
string |
none |
peers… |
List of peers where each peer is of form 'uuid:hostname:port' |
string |
none |
fs_data_dirs (optional) |
Comma-separated list of directories with data blocks. If this is not specified, fs_wal_dir will be used as the sole data block directory. |
string |
none |
fs_metadata_dir (optional) |
Directory with metadata. If this is not specified, for compatibility with Kudu 1.6 and below, Kudu will check the first entry of fs_data_dirs for metadata and use it as the metadata directory if any exists. If none exists, fs_wal_dir will be used as the metadata directory. |
string |
none |
fs_wal_dir (optional) |
Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs |
string |
none |
set_term: Bump the current term stored in consensus metadata Usage:
kudu local_replica cmeta set_term <tablet_id> <term> [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
tablet_id |
Tablet Identifier |
string |
none |
term |
the new raft term (must be greater than the current term) |
string |
none |
fs_data_dirs (optional) |
Comma-separated list of directories with data blocks. If this is not specified, fs_wal_dir will be used as the sole data block directory. |
string |
none |
fs_metadata_dir (optional) |
Directory with metadata. If this is not specified, for compatibility with Kudu 1.6 and below, Kudu will check the first entry of fs_data_dirs for metadata and use it as the metadata directory if any exists. If none exists, fs_wal_dir will be used as the metadata directory. |
string |
none |
fs_wal_dir (optional) |
Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs |
string |
none |
dump: Dump a Kudu filesystemblock_ids: Dump the IDs of all blocks belonging to a local replica Usage:
kudu local_replica dump block_ids <tablet_id> [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
tablet_id |
Tablet Identifier |
string |
none |
fs_data_dirs (optional) |
Comma-separated list of directories with data blocks. If this is not specified, fs_wal_dir will be used as the sole data block directory. |
string |
none |
fs_metadata_dir (optional) |
Directory with metadata. If this is not specified, for compatibility with Kudu 1.6 and below, Kudu will check the first entry of fs_data_dirs for metadata and use it as the metadata directory if any exists. If none exists, fs_wal_dir will be used as the metadata directory. |
string |
none |
fs_wal_dir (optional) |
Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs |
string |
none |
data_dirs: Dump the data directories where the replica’s data is stored Usage:
kudu local_replica dump data_dirs <tablet_id> [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
tablet_id |
Tablet Identifier |
string |
none |
fs_data_dirs (optional) |
Comma-separated list of directories with data blocks. If this is not specified, fs_wal_dir will be used as the sole data block directory. |
string |
none |
fs_metadata_dir (optional) |
Directory with metadata. If this is not specified, for compatibility with Kudu 1.6 and below, Kudu will check the first entry of fs_data_dirs for metadata and use it as the metadata directory if any exists. If none exists, fs_wal_dir will be used as the metadata directory. |
string |
none |
fs_wal_dir (optional) |
Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs |
string |
none |
meta: Dump the metadata of a local replica Usage:
kudu local_replica dump meta <tablet_id> [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
tablet_id |
Tablet Identifier |
string |
none |
fs_data_dirs (optional) |
Comma-separated list of directories with data blocks. If this is not specified, fs_wal_dir will be used as the sole data block directory. |
string |
none |
fs_metadata_dir (optional) |
Directory with metadata. If this is not specified, for compatibility with Kudu 1.6 and below, Kudu will check the first entry of fs_data_dirs for metadata and use it as the metadata directory if any exists. If none exists, fs_wal_dir will be used as the metadata directory. |
string |
none |
fs_wal_dir (optional) |
Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs |
string |
none |
rowset: Dump the rowset contents of a local replica Usage:
kudu local_replica dump rowset <tablet_id> [-nodump_all_columns] [-nodump_metadata] [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>] [-nrows=<nrows>] [-rowset_index=<index>]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
tablet_id |
Tablet Identifier |
string |
none |
dump_all_columns (optional) |
If true, dumped rows include all of the columns in the rowset. If false, dumped rows include just the key columns (in a comparable format). |
bool |
|
dump_metadata (optional) |
If true, dumps rowset metadata before dumping data. If false, only dumps the data. |
bool |
|
fs_data_dirs (optional) |
Comma-separated list of directories with data blocks. If this is not specified, fs_wal_dir will be used as the sole data block directory. |
string |
none |
fs_metadata_dir (optional) |
Directory with metadata. If this is not specified, for compatibility with Kudu 1.6 and below, Kudu will check the first entry of fs_data_dirs for metadata and use it as the metadata directory if any exists. If none exists, fs_wal_dir will be used as the metadata directory. |
string |
none |
fs_wal_dir (optional) |
Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs |
string |
none |
nrows (optional) |
Number of rows to dump. If negative, dumps all rows. |
int64 |
|
rowset_index (optional) |
Index of the rowset in local replica, default value(-1) will dump all the rowsets of the local replica |
int64 |
|
wals: Dump all WAL (write-ahead log) segments of a local replica Usage:
kudu local_replica dump wals <tablet_id> [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>] [-print_entries=<entries>] [-noprint_meta] [-truncate_data=<data>]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
tablet_id |
Tablet Identifier |
string |
none |
fs_data_dirs (optional) |
Comma-separated list of directories with data blocks. If this is not specified, fs_wal_dir will be used as the sole data block directory. |
string |
none |
fs_metadata_dir (optional) |
Directory with metadata. If this is not specified, for compatibility with Kudu 1.6 and below, Kudu will check the first entry of fs_data_dirs for metadata and use it as the metadata directory if any exists. If none exists, fs_wal_dir will be used as the metadata directory. |
string |
none |
fs_wal_dir (optional) |
Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs |
string |
none |
print_entries (optional) |
How to print entries: false|0|no = don’t print true|1|yes|decoded = print them decoded pb = print the raw protobuf id = print only their ids |
string |
|
print_meta (optional) |
Include metadata in output |
bool |
|
truncate_data (optional) |
Truncate the data fields to the given number of bytes before printing. Set to 0 to disable |
int32 |
|
master: Operate on a Kudu Masterdump_memtrackers: Dump the memtrackers from a Kudu Master Usage:
kudu master dump_memtrackers <master_address> [-format=<format>] [-memtracker_output=<output>] [-timeout_ms=<ms>]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
master_address |
Address of a Kudu Master of form 'hostname:port'. Port may be omitted if the Master is bound to the default port. |
string |
none |
format (optional) |
Format to use for printing list output tables. Possible values: pretty, space, tsv, csv, and json |
string |
|
memtracker_output (optional) |
One of 'json', 'json_compact' or 'table'. Table output flattens the memtracker hierarchy. |
string |
|
timeout_ms (optional) |
RPC timeout in milliseconds |
int64 |
|
get_flags: Get the gflags for a Kudu Master Usage:
kudu master get_flags <master_address> [-all_flags] [-flag_tags=<tags>]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
master_address |
Address of a Kudu Master of form 'hostname:port'. Port may be omitted if the Master is bound to the default port. |
string |
none |
all_flags (optional) |
Whether to return all flags, or only flags that were explicitly set. |
bool |
|
flag_tags (optional) |
Comma-separated list of tags used to restrict which flags are returned. An empty value matches all tags |
string |
none |
set_flag: Change a gflag value on a Kudu Master Usage:
kudu master set_flag <master_address> <flag> <value> [-force]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
master_address |
Address of a Kudu Master of form 'hostname:port'. Port may be omitted if the Master is bound to the default port. |
string |
none |
flag |
Name of the gflag |
string |
none |
value |
New value for the gflag |
string |
none |
force (optional) |
If true, allows the set_flag command to set a flag which is not explicitly marked as runtime-settable. Such flag changes may be simply ignored on the server, or may cause the server to crash. |
bool |
|
status: Get the status of a Kudu Master Usage:
kudu master status <master_address>
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
master_address |
Address of a Kudu Master of form 'hostname:port'. Port may be omitted if the Master is bound to the default port. |
string |
none |
timestamp: Get the current timestamp of a Kudu Master Usage:
kudu master timestamp <master_address>
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
master_address |
Address of a Kudu Master of form 'hostname:port'. Port may be omitted if the Master is bound to the default port. |
string |
none |
list: List masters in a Kudu cluster Usage:
kudu master list <master_addresses> [-columns=<columns>] [-format=<format>] [-timeout_ms=<ms>]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
master_addresses |
Either comma-separated list of Kudu master addresses where each address is of form 'hostname:port', or a cluster name if it has been configured in ${KUDU_CONFIG}/kudurc |
string |
none |
columns (optional) |
Comma-separated list of master info fields to include in output. Possible values: uuid, rpc-addresses, http-addresses, version, seqno, start_time and role |
string |
|
format (optional) |
Format to use for printing list output tables. Possible values: pretty, space, tsv, csv, and json |
string |
|
timeout_ms (optional) |
RPC timeout in milliseconds |
int64 |
|
authz_cache: Operate on the authz cache of a Kudu Masterreset: Reset the privileges cache Usage:
kudu master authz_cache reset <master_addresses> [-force]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
master_addresses |
Either comma-separated list of Kudu master addresses where each address is of form 'hostname:port', or a cluster name if it has been configured in ${KUDU_CONFIG}/kudurc |
string |
none |
force (optional) |
Ignore mismatches of the specified and the actual lists of master addresses in the cluster |
bool |
|
pbc: Operate on PBC (protobuf container) filesdump: Dump a PBC (protobuf container) file Usage:
kudu pbc dump <path> [-debug] [-oneline] [-json]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
path |
path to PBC file |
string |
none |
debug (optional) |
Print extra debugging information about each protobuf |
bool |
|
oneline (optional) |
Print each protobuf on a single line |
bool |
|
json (optional) |
Print protobufs in JSON format |
bool |
|
edit: Edit a PBC (protobuf container) file Usage:
kudu pbc edit <path> [-nobackup]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
path |
path to PBC file |
string |
none |
backup (optional) |
Write a backup file |
bool |
|
perf: Measure the performance of a Kudu clusterloadgen: Run load generation with optional scan afterwards Run load generation tool which inserts auto-generated data into an existing or auto-created table as fast as possible. If requested, also scan the inserted rows to check whether the actual count of inserted rows matches the expected one.
Usage:
kudu perf loadgen <master_addresses> [-auto_database=<database>] [-buffer_flush_watermark_pct=<pct>] [-buffer_size_bytes=<bytes>] [-buffers_num=<num>] [-error_buffer_size_bytes=<bytes>] [-flush_per_n_rows=<rows>] [-keep_auto_table] [-num_rows_per_thread=<thread>] [-num_threads=<threads>] [-run_scan] [-seq_start=<start>] [-show_first_n_errors=<errors>] [-string_fixed=<fixed>] [-string_len=<len>] [-table_name=<name>] [-table_num_hash_partitions=<partitions>] [-table_num_range_partitions=<partitions>] [-table_num_replicas=<replicas>] [-use_random]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
master_addresses |
Either comma-separated list of Kudu master addresses where each address is of form 'hostname:port', or a cluster name if it has been configured in ${KUDU_CONFIG}/kudurc |
string |
none |
auto_database (optional) |
The database in which to create the automatically generated table. If --table_name is set, this flag has no effect, since a table is not created. This flag is useful primarily when the Hive Metastore integration is enabled in the cluster. If empty, no database is used. |
string |
|
buffer_flush_watermark_pct (optional) |
Mutation buffer flush watermark, in percentage of total size. |
double |
|
buffer_size_bytes (optional) |
Size of the mutation buffer, per session (bytes). |
int32 |
|
buffers_num (optional) |
Number of mutation buffers per session. |
int32 |
|
error_buffer_size_bytes (optional) |
Size of the error buffer, per session (bytes). 0 means 'unlimited'. This setting may impose an additional upper limit for the effective number of errors controlled by the '--show_first_n_errors' flag. |
int32 |
|
flush_per_n_rows (optional) |
Perform async flush per given number of rows added. Setting to non-zero implicitly turns on manual flush mode. |
int32 |
|
keep_auto_table (optional) |
If using the auto-generated table, enabling this option retains the table populated with the data after the test finishes. By default, the auto-generated table is dropped after successfully finishing the test. NOTE: this parameter has no effect if using already existing table (see the '--table_name' flag): neither the existing table nor its data is ever dropped/deleted. |
bool |
|
num_rows_per_thread (optional) |
Number of rows each thread generates and inserts; -1 means unlimited. All rows generated by a thread are inserted in the context of the same session. |
int64 |
|
num_threads (optional) |
Number of threads to run. Each thread runs its own KuduSession. |
int32 |
|
run_scan (optional) |
Whether to run post-insertion scan to verify that the count of the inserted rows matches the expected number. If enabled, the scan is run only if no errors were encountered while inserting the generated rows. |
bool |
|
seq_start (optional) |
Initial value for the generator in sequential mode. This is useful when running multiple times against already existing table: for every next run, set this flag to (num_threads * num_rows_per_thread * column_num + seq_start). |
uint64 |
|
show_first_n_errors (optional) |
Output detailed information on the specified number of first n errors (if any). The limit on the per-session error buffer space may impose an additional upper limit for the effective number of errors in the output. If so, consider increasing the size of the error buffer using the '--error_buffer_size_bytes' flag. |
int32 |
|
string_fixed (optional) |
Pre-defined string to write into binary and string columns. Client generates more data per second using pre-defined string compared with auto-generated strings of the same length if run with the same CPU/memory configuration. If left empty, then auto-generated strings of length specified by the '--string_len' parameter are used instead. |
string |
none |
string_len (optional) |
Length of strings to put into string and binary columns. This parameter is not in effect if '--string_fixed' is specified. |
int32 |
|
table_name (optional) |
Name of an existing table to use for the test. The test will determine the structure of the table schema and populate it with data accordingly. If left empty, the test automatically creates a table of pre-defined columnar structure with unique name and uses it to insert auto-generated data. The auto-created table is dropped upon successful completion of the test if not overridden by the '--keep_auto_table' flag. If running the test against an already existing table, it’s recommended to use a dedicated table created just for testing purposes: the tool doesn’t delete the rows it inserted into the table. Neither the existing table nor its data is ever dropped/deleted. |
string |
none |
table_num_hash_partitions (optional) |
The number of hash partitions to create when this tool creates a new table. Note: The total number of partitions must be greater than 1. |
int32 |
|
table_num_range_partitions (optional) |
The number of range partitions to create when this tool creates a new table. A range partitioning schema will be determined to evenly split a sequential workload across ranges, leaving the outermost ranges unbounded to ensure coverage of the entire keyspace. Note: The total number of partitions must be greater than 1. |
int32 |
|
table_num_replicas (optional) |
The number of replicas for the auto-created table; 0 means 'use server-side default'. |
int32 |
|
use_random (optional) |
Whether to use random numbers instead of sequential ones. In case of using random numbers collisions are possible over the data for columns with unique constraint (e.g. primary key). |
bool |
|
table_scan: Show row count and scanning time cost of tablets in a table Show row count and scanning time of tablets in a table. This can be useful to check for row count skew across different tablets, or whether there is a long latency tail when scanning different tables.
Usage:
kudu perf table_scan <master_addresses> <table_name> [-columns=<columns>] [-nofill_cache] [-num_threads=<threads>] [-predicates=<predicates>] [-tablets=<tablets>]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
master_addresses |
Either comma-separated list of Kudu master addresses where each address is of form 'hostname:port', or a cluster name if it has been configured in ${KUDU_CONFIG}/kudurc |
string |
none |
table_name |
Name of the table to scan |
string |
none |
columns (optional) |
Comma-separated list of column fields to include in output tables |
string |
|
fill_cache (optional) |
Whether to fill block cache when scanning. |
bool |
|
num_threads (optional) |
Number of threads to run. Each thread runs its own KuduSession. |
int32 |
|
predicates (optional) |
Query predicates on columns. Unlike traditional SQL syntax, the scan tool’s simple query predicates are represented in a simple JSON syntax. Three types of predicates are supported, including 'Comparison', 'InList' and 'IsNull'.
* The 'Comparison' type support ⇐, <, =, > and >=,
which can be represented as '[operator, column_name, value]',
e.g. '[">=", "col1", "value"]'
* The 'InList' type can be represented as
'["IN", column_name, [value1, value2, …]]'
e.g. '["IN", "col2", ["value1", "value2"]]'
* The 'IsNull' type determine whether the value is NULL or not,
which can be represented as '[operator, column_name]'
e.g. '["NULL", "col1"]', or '["NOTNULL", "col2"]'
Predicates can be combined together with predicate operators using the syntax
[operator, predicate, predicate, …, predicate].
For example,
["AND", [">=", "col1", "value"], ["NOTNULL", "col2"]]
The only supported predicate operator is |
string |
none |
tablets (optional) |
Tablets to check (comma-separated list of IDs) If not specified, checks all tablets. |
string |
none |
tablet_scan: Show row count of a local tablet Usage:
kudu perf tablet_scan <tablet_id> [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>] [-num_iters=<iters>] [-ordered_scan]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
tablet_id |
Tablet Identifier |
string |
none |
fs_data_dirs (optional) |
Comma-separated list of directories with data blocks. If this is not specified, fs_wal_dir will be used as the sole data block directory. |
string |
none |
fs_metadata_dir (optional) |
Directory with metadata. If this is not specified, for compatibility with Kudu 1.6 and below, Kudu will check the first entry of fs_data_dirs for metadata and use it as the metadata directory if any exists. If none exists, fs_wal_dir will be used as the metadata directory. |
string |
none |
fs_wal_dir (optional) |
Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs |
string |
none |
num_iters (optional) |
Number of times to run the scan. |
int32 |
|
ordered_scan (optional) |
Whether to run an ordered or unordered scan. |
bool |
|
remote_replica: Operate on remote tablet replicas on a Kudu Tablet Servercheck: Check if all tablet replicas on a Kudu tablet server are running. Tombstoned replica do not count as not running, because they are just records of the previous existence of a replica. Usage:
kudu remote_replica check <tserver_address>
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
tserver_address |
Address of a Kudu Tablet Server of form 'hostname:port'. Port may be omitted if the Tablet Server is bound to the default port. |
string |
none |
copy: Copy a tablet replica from one Kudu Tablet Server to another Usage:
kudu remote_replica copy <tablet_id> <src_address> <dst_address> [-force_copy]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
tablet_id |
Tablet Identifier |
string |
none |
src_address |
Address of a Kudu Tablet Server of form 'hostname:port'. Port may be omitted if the Tablet Server is bound to the default port. |
string |
none |
dst_address |
Address of a Kudu Tablet Server of form 'hostname:port'. Port may be omitted if the Tablet Server is bound to the default port. |
string |
none |
force_copy (optional) |
Force the copy when the destination tablet server has this replica |
bool |
|
delete: Delete a tablet replica from a Kudu Tablet Server Usage:
kudu remote_replica delete <tserver_address> <tablet_id> <reason>
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
tserver_address |
Address of a Kudu Tablet Server of form 'hostname:port'. Port may be omitted if the Tablet Server is bound to the default port. |
string |
none |
tablet_id |
Tablet Identifier |
string |
none |
reason |
Reason for deleting the replica |
string |
none |
dump: Dump the data of a tablet replica on a Kudu Tablet Server Usage:
kudu remote_replica dump <tserver_address> <tablet_id>
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
tserver_address |
Address of a Kudu Tablet Server of form 'hostname:port'. Port may be omitted if the Tablet Server is bound to the default port. |
string |
none |
tablet_id |
Tablet Identifier |
string |
none |
list: List all tablet replicas on a Kudu Tablet Server Usage:
kudu remote_replica list <tserver_address> [-noinclude_schema] [-table_name=<name>] [-tablets=<tablets>]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
tserver_address |
Address of a Kudu Tablet Server of form 'hostname:port'. Port may be omitted if the Tablet Server is bound to the default port. |
string |
none |
include_schema (optional) |
Whether to include the schema of each replica |
bool |
|
table_name (optional) |
Restrict output to a specific table by name |
string |
none |
tablets (optional) |
Comma-separated list of tablet IDs used to filter the list of replicas |
string |
none |
unsafe_change_config: Force the specified replica to adopt a new Raft config This tool is useful when a config change is necessary because a tablet cannot make progress with its current Raft configuration (e.g. to evict followers when a majority is unavailable).
Note: The members of the new Raft config must be a subset of (or the same as) the members of the existing committed Raft config.
Usage:
kudu remote_replica unsafe_change_config <tserver_address> <tablet_id> <peer uuids>…
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
tserver_address |
Address of a Kudu Tablet Server of form 'hostname:port'. Port may be omitted if the Tablet Server is bound to the default port. |
string |
none |
tablet_id |
Tablet Identifier |
string |
none |
peer uuids… |
List of peer uuids to be part of new config |
string |
none |
table: Operate on Kudu tablesdelete: Delete a table Usage:
kudu table delete <master_addresses> <table_name> [-nomodify_external_catalogs]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
master_addresses |
Either comma-separated list of Kudu master addresses where each address is of form 'hostname:port', or a cluster name if it has been configured in ${KUDU_CONFIG}/kudurc |
string |
none |
table_name |
Name of the table to delete |
string |
none |
modify_external_catalogs (optional) |
Whether to modify external catalogs, such as the Hive Metastore, when renaming or dropping a table. |
bool |
|
describe: Describe a table Usage:
kudu table describe <master_addresses> <table_name> [-show_attributes]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
master_addresses |
Either comma-separated list of Kudu master addresses where each address is of form 'hostname:port', or a cluster name if it has been configured in ${KUDU_CONFIG}/kudurc |
string |
none |
table_name |
Name of the table to describe |
string |
none |
show_attributes (optional) |
Whether to show column attributes, including column encoding type, compression type, and default read/write value. |
bool |
|
list: List tables Usage:
kudu table list <master_addresses> [-tables=<tables>] [-list_tablets]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
master_addresses |
Either comma-separated list of Kudu master addresses where each address is of form 'hostname:port', or a cluster name if it has been configured in ${KUDU_CONFIG}/kudurc |
string |
none |
tables (optional) |
Tables to include (comma-separated list of table names)If not specified, includes all tables. |
string |
none |
list_tablets (optional) |
Include tablet and replica UUIDs in the output |
bool |
|
locate_row: Locate which tablet a row belongs to Provide the primary key as a JSON array of primary key values, e.g. '[1, "foo", 2, "bar"]'. The output will be the tablet id associated with the row key. If there is no such tablet, an error message will be printed and the command will return a non-zero status
Usage:
kudu table locate_row <master_addresses> <table_name> <primary_key> [-check_row_existence]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
master_addresses |
Either comma-separated list of Kudu master addresses where each address is of form 'hostname:port', or a cluster name if it has been configured in ${KUDU_CONFIG}/kudurc |
string |
none |
table_name |
Name of the table to look up against |
string |
none |
primary_key |
String representation of the row’s primary key as a JSON array |
string |
none |
check_row_existence (optional) |
Also check for the existence of the row on the leader replica of the tablet. If found, the full row will be printed; if not found, an error message will be printed and the command will return a non-zero status. |
bool |
|
rename_column: Rename a column Usage:
kudu table rename_column <master_addresses> <table_name> <column_name> <new_column_name>
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
master_addresses |
Either comma-separated list of Kudu master addresses where each address is of form 'hostname:port', or a cluster name if it has been configured in ${KUDU_CONFIG}/kudurc |
string |
none |
table_name |
Name of the table to alter |
string |
none |
column_name |
Name of the table column to rename |
string |
none |
new_column_name |
New column name |
string |
none |
rename_table: Rename a table Usage:
kudu table rename_table <master_addresses> <table_name> <new_table_name> [-nomodify_external_catalogs]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
master_addresses |
Either comma-separated list of Kudu master addresses where each address is of form 'hostname:port', or a cluster name if it has been configured in ${KUDU_CONFIG}/kudurc |
string |
none |
table_name |
Name of the table to rename |
string |
none |
new_table_name |
New table name |
string |
none |
modify_external_catalogs (optional) |
Whether to modify external catalogs, such as the Hive Metastore, when renaming or dropping a table. |
bool |
|
scan: Scan rows from a table Scan rows from an existing table. See the help for the --predicates flag on how predicates can be specified.
Usage:
kudu table scan <master_addresses> <table_name> [-columns=<columns>] [-nofill_cache] [-num_threads=<threads>] [-predicates=<predicates>] [-tablets=<tablets>]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
master_addresses |
Either comma-separated list of Kudu master addresses where each address is of form 'hostname:port', or a cluster name if it has been configured in ${KUDU_CONFIG}/kudurc |
string |
none |
table_name |
Name of the table to scan |
string |
none |
columns (optional) |
Comma-separated list of column fields to include in output tables |
string |
|
fill_cache (optional) |
Whether to fill block cache when scanning. |
bool |
|
num_threads (optional) |
Number of threads to run. Each thread runs its own KuduSession. |
int32 |
|
predicates (optional) |
Query predicates on columns. Unlike traditional SQL syntax, the scan tool’s simple query predicates are represented in a simple JSON syntax. Three types of predicates are supported, including 'Comparison', 'InList' and 'IsNull'.
* The 'Comparison' type support ⇐, <, =, > and >=,
which can be represented as '[operator, column_name, value]',
e.g. '[">=", "col1", "value"]'
* The 'InList' type can be represented as
'["IN", column_name, [value1, value2, …]]'
e.g. '["IN", "col2", ["value1", "value2"]]'
* The 'IsNull' type determine whether the value is NULL or not,
which can be represented as '[operator, column_name]'
e.g. '["NULL", "col1"]', or '["NOTNULL", "col2"]'
Predicates can be combined together with predicate operators using the syntax
[operator, predicate, predicate, …, predicate].
For example,
["AND", [">=", "col1", "value"], ["NOTNULL", "col2"]]
The only supported predicate operator is |
string |
none |
tablets (optional) |
Tablets to check (comma-separated list of IDs) If not specified, checks all tablets. |
string |
none |
copy: Copy table data to another table Copy table data to another table; the two tables could be in the same cluster or not. The two tables must have the same table schema, but could have different partition schemas. Alternatively, the tool can create the new table using the same table and partition schema as the source table.
Usage:
kudu table copy <master_addresses> <table_name> <dest_master_addresses> [-nocreate_table] [-dst_table=<table>] [-num_threads=<threads>] [-predicates=<predicates>] [-tablets=<tablets>] [-write_type=<type>]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
master_addresses |
Either comma-separated list of Kudu master addresses where each address is of form 'hostname:port', or a cluster name if it has been configured in ${KUDU_CONFIG}/kudurc |
string |
none |
table_name |
Name of the source table |
string |
none |
dest_master_addresses |
Either comma-separated list of destination Kudu master addresses where each address is of form 'hostname:port', or a cluster name if it has been configured in ${KUDU_CONFIG}/kudurc |
string |
none |
create_table (optional) |
Whether to create the destination table if it doesn’t exist. |
bool |
|
dst_table (optional) |
The name of the destination table the data will be copied to. If the empty string, use the same name as the source table. |
string |
none |
num_threads (optional) |
Number of threads to run. Each thread runs its own KuduSession. |
int32 |
|
predicates (optional) |
Query predicates on columns. Unlike traditional SQL syntax, the scan tool’s simple query predicates are represented in a simple JSON syntax. Three types of predicates are supported, including 'Comparison', 'InList' and 'IsNull'.
* The 'Comparison' type support ⇐, <, =, > and >=,
which can be represented as '[operator, column_name, value]',
e.g. '[">=", "col1", "value"]'
* The 'InList' type can be represented as
'["IN", column_name, [value1, value2, …]]'
e.g. '["IN", "col2", ["value1", "value2"]]'
* The 'IsNull' type determine whether the value is NULL or not,
which can be represented as '[operator, column_name]'
e.g. '["NULL", "col1"]', or '["NOTNULL", "col2"]'
Predicates can be combined together with predicate operators using the syntax
[operator, predicate, predicate, …, predicate].
For example,
["AND", [">=", "col1", "value"], ["NOTNULL", "col2"]]
The only supported predicate operator is |
string |
none |
tablets (optional) |
Tablets to check (comma-separated list of IDs) If not specified, checks all tablets. |
string |
none |
write_type (optional) |
How data should be copied to the destination table. Valid values are 'insert', 'upsert' or the empty string. If the empty string, data will not be copied (useful when create_table is 'true'). |
string |
|
tablet: Operate on remote Kudu tabletsleader_step_down: Change the tablet’s leader Usage:
kudu tablet leader_step_down <master_addresses> <tablet_id> [-abrupt] [-new_leader_uuid=<uuid>]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
master_addresses |
Either comma-separated list of Kudu master addresses where each address is of form 'hostname:port', or a cluster name if it has been configured in ${KUDU_CONFIG}/kudurc |
string |
none |
tablet_id |
Tablet Identifier |
string |
none |
abrupt (optional) |
Whether the leader should step down without attempting to transfer leadership gracefully. A graceful transfer minimizes delays in tablet operations, but will fail if the tablet cannot arrange a successor. |
bool |
|
new_leader_uuid (optional) |
UUID of the server that leadership should be transferred to. Leadership may only be transferred to a voting member of the leader’s active config. If the designated successor cannot catch up to the leader within one election timeout, leadership transfer will not occur. If blank, the leader chooses its own successor, attempting to transfer leadership as soon as possible. This cannot be set if --abrupt is set. |
string |
none |
unsafe_replace_tablet: Replace a tablet with an empty one, deleting the previous tablet. Use this tool to repair a table when one of its tablets has permanently lost all of its replicas. It replaces the unrecoverable tablet with a new empty one representing the same partition. Its primary use is to jettison an unrecoverable tablet in order to make the rest of the table available.
|
The original tablet will be deleted. Its data will be permanently lost. Additionally, clients should be restarted before attempting to use the repaired table (see KUDU-2376). Usage: kudu tablet unsafe_replace_tablet <master_addresses> <tablet_id>
Arguments: |
| Name | Description | Type | Default |
|---|---|---|---|
master_addresses |
Either comma-separated list of Kudu master addresses where each address is of form 'hostname:port', or a cluster name if it has been configured in ${KUDU_CONFIG}/kudurc |
string |
none |
tablet_id |
Tablet Identifier |
string |
none |
change_config: Change a tablet’s Raft configurationadd_replica: Add a new replica to a tablet’s Raft configuration Usage:
kudu tablet change_config add_replica <master_addresses> <tablet_id> <ts_uuid> <replica_type>
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
master_addresses |
Either comma-separated list of Kudu master addresses where each address is of form 'hostname:port', or a cluster name if it has been configured in ${KUDU_CONFIG}/kudurc |
string |
none |
tablet_id |
Tablet Identifier |
string |
none |
ts_uuid |
UUID of the tablet server that should host the new replica |
string |
none |
replica_type |
New replica’s type. Must be VOTER or NON_VOTER. |
string |
none |
change_replica_type: Change the type of an existing replica in a tablet’s Raft configuration Usage:
kudu tablet change_config change_replica_type <master_addresses> <tablet_id> <ts_uuid> <replica_type>
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
master_addresses |
Either comma-separated list of Kudu master addresses where each address is of form 'hostname:port', or a cluster name if it has been configured in ${KUDU_CONFIG}/kudurc |
string |
none |
tablet_id |
Tablet Identifier |
string |
none |
ts_uuid |
UUID of the tablet server hosting the existing replica |
string |
none |
replica_type |
Existing replica’s new type. Must be VOTER or NON_VOTER. |
string |
none |
move_replica: Move a tablet replica from one tablet server to another The replica move tool effectively moves a replica from one tablet server to another by adding a replica to the new server and then removing it from the old one. It requires that ksck return no errors when run against the target tablet. If the move fails, the user should wait for any tablet copy to complete, and, if the copy succeeds, use remove_replica manually. If the copy fails, the new replica will be deleted automatically after some time, and then the move can be retried.
Usage:
kudu tablet change_config move_replica <master_addresses> <tablet_id> <from_ts_uuid> <to_ts_uuid>
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
master_addresses |
Either comma-separated list of Kudu master addresses where each address is of form 'hostname:port', or a cluster name if it has been configured in ${KUDU_CONFIG}/kudurc |
string |
none |
tablet_id |
Tablet Identifier |
string |
none |
from_ts_uuid |
UUID of the tablet server to move from |
string |
none |
to_ts_uuid |
UUID of the tablet server to move to |
string |
none |
remove_replica: Remove an existing replica from a tablet’s Raft configuration Usage:
kudu tablet change_config remove_replica <master_addresses> <tablet_id> <ts_uuid>
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
master_addresses |
Either comma-separated list of Kudu master addresses where each address is of form 'hostname:port', or a cluster name if it has been configured in ${KUDU_CONFIG}/kudurc |
string |
none |
tablet_id |
Tablet Identifier |
string |
none |
ts_uuid |
UUID of the tablet server hosting the existing replica |
string |
none |
test: Various test actionsmini_cluster: Spawn a control shell for running a mini-cluster The protocol for the control shell is protobuf-based and is documented in src/kudu/tools/tool.proto. It is currently considered to be highly experimental and subject to change.
Example JSON input to create and start a cluster:
{"createCluster":{"numTservers":3}}
{"startCluster":{}}
Usage:
kudu test mini_cluster [-serialization=<serialization>]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
serialization (optional) |
Serialization method to be used by the control shell. Valid values are 'json' (protobuf serialized into JSON and terminated with a newline character) or 'pb' (four byte protobuf message length in big endian followed by the protobuf message itself). |
string |
|
tserver: Operate on a Kudu Tablet Serverdump_memtrackers: Dump the memtrackers from a Kudu Tablet Server Usage:
kudu tserver dump_memtrackers <tserver_address> [-format=<format>] [-memtracker_output=<output>] [-timeout_ms=<ms>]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
tserver_address |
Address of a Kudu Tablet Server of form 'hostname:port'. Port may be omitted if the Tablet Server is bound to the default port. |
string |
none |
format (optional) |
Format to use for printing list output tables. Possible values: pretty, space, tsv, csv, and json |
string |
|
memtracker_output (optional) |
One of 'json', 'json_compact' or 'table'. Table output flattens the memtracker hierarchy. |
string |
|
timeout_ms (optional) |
RPC timeout in milliseconds |
int64 |
|
get_flags: Get the gflags for a Kudu Tablet Server Usage:
kudu tserver get_flags <tserver_address> [-all_flags] [-flag_tags=<tags>]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
tserver_address |
Address of a Kudu Tablet Server of form 'hostname:port'. Port may be omitted if the Tablet Server is bound to the default port. |
string |
none |
all_flags (optional) |
Whether to return all flags, or only flags that were explicitly set. |
bool |
|
flag_tags (optional) |
Comma-separated list of tags used to restrict which flags are returned. An empty value matches all tags |
string |
none |
set_flag: Change a gflag value on a Kudu Tablet Server Usage:
kudu tserver set_flag <tserver_address> <flag> <value> [-force]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
tserver_address |
Address of a Kudu Tablet Server of form 'hostname:port'. Port may be omitted if the Tablet Server is bound to the default port. |
string |
none |
flag |
Name of the gflag |
string |
none |
value |
New value for the gflag |
string |
none |
force (optional) |
If true, allows the set_flag command to set a flag which is not explicitly marked as runtime-settable. Such flag changes may be simply ignored on the server, or may cause the server to crash. |
bool |
|
status: Get the status of a Kudu Tablet Server Usage:
kudu tserver status <tserver_address>
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
tserver_address |
Address of a Kudu Tablet Server of form 'hostname:port'. Port may be omitted if the Tablet Server is bound to the default port. |
string |
none |
timestamp: Get the current timestamp of a Kudu Tablet Server Usage:
kudu tserver timestamp <tserver_address>
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
tserver_address |
Address of a Kudu Tablet Server of form 'hostname:port'. Port may be omitted if the Tablet Server is bound to the default port. |
string |
none |
list: List tablet servers in a Kudu cluster Usage:
kudu tserver list <master_addresses> [-columns=<columns>] [-format=<format>] [-timeout_ms=<ms>]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
master_addresses |
Either comma-separated list of Kudu master addresses where each address is of form 'hostname:port', or a cluster name if it has been configured in ${KUDU_CONFIG}/kudurc |
string |
none |
columns (optional) |
Comma-separated list of tserver info fields to include in output. Possible values: uuid, rpc-addresses, http-addresses, version, seqno, heartbeat and start_time |
string |
|
format (optional) |
Format to use for printing list output tables. Possible values: pretty, space, tsv, csv, and json |
string |
|
timeout_ms (optional) |
RPC timeout in milliseconds |
int64 |
|
wal: Operate on WAL (write-ahead log) filesdump: Dump a WAL (write-ahead log) file Usage:
kudu wal dump <path> [-print_entries=<entries>] [-noprint_meta] [-truncate_data=<data>]
Arguments:
| Name | Description | Type | Default |
|---|---|---|---|
path |
path to WAL file |
string |
none |
print_entries (optional) |
How to print entries: false|0|no = don’t print true|1|yes|decoded = print them decoded pb = print the raw protobuf id = print only their ids |
string |
|
print_meta (optional) |
Include metadata in output |
bool |
|
truncate_data (optional) |
Truncate the data fields to the given number of bytes before printing. Set to 0 to disable |
int32 |
|