http://git-wip-us.apache.org/repos/asf/kudu/blob/87b27857/docs/command_line_tools_reference.html ---------------------------------------------------------------------- diff --git a/docs/command_line_tools_reference.html b/docs/command_line_tools_reference.html new file mode 100644 index 0000000..6653816 --- /dev/null +++ b/docs/command_line_tools_reference.html @@ -0,0 +1,3711 @@ +--- +title: Apache Kudu Command Line Tools Reference +layout: default +active_nav: docs +last_updated: 'Last updated 2018-12-07 16:28:39 CET' +--- +<!-- + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> + + +<div class="container"> + <div class="row"> + <div class="col-md-9"> + +<h1>Apache Kudu Command Line Tools Reference</h1> + <div class="sect1"> +<h2 id="_command_hierarchy"><a class="link" href="#_command_hierarchy">Command Hierarchy</a></h2> +<div class="sectionbody"> +<div class="ulist"> +<ul> +<li> +<p><a href="#cluster">cluster</a></p> +<div class="ulist"> +<ul> +<li> +<p><a href="#cluster-ksck">ksck</a></p> +</li> +<li> +<p><a href="#cluster-rebalance">rebalance</a></p> +</li> +</ul> +</div> +</li> +<li> +<p><a href="#diagnose">diagnose</a></p> +<div class="ulist"> +<ul> +<li> +<p><a href="#diagnose-parse_stacks">parse_stacks</a></p> +</li> +</ul> +</div> +</li> +<li> +<p><a href="#fs">fs</a></p> +<div class="ulist"> +<ul> +<li> +<p><a href="#fs-check">check</a></p> +</li> +<li> +<p><a href="#fs-format">format</a></p> +</li> +<li> +<p><a href="#fs-list">list</a></p> +</li> +<li> +<p><a href="#fs-update_dirs">update_dirs</a></p> +</li> +<li> +<p><a href="#fs-dump">dump</a></p> +<div class="ulist"> +<ul> +<li> +<p><a href="#dump-block">block</a></p> +</li> +<li> +<p><a href="#dump-cfile">cfile</a></p> +</li> +<li> +<p><a href="#dump-tree">tree</a></p> +</li> +<li> +<p><a href="#dump-uuid">uuid</a></p> +</li> +</ul> +</div> +</li> +</ul> +</div> +</li> +<li> +<p><a href="#hms">hms</a></p> +<div class="ulist"> +<ul> +<li> +<p><a href="#hms-check">check</a></p> +</li> +<li> +<p><a href="#hms-downgrade">downgrade</a></p> +</li> +<li> +<p><a href="#hms-fix">fix</a></p> +</li> +<li> +<p><a href="#hms-precheck">precheck</a></p> +</li> +</ul> +</div> +</li> +<li> +<p><a href="#local_replica">local_replica</a></p> +<div class="ulist"> +<ul> +<li> +<p><a href="#local_replica-copy_from_remote">copy_from_remote</a></p> +</li> +<li> +<p><a href="#local_replica-data_size">data_size</a></p> +</li> +<li> +<p><a href="#local_replica-delete">delete</a></p> +</li> +<li> +<p><a href="#local_replica-list">list</a></p> +</li> +<li> +<p><a href="#local_replica-cmeta">cmeta</a></p> +<div class="ulist"> +<ul> +<li> +<p><a href="#cmeta-print_replica_uuids">print_replica_uuids</a></p> +</li> +<li> +<p><a href="#cmeta-rewrite_raft_config">rewrite_raft_config</a></p> +</li> +<li> +<p><a href="#cmeta-set_term">set_term</a></p> +</li> +</ul> +</div> +</li> +<li> +<p><a href="#local_replica-dump">dump</a></p> +<div class="ulist"> +<ul> +<li> +<p><a href="#dump-block_ids">block_ids</a></p> +</li> +<li> +<p><a href="#dump-meta">meta</a></p> +</li> +<li> +<p><a href="#dump-rowset">rowset</a></p> +</li> +<li> +<p><a href="#dump-wals">wals</a></p> +</li> +</ul> +</div> +</li> +</ul> +</div> +</li> +<li> +<p><a href="#master">master</a></p> +<div class="ulist"> +<ul> +<li> +<p><a href="#master-get_flags">get_flags</a></p> +</li> +<li> +<p><a href="#master-set_flag">set_flag</a></p> +</li> +<li> +<p><a href="#master-status">status</a></p> +</li> +<li> +<p><a href="#master-timestamp">timestamp</a></p> +</li> +<li> +<p><a href="#master-list">list</a></p> +</li> +</ul> +</div> +</li> +<li> +<p><a href="#pbc">pbc</a></p> +<div class="ulist"> +<ul> +<li> +<p><a href="#pbc-dump">dump</a></p> +</li> +<li> +<p><a href="#pbc-edit">edit</a></p> +</li> +</ul> +</div> +</li> +<li> +<p><a href="#perf">perf</a></p> +<div class="ulist"> +<ul> +<li> +<p><a href="#perf-loadgen">loadgen</a></p> +</li> +</ul> +</div> +</li> +<li> +<p><a href="#remote_replica">remote_replica</a></p> +<div class="ulist"> +<ul> +<li> +<p><a href="#remote_replica-check">check</a></p> +</li> +<li> +<p><a href="#remote_replica-copy">copy</a></p> +</li> +<li> +<p><a href="#remote_replica-delete">delete</a></p> +</li> +<li> +<p><a href="#remote_replica-dump">dump</a></p> +</li> +<li> +<p><a href="#remote_replica-list">list</a></p> +</li> +<li> +<p><a href="#remote_replica-unsafe_change_config">unsafe_change_config</a></p> +</li> +</ul> +</div> +</li> +<li> +<p><a href="#table">table</a></p> +<div class="ulist"> +<ul> +<li> +<p><a href="#table-delete">delete</a></p> +</li> +<li> +<p><a href="#table-rename_table">rename_table</a></p> +</li> +<li> +<p><a href="#table-rename_column">rename_column</a></p> +</li> +<li> +<p><a href="#table-list">list</a></p> +</li> +</ul> +</div> +</li> +<li> +<p><a href="#tablet">tablet</a></p> +<div class="ulist"> +<ul> +<li> +<p><a href="#tablet-leader_step_down">leader_step_down</a></p> +</li> +<li> +<p><a href="#tablet-unsafe_replace_tablet">unsafe_replace_tablet</a></p> +</li> +<li> +<p><a href="#tablet-change_config">change_config</a></p> +<div class="ulist"> +<ul> +<li> +<p><a href="#change_config-add_replica">add_replica</a></p> +</li> +<li> +<p><a href="#change_config-change_replica_type">change_replica_type</a></p> +</li> +<li> +<p><a href="#change_config-move_replica">move_replica</a></p> +</li> +<li> +<p><a href="#change_config-remove_replica">remove_replica</a></p> +</li> +</ul> +</div> +</li> +</ul> +</div> +</li> +<li> +<p><a href="#test">test</a></p> +<div class="ulist"> +<ul> +<li> +<p><a href="#test-mini_cluster">mini_cluster</a></p> +</li> +</ul> +</div> +</li> +<li> +<p><a href="#tserver">tserver</a></p> +<div class="ulist"> +<ul> +<li> +<p><a href="#tserver-get_flags">get_flags</a></p> +</li> +<li> +<p><a href="#tserver-set_flag">set_flag</a></p> +</li> +<li> +<p><a href="#tserver-status">status</a></p> +</li> +<li> +<p><a href="#tserver-timestamp">timestamp</a></p> +</li> +<li> +<p><a href="#tserver-list">list</a></p> +</li> +</ul> +</div> +</li> +<li> +<p><a href="#wal">wal</a></p> +<div class="ulist"> +<ul> +<li> +<p><a href="#wal-dump">dump</a></p> +</li> +</ul> +</div> +</li> +</ul> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_command_details"><a class="link" href="#_command_details">Command Details</a></h2> +<div class="sectionbody"> +<div class="sect2"> +<h3 id="cluster"><a class="link" href="#cluster"><code>cluster</code>: Operate on a Kudu cluster</a></h3> +<div class="paragraph"> +<p><br></p> +</div> +<div class="sect3"> +<h4 id="cluster-ksck"><a class="link" href="#cluster-ksck"><code>ksck</code>: Check the health of a Kudu cluster </a></h4> +<div class="paragraph"> +<p>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.<br> +<strong>Usage:</strong><br> +<code>kudu cluster ksck <master_addresses> [-checksum_cache_blocks] [-checksum_scan] [-checksum_scan_concurrency=<concurrency>] [-nochecksum_snapshot] [-checksum_timeout_sec=<sec>] [-color=<color>] [-noconsensus] [-ksck_format=<format>] [-tables=<tables>] [-tablets=<tablets>]</code> +<br> +<strong>Arguments:</strong></p> +</div> +<table class="tableblock frame-topbot grid-all spread"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Name</th> +<th class="tableblock halign-left valign-top">Description</th> +<th class="tableblock halign-left valign-top">Type</th> +<th class="tableblock halign-left valign-top">Default</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">master_addresses</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Comma-separated list of Kudu Master addresses where each address is of form 'hostname:port'</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">checksum_cache_blocks (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Should the checksum scanners cache the read blocks</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">checksum_scan (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Perform a checksum scan on data in the cluster.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">checksum_scan_concurrency (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Number of concurrent checksum scans to execute per tablet server.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">int32</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>4</code></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">checksum_snapshot (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Should the checksum scanner use a snapshot scan?</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">checksum_timeout_sec (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Maximum total seconds to wait for a checksum scan to complete before timing out.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">int32</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>86400</code></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">color (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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'.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>auto</code></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">consensus (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Whether to check the consensus state from each tablet against the master.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">ksck_format (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>plain_concise</code></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">tables (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Tables to include (comma-separated list of table names)If not specified, includes all tables.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">tablets (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Tablets to check (comma-separated list of IDs) If not specified, checks all tablets.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p><br></p> +</div> +</div> +<div class="sect3"> +<h4 id="cluster-rebalance"><a class="link" href="#cluster-rebalance"><code>rebalance</code>: Move tablet replicas between tablet servers to balance replica counts for each table and for the cluster as a whole. </a></h4> +<div class="paragraph"> +<p>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.<br> +<strong>Usage:</strong><br> +<code>kudu cluster rebalance <master_addresses> [-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>]</code> +<br> +<strong>Arguments:</strong></p> +</div> +<table class="tableblock frame-topbot grid-all spread"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Name</th> +<th class="tableblock halign-left valign-top">Description</th> +<th class="tableblock halign-left valign-top">Type</th> +<th class="tableblock halign-left valign-top">Default</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">master_addresses</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Comma-separated list of Kudu Master addresses where each address is of form 'hostname:port'</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">max_moves_per_server (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Maximum number of replica moves to perform concurrently on one tablet server: 'move from' and 'move to' are counted as separate move operations.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">uint32</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>5</code></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">max_run_time_sec (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Maximum time to run the rebalancing, in seconds. Specifying 0 means not imposing any limit on the rebalancing run time.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">int64</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>0</code></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">max_staleness_interval_sec (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">uint32</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>300</code></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">move_single_replicas (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>auto</code></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">output_replica_distribution_details (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Whether to output details on per-table and per-server replica distribution</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">report_only (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Whether to report on table- and cluster-wide replica distribution skew and exit without doing any actual rebalancing</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">tables (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Tables to include (comma-separated list of table names)If not specified, includes all tables.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p><br></p> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="diagnose"><a class="link" href="#diagnose"><code>diagnose</code>: Diagnostic tools for Kudu servers and clusters</a></h3> +<div class="paragraph"> +<p><br></p> +</div> +<div class="sect3"> +<h4 id="diagnose-parse_stacks"><a class="link" href="#diagnose-parse_stacks"><code>parse_stacks</code>: Parse sampled stack traces out of a diagnostics log </a></h4> +<div class="paragraph"> +<p><strong>Usage:</strong><br> +<code>kudu diagnose parse_stacks <path>…​</code> +<br> +<strong>Arguments:</strong></p> +</div> +<table class="tableblock frame-topbot grid-all spread"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Name</th> +<th class="tableblock halign-left valign-top">Description</th> +<th class="tableblock halign-left valign-top">Type</th> +<th class="tableblock halign-left valign-top">Default</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">path…​</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">path to log file(s) to parse</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p><br></p> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="fs"><a class="link" href="#fs"><code>fs</code>: Operate on a local Kudu filesystem</a></h3> +<div class="paragraph"> +<p><br></p> +</div> +<div class="sect3"> +<h4 id="fs-check"><a class="link" href="#fs-check"><code>check</code>: Check a Kudu filesystem for inconsistencies </a></h4> +<div class="paragraph"> +<p><strong>Usage:</strong><br> +<code>kudu fs check [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>] [-repair]</code> +<br> +<strong>Arguments:</strong></p> +</div> +<table class="tableblock frame-topbot grid-all spread"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Name</th> +<th class="tableblock halign-left valign-top">Description</th> +<th class="tableblock halign-left valign-top">Type</th> +<th class="tableblock halign-left valign-top">Default</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_data_dirs (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_metadata_dir (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_wal_dir (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">repair (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Repair any inconsistencies in the filesystem.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p><br></p> +</div> +</div> +<div class="sect3"> +<h4 id="fs-format"><a class="link" href="#fs-format"><code>format</code>: Format a new Kudu filesystem </a></h4> +<div class="paragraph"> +<p><strong>Usage:</strong><br> +<code>kudu fs format [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>] [-uuid=<uuid>]</code> +<br> +<strong>Arguments:</strong></p> +</div> +<table class="tableblock frame-topbot grid-all spread"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Name</th> +<th class="tableblock halign-left valign-top">Description</th> +<th class="tableblock halign-left valign-top">Type</th> +<th class="tableblock halign-left valign-top">Default</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_data_dirs (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_metadata_dir (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_wal_dir (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">uuid (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">The uuid to use in the filesystem. If not provided, one is generated</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p><br></p> +</div> +</div> +<div class="sect3"> +<h4 id="fs-list"><a class="link" href="#fs-list"><code>list</code>: List metadata for on-disk tablets, rowsets, blocks, and cfiles </a></h4> +<div class="paragraph"> +<p>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.</p> +</div> +<div class="paragraph"> +<p>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.<br> +<strong>Usage:</strong><br> +<code>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]</code> +<br> +<strong>Arguments:</strong></p> +</div> +<table class="tableblock frame-topbot grid-all spread"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Name</th> +<th class="tableblock halign-left valign-top">Description</th> +<th class="tableblock halign-left valign-top">Type</th> +<th class="tableblock halign-left valign-top">Default</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_data_dirs (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_metadata_dir (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_wal_dir (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">table_id (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Restrict output to a specific table by id</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">table_name (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Restrict output to a specific table by name</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">tablet_id (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Restrict output to a specific tablet</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">rowset_id (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Restrict output to a specific rowset</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">int64</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>-1</code></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">column_id (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Restrict output to a specific column</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">int32</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>-1</code></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">block_id (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Restrict output to a specific block</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">uint64</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>0</code></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">columns (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>tablet-id, rowset-id, block-id, block-kind</code></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">format (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Format to use for printing list output tables. +Possible values: pretty, space, tsv, csv, and json</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>pretty</code></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">h (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Pretty-print values in human-readable units</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p><br></p> +</div> +</div> +<div class="sect3"> +<h4 id="fs-update_dirs"><a class="link" href="#fs-update_dirs"><code>update_dirs</code>: Updates the set of data directories in an existing Kudu filesystem </a></h4> +<div class="paragraph"> +<p>If a data directory is in use by a tablet and is removed, the operation will fail unless --force is also used<br> +<strong>Usage:</strong><br> +<code>kudu fs update_dirs [-force] [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>]</code> +<br> +<strong>Arguments:</strong></p> +</div> +<table class="tableblock frame-topbot grid-all spread"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Name</th> +<th class="tableblock halign-left valign-top">Description</th> +<th class="tableblock halign-left valign-top">Type</th> +<th class="tableblock halign-left valign-top">Default</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">force (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_data_dirs (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_metadata_dir (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_wal_dir (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p><br></p> +</div> +</div> +<div class="sect3"> +<h4 id="fs-dump"><a class="link" href="#fs-dump"><code>dump</code>: Dump a Kudu filesystem</a></h4> +<div class="paragraph"> +<p><br></p> +</div> +<div class="sect4"> +<h5 id="dump-block"><a class="link" href="#dump-block"><code>block</code>: Dump the binary contents of a data block </a></h5> +<div class="paragraph"> +<p>This performs no parsing or interpretation of the data stored in the block but rather outputs its binary contents directly.<br> +<strong>Usage:</strong><br> +<code>kudu fs dump block <block_id> [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>]</code> +<br> +<strong>Arguments:</strong></p> +</div> +<table class="tableblock frame-topbot grid-all spread"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Name</th> +<th class="tableblock halign-left valign-top">Description</th> +<th class="tableblock halign-left valign-top">Type</th> +<th class="tableblock halign-left valign-top">Default</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">block_id</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">block identifier</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_data_dirs (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_metadata_dir (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_wal_dir (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p><br></p> +</div> +</div> +<div class="sect4"> +<h5 id="dump-cfile"><a class="link" href="#dump-cfile"><code>cfile</code>: Dump the contents of a CFile (column file) </a></h5> +<div class="paragraph"> +<p>This interprets the contents of a CFile-formatted block and outputs the decoded row data.<br> +<strong>Usage:</strong><br> +<code>kudu fs dump cfile <block_id> [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>] [-noprint_meta] [-noprint_rows]</code> +<br> +<strong>Arguments:</strong></p> +</div> +<table class="tableblock frame-topbot grid-all spread"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Name</th> +<th class="tableblock halign-left valign-top">Description</th> +<th class="tableblock halign-left valign-top">Type</th> +<th class="tableblock halign-left valign-top">Default</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">block_id</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">block identifier</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_data_dirs (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_metadata_dir (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_wal_dir (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">print_meta (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Include metadata in output</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">print_rows (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Print each row in the CFile</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p><br></p> +</div> +</div> +<div class="sect4"> +<h5 id="dump-tree"><a class="link" href="#dump-tree"><code>tree</code>: Dump the tree of a Kudu filesystem </a></h5> +<div class="paragraph"> +<p><strong>Usage:</strong><br> +<code>kudu fs dump tree [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>]</code> +<br> +<strong>Arguments:</strong></p> +</div> +<table class="tableblock frame-topbot grid-all spread"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Name</th> +<th class="tableblock halign-left valign-top">Description</th> +<th class="tableblock halign-left valign-top">Type</th> +<th class="tableblock halign-left valign-top">Default</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_data_dirs (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_metadata_dir (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_wal_dir (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p><br></p> +</div> +</div> +<div class="sect4"> +<h5 id="dump-uuid"><a class="link" href="#dump-uuid"><code>uuid</code>: Dump the UUID of a Kudu filesystem </a></h5> +<div class="paragraph"> +<p><strong>Usage:</strong><br> +<code>kudu fs dump uuid [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>]</code> +<br> +<strong>Arguments:</strong></p> +</div> +<table class="tableblock frame-topbot grid-all spread"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Name</th> +<th class="tableblock halign-left valign-top">Description</th> +<th class="tableblock halign-left valign-top">Type</th> +<th class="tableblock halign-left valign-top">Default</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_data_dirs (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_metadata_dir (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_wal_dir (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p><br></p> +</div> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="hms"><a class="link" href="#hms"><code>hms</code>: Operate on remote Hive Metastores</a></h3> +<div class="paragraph"> +<p><br></p> +</div> +<div class="sect3"> +<h4 id="hms-check"><a class="link" href="#hms-check"><code>check</code>: Check metadata consistency between Kudu and the Hive Metastore catalogs </a></h4> +<div class="paragraph"> +<p><strong>Usage:</strong><br> +<code>kudu hms check <master_addresses> [-hive_metastore_sasl_enabled] [-hive_metastore_uris=<uris>]</code> +<br> +<strong>Arguments:</strong></p> +</div> +<table class="tableblock frame-topbot grid-all spread"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Name</th> +<th class="tableblock halign-left valign-top">Description</th> +<th class="tableblock halign-left valign-top">Type</th> +<th class="tableblock halign-left valign-top">Default</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">master_addresses</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Comma-separated list of Kudu Master addresses where each address is of form 'hostname:port'</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">hive_metastore_sasl_enabled (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">hive_metastore_uris (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p><br></p> +</div> +</div> +<div class="sect3"> +<h4 id="hms-downgrade"><a class="link" href="#hms-downgrade"><code>downgrade</code>: Downgrade the metadata to legacy format for Kudu and the Hive Metastores </a></h4> +<div class="paragraph"> +<p><strong>Usage:</strong><br> +<code>kudu hms downgrade <master_addresses> [-hive_metastore_sasl_enabled] [-hive_metastore_uris=<uris>]</code> +<br> +<strong>Arguments:</strong></p> +</div> +<table class="tableblock frame-topbot grid-all spread"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Name</th> +<th class="tableblock halign-left valign-top">Description</th> +<th class="tableblock halign-left valign-top">Type</th> +<th class="tableblock halign-left valign-top">Default</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">master_addresses</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Comma-separated list of Kudu Master addresses where each address is of form 'hostname:port'</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">hive_metastore_sasl_enabled (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">hive_metastore_uris (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p><br></p> +</div> +</div> +<div class="sect3"> +<h4 id="hms-fix"><a class="link" href="#hms-fix"><code>fix</code>: Fix automatically-repairable metadata inconsistencies in the Kudu and Hive Metastore catalogs </a></h4> +<div class="paragraph"> +<p><strong>Usage:</strong><br> +<code>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>]</code> +<br> +<strong>Arguments:</strong></p> +</div> +<table class="tableblock frame-topbot grid-all spread"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Name</th> +<th class="tableblock halign-left valign-top">Description</th> +<th class="tableblock halign-left valign-top">Type</th> +<th class="tableblock halign-left valign-top">Default</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">master_addresses</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Comma-separated list of Kudu Master addresses where each address is of form 'hostname:port'</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">dryrun (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Print a message for each fix, but do not make modifications to Kudu or the Hive Metastore.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">drop_orphan_hms_tables (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Drop orphan Hive Metastore tables which refer to non-existent Kudu tables.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">create_missing_hms_tables (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Create a Hive Metastore table for each Kudu table which is missing one.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fix_inconsistent_tables (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">upgrade_hms_tables (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Upgrade Hive Metastore tables from the legacy Impala metadata format to the new Kudu metadata format.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">hive_metastore_sasl_enabled (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">hive_metastore_uris (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p><br></p> +</div> +</div> +<div class="sect3"> +<h4 id="hms-precheck"><a class="link" href="#hms-precheck"><code>precheck</code>: Check that the Kudu cluster is prepared to enable the Hive Metastore integration </a></h4> +<div class="paragraph"> +<p><strong>Usage:</strong><br> +<code>kudu hms precheck <master_addresses></code> +<br> +<strong>Arguments:</strong></p> +</div> +<table class="tableblock frame-topbot grid-all spread"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Name</th> +<th class="tableblock halign-left valign-top">Description</th> +<th class="tableblock halign-left valign-top">Type</th> +<th class="tableblock halign-left valign-top">Default</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">master_addresses</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Comma-separated list of Kudu Master addresses where each address is of form 'hostname:port'</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p><br></p> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="local_replica"><a class="link" href="#local_replica"><code>local_replica</code>: Operate on local tablet replicas via the local filesystem</a></h3> +<div class="paragraph"> +<p><br></p> +</div> +<div class="sect3"> +<h4 id="local_replica-copy_from_remote"><a class="link" href="#local_replica-copy_from_remote"><code>copy_from_remote</code>: Copy a tablet replica from a remote server </a></h4> +<div class="paragraph"> +<p><strong>Usage:</strong><br> +<code>kudu local_replica copy_from_remote <tablet_id> <source> [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>]</code> +<br> +<strong>Arguments:</strong></p> +</div> +<table class="tableblock frame-topbot grid-all spread"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Name</th> +<th class="tableblock halign-left valign-top">Description</th> +<th class="tableblock halign-left valign-top">Type</th> +<th class="tableblock halign-left valign-top">Default</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">tablet_id</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Tablet Identifier</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">source</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Source RPC address of form hostname:port</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_data_dirs (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_metadata_dir (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_wal_dir (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p><br></p> +</div> +</div> +<div class="sect3"> +<h4 id="local_replica-data_size"><a class="link" href="#local_replica-data_size"><code>data_size</code>: Summarize the data size/space usage of the given local replica(s). </a></h4> +<div class="paragraph"> +<p><strong>Usage:</strong><br> +<code>kudu local_replica data_size <tablet_id_pattern> [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>] [-format=<format>]</code> +<br> +<strong>Arguments:</strong></p> +</div> +<table class="tableblock frame-topbot grid-all spread"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Name</th> +<th class="tableblock halign-left valign-top">Description</th> +<th class="tableblock halign-left valign-top">Type</th> +<th class="tableblock halign-left valign-top">Default</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">tablet_id_pattern</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Tablet identifier pattern. This argument supports basic glob syntax: '*' matches 0 or more wildcard characters.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_data_dirs (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_metadata_dir (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_wal_dir (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">format (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Format to use for printing list output tables. +Possible values: pretty, space, tsv, csv, and json</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>pretty</code></p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p><br></p> +</div> +</div> +<div class="sect3"> +<h4 id="local_replica-delete"><a class="link" href="#local_replica-delete"><code>delete</code>: Delete a tablet replica from the local filesystem. By default, leaves a tombstone record. </a></h4> +<div class="paragraph"> +<p><strong>Usage:</strong><br> +<code>kudu local_replica delete <tablet_id> [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>] [-clean_unsafe]</code> +<br> +<strong>Arguments:</strong></p> +</div> +<table class="tableblock frame-topbot grid-all spread"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Name</th> +<th class="tableblock halign-left valign-top">Description</th> +<th class="tableblock halign-left valign-top">Type</th> +<th class="tableblock halign-left valign-top">Default</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">tablet_id</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Tablet Identifier</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_data_dirs (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_metadata_dir (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_wal_dir (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">clean_unsafe (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p><br></p> +</div> +</div> +<div class="sect3"> +<h4 id="local_replica-list"><a class="link" href="#local_replica-list"><code>list</code>: Show list of tablet replicas in the local filesystem </a></h4> +<div class="paragraph"> +<p><strong>Usage:</strong><br> +<code>kudu local_replica list [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>] [-list_detail]</code> +<br> +<strong>Arguments:</strong></p> +</div> +<table class="tableblock frame-topbot grid-all spread"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Name</th> +<th class="tableblock halign-left valign-top">Description</th> +<th class="tableblock halign-left valign-top">Type</th> +<th class="tableblock halign-left valign-top">Default</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_data_dirs (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_metadata_dir (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_wal_dir (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">list_detail (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Print partition info for the local replicas</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p><br></p> +</div> +</div> +<div class="sect3"> +<h4 id="local_replica-cmeta"><a class="link" href="#local_replica-cmeta"><code>cmeta</code>: Operate on a local tablet replica’s consensus metadata file</a></h4> +<div class="paragraph"> +<p><br></p> +</div> +<div class="sect4"> +<h5 id="cmeta-print_replica_uuids"><a class="link" href="#cmeta-print_replica_uuids"><code>print_replica_uuids</code>: Print all tablet replica peer UUIDs found in a tablet’s Raft configuration </a></h5> +<div class="paragraph"> +<p><strong>Usage:</strong><br> +<code>kudu local_replica cmeta print_replica_uuids <tablet_id> [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>]</code> +<br> +<strong>Arguments:</strong></p> +</div> +<table class="tableblock frame-topbot grid-all spread"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Name</th> +<th class="tableblock halign-left valign-top">Description</th> +<th class="tableblock halign-left valign-top">Type</th> +<th class="tableblock halign-left valign-top">Default</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">tablet_id</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Tablet Identifier</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_data_dirs (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_metadata_dir (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_wal_dir (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p><br></p> +</div> +</div> +<div class="sect4"> +<h5 id="cmeta-rewrite_raft_config"><a class="link" href="#cmeta-rewrite_raft_config"><code>rewrite_raft_config</code>: Rewrite a tablet replica’s Raft configuration </a></h5> +<div class="paragraph"> +<p><strong>Usage:</strong><br> +<code>kudu local_replica cmeta rewrite_raft_config <tablet_id> <peers>…​ [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>]</code> +<br> +<strong>Arguments:</strong></p> +</div> +<table class="tableblock frame-topbot grid-all spread"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Name</th> +<th class="tableblock halign-left valign-top">Description</th> +<th class="tableblock halign-left valign-top">Type</th> +<th class="tableblock halign-left valign-top">Default</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">tablet_id</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Tablet Identifier</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">peers…​</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">List of peers where each peer is of form 'uuid:hostname:port'</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_data_dirs (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_metadata_dir (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_wal_dir (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p><br></p> +</div> +</div> +<div class="sect4"> +<h5 id="cmeta-set_term"><a class="link" href="#cmeta-set_term"><code>set_term</code>: Bump the current term stored in consensus metadata </a></h5> +<div class="paragraph"> +<p><strong>Usage:</strong><br> +<code>kudu local_replica cmeta set_term <tablet_id> <term> [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>]</code> +<br> +<strong>Arguments:</strong></p> +</div> +<table class="tableblock frame-topbot grid-all spread"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Name</th> +<th class="tableblock halign-left valign-top">Description</th> +<th class="tableblock halign-left valign-top">Type</th> +<th class="tableblock halign-left valign-top">Default</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">tablet_id</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Tablet Identifier</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">term</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">the new raft term (must be greater than the current term)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_data_dirs (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_metadata_dir (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_wal_dir (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Directory with write-ahead logs. If this is not specified, the program will not start. May be the same as fs_data_dirs</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p><br></p> +</div> +</div> +</div> +<div class="sect3"> +<h4 id="local_replica-dump"><a class="link" href="#local_replica-dump"><code>dump</code>: Dump a Kudu filesystem</a></h4> +<div class="paragraph"> +<p><br></p> +</div> +<div class="sect4"> +<h5 id="dump-block_ids"><a class="link" href="#dump-block_ids"><code>block_ids</code>: Dump the IDs of all blocks belonging to a local replica </a></h5> +<div class="paragraph"> +<p><strong>Usage:</strong><br> +<code>kudu local_replica dump block_ids <tablet_id> [-fs_data_dirs=<dirs>] [-fs_metadata_dir=<dir>] [-fs_wal_dir=<dir>]</code> +<br> +<strong>Arguments:</strong></p> +</div> +<table class="tableblock frame-topbot grid-all spread"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 25%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Name</th> +<th class="tableblock halign-left valign-top">Description</th> +<th class="tableblock halign-left valign-top">Type</th> +<th class="tableblock halign-left valign-top">Default</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">tablet_id</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Tablet Identifier</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_data_dirs (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_metadata_dir (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">fs_wal_dir (optional)</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Directory with writ
<TRUNCATED>
