nodetool describering

Returns the token ranges. See Data distribution overview.

Synopsis

nodetool [<connection_options>] describering
[--] [<keyspace_name> [<keyspace_name>  ...]]

Syntax conventions Description

Syntax conventions	Description
UPPERCASE	Literal keyword.
Lowercase	Not literal.
<`Italics>`	Variable value. Replace with a valid option or user-defined value.
`[ ]`	Optional. Square brackets ( `[ ]` ) surround optional command arguments. Do not type the square brackets.
`( )`	Group. Parentheses ( `( )` ) identify a group to choose from. Do not type the parentheses.
`\|`	Or. A vertical bar ( `\|` ) separates alternative elements. Type any one of the elements. Do not type the vertical bar.
`...`	Repeatable. An ellipsis ( `...` ) indicates that you can repeat the syntax element as often as required.
`'<Literal string>'`	Single quotation ( `'` ) marks must surround literal strings in CQL statements. Use single quotation marks to preserve upper case.
`{ <key>:<value> }`	Map collection. Braces ( `{ }` ) enclose map collections or key value pairs. A colon separates the key and the value.
`<<datatype1>,<datatype2>>`	Set, list, map, or tuple. Angle brackets ( `< >` ) enclose data types in a set, list, map, or tuple. Separate the data types with a comma.
`cql_statement;`	End CQL statement. A semicolon ( `;` ) terminates all CQL statements.
`[ -- ]`	Separate the command line options from the command arguments with two hyphens ( `--` ). This syntax is useful when arguments might be mistaken for command line options.
`' <<schema> ... </schema> >'`	Search CQL only: Single quotation marks ( `'` ) surround an entire XML schema declaration.
`@<xml_entity>='<xml_entity_type>'`	Search CQL only: Identify the entity and literal value to overwrite the XML element in the schema and solrconfig files.

UPPERCASE

Literal keyword.

Lowercase

Not literal.

<`Italics>`

Variable value. Replace with a valid option or user-defined value.

[ ]

Optional. Square brackets ( [ ] ) surround optional command arguments. Do not type the square brackets.

( )

Group. Parentheses ( ( ) ) identify a group to choose from. Do not type the parentheses.

|

Or. A vertical bar ( | ) separates alternative elements. Type any one of the elements. Do not type the vertical bar.

...

Repeatable. An ellipsis ( ... ) indicates that you can repeat the syntax element as often as required.

'<Literal string>'

Single quotation ( ' ) marks must surround literal strings in CQL statements. Use single quotation marks to preserve upper case.

{ <key>:<value> }

Map collection. Braces ( { } ) enclose map collections or key value pairs. A colon separates the key and the value.

<<datatype1>,<datatype2>>

Set, list, map, or tuple. Angle brackets ( < > ) enclose data types in a set, list, map, or tuple. Separate the data types with a comma.

cql_statement;

End CQL statement. A semicolon ( ; ) terminates all CQL statements.

[ -- ]

Separate the command line options from the command arguments with two hyphens ( -- ). This syntax is useful when arguments might be mistaken for command line options.

' <<schema> ... </schema> >'

Search CQL only: Single quotation marks ( ' ) surround an entire XML schema declaration.

@<xml_entity>='<xml_entity_type>'

Search CQL only: Identify the entity and literal value to overwrite the XML element in the schema and solrconfig files.

Definition

The short- and long-form options are comma-separated.

Connection options

-h, --host hostname: The hostname or IP address of a remote node or nodes. When omitted, the default is the local machine.
-p, --port jmx_port: The JMX port number.
-pw, --password jmxpassword: The JMX password for authenticating with secure JMX. If a password is not provided, you are prompted to enter one.
-pwf, --password-file jmx_password_filepath: The filepath to the file that stores JMX authentication credentials.
-u, --username jmx_username: The username for authenticating with secure JMX.

Command arguments

--: Separates an option from an argument that could be mistaken for an option.

keyspace_name: The keyspace name.

Examples

Get token range information on the cycling keyspace

nodetool describering cycling

Results:

Schema Version:1b04bd14-0324-3fc8-8bcb-9256d1e15f82
Keyspace: cycling
TokenRange:
                TokenRange(start_token:3074457345618258602, end_token:-9223372036854775808endpoints:[127.0.0.1, 127.0.0.2, 127.0.0.3]rpc_endpoints:[127.0.0.1, 127.0.0.2, 127.0.0.3]endpoint_details:[EndpointDetails(host:127.0.0.1, datacenter:datacenter1, rack:rack1)EndpointDetails(host:127.0.0.2, datacenter:datacenter1, rack:rack1)EndpointDetails(host:127.0.0.3, datacenter:datacenter1, rack:rack1)])
                TokenRange(start_token:-3074457345618258603, end_token:3074457345618258602endpoints:[127.0.0.3, 127.0.0.1, 127.0.0.2]rpc_endpoints:[127.0.0.3, 127.0.0.1, 127.0.0.2]endpoint_details:[EndpointDetails(host:127.0.0.3, datacenter:datacenter1, rack:rack1)EndpointDetails(host:127.0.0.1, datacenter:datacenter1, rack:rack1)EndpointDetails(host:127.0.0.2, datacenter:datacenter1, rack:rack1)])
                TokenRange(start_token:-9223372036854775808, end_token:-3074457345618258603endpoints:[127.0.0.2, 127.0.0.3, 127.0.0.1]rpc_endpoints:[127.0.0.2, 127.0.0.3, 127.0.0.1]endpoint_details:[EndpointDetails(host:127.0.0.2, datacenter:datacenter1, rack:rack1)EndpointDetails(host:127.0.0.3, datacenter:datacenter1, rack:rack1)EndpointDetails(host:127.0.0.1, datacenter:datacenter1, rack:rack1)])