yb-ts-cli

yb-ts-cli is a command line tool that can be used to perform an operation on a particular tablet server (yb-tserver). Some of the commands perform operations similar to yb-admin commands. The yb-admin commands focus on cluster administration, the yb-ts-cli commands apply to specific YB-TServer nodes.

yb-ts-cli is a binary file installed with YugabyteDB and is located in the bin directory of the YugabyteDB home directory.

Syntax

• host:port: The host and port of the tablet server. Default is localhost:9100.
• command: The operation to be performed. See Commands below.
• flags: The flags to be applied to the command. See Flags.

Command line help

To display the available online help, run yb-ts-cli without any commands or flags at the YugabyteDB home directory.

Commands

The following commands are available:

• are_tablets_running
• is_server_ready
• compact_all_tablets
• compact_tablet
• count_intents
• current_hybrid_time
• delete_tablet
• dump_tablet
• flush_all_tablets
• flush_tablet
• list_tablets
• set_flag
• status

are_tablets_running

If all tablets are running, returns "All tablets are running".

Syntax

• host:port: The host and port of the tablet server. Default is localhost:9100.

is_server_ready

Prints the number of tablets that have not yet bootstrapped. If all tablets have bootstrapped, returns "Tablet server is ready".

Syntax

• host:port: The host and port of the tablet server. Default is localhost:9100.

compact_all_tablets

Compact all tablets on the tablet server.

Syntax

• host:port: The host and port of the tablet server. Default is localhost:9100.

compact_tablet

Compact the specified tablet on the tablet server.

Syntax

• host:port: The host and port of the tablet server. Default is localhost:9100.
• tablet_id: The identifier of the tablet to compact.

count_intents

Print the count of uncommitted intents (or provisional records). Useful for debugging transactional workloads.

Syntax

• host:port: The host and port of the tablet server. Default is localhost:9100.

current_hybrid_time

Prints the value of the current hybrid time.

Syntax

• host:port: The host and port of the tablet server. Default is localhost:9100.

delete_tablet

Deletes the tablet with the specified tablet ID (tablet_id) and reason.

Syntax

• host:port: The host and port of the tablet server. Default is localhost:9100.
• tablet_id: The identifier (ID) for the tablet.
• reason-string: Text string providing useful information on why the tablet was deleted.

dump_tablet

Dump, or export, the specified tablet ID (tablet_id).

Syntax

• host:port: The host and port of the tablet server. Default is localhost:9100.
• tablet_id: The identifier (ID) for the tablet.

flush_all_tablets

Flush all tablets on the tablet server.

Syntax

• host:port: The host and port of the tablet server. Default is localhost:9100.

flush_tablet

Flush the specified tablet on the tablet server.

Syntax

• host:port: The host and port of the tablet server. Default is localhost:9100.
• tablet_id: The identifier of the tablet to compact.

list_tablets

Lists the tablets on the specified tablet server, displaying the following properties: column name, tablet ID, state, table name, shard, and schema.

Syntax

• host:port: The host and port of the tablet server. Default is localhost:9100.

set_flag

Sets the specified configuration flag for the tablet server.

Syntax

• host:port: The host and port of the tablet server. Default is localhost:9100.
• --force: Flag to allow a change to a flag that is not explicitly marked as runtime-settable. Note that the change may be ignored on the server or may cause the server to crash, if unsafe values are provided. See --force.
• flag: The yb-tserver configuration flag (without the -- prefix) to be set. See yb-tserver
• value: The value to be applied.

status

Prints the status of the tablet server, including information on the node instance, bound RPC addresses, bound HTTP addresses, and version information.

Syntax

• host:port: The host and port of the tablet server. Default is localhost:9100.

For an example, see Return the status of a tablet server

Flags

The following flags can be used, when specified, with the commands above.

--force

Use this flag with the set_flag command to allow a change to a flag that is not explicitly marked as runtime-settable. Note that the change may be ignored on the server or may cause the server to crash, if unsafe values are provided.

Default: false

--server-address

The address (host and port) of the tablet server to run against.

Default: localhost:9100

--timeout_ms

The duration, in milliseconds (ms), before the RPC request times out.

Default: 60000 (1000 ms = 1 sec)

Examples

Return the status of a tablet server

node_instance {
  permanent_uuid: "237678d61086489991080bdfc68a28db"
  instance_seqno: 1579278624770505
}
bound_rpc_addresses {
  host: "127.0.0.1"
  port: 9100
}
bound_http_addresses {
  host: "127.0.0.1"
  port: 9000
}
version_info {
  git_hash: "83610e77c7659c7587bc0c8aea76db47ff8e2df1"
  build_hostname: "yb-macmini-6.dev.yugabyte.com"
  build_timestamp: "06 Jan 2020 17:47:22 PST"
  build_username: "jenkins"
  build_clean_repo: true
  build_id: "743"
  build_type: "RELEASE"
  version_number: "2.0.10.0"
  build_number: "4"
}

Display the current hybrid time

6470519323472437248