nodetool settimeout
Temporarily sets the timeout for the given timeout type by overriding the corresponding setting in cassandra.yaml
:
-
read - read_request_timeout_in_ms
-
range - range_request_timeout_in_ms
-
write - write_request_timeout_in_ms
-
counterwrite - counter_write_request_timeout_in_ms
-
cascontention - cas_contention_timeout_in_ms
-
truncate - truncate_request_timeout_in_ms
-
misc, such as general
rpc_timeout_in_ms
To persist the setting, change the cassandra.yaml
setting.
To discover the current timeouts, use nodetool gettimeout.
Synopsis
nodetool [<connection_options>] settimeout
[--] timeout_type <timeout_in_ms>
Syntax conventions | Description |
---|---|
UPPERCASE |
Literal keyword. |
Lowercase |
Not literal. |
<`Italics>` |
Variable value. Replace with a valid option or user-defined value. |
|
Optional.
Square brackets ( |
|
Group.
Parentheses ( |
|
Or.
A vertical bar ( |
|
Repeatable.
An ellipsis ( |
|
Single quotation ( |
|
Map collection.
Braces ( |
|
Set, list, map, or tuple.
Angle brackets ( |
|
End CQL statement.
A semicolon ( |
|
Separate the command line options from the command arguments with two hyphens ( |
|
Search CQL only: Single quotation marks ( |
|
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.
- timeout_in_ms
-
Time to wait in milliseconds.
0 - Disables socket streaming timeout.
- timeout_type
-
The timeout type.
-
read
-
range
-
write
-
counterwrite
-
cascontention
-
truncate
-
streamingsocket
-
misc (general
rpc_timeout_in_ms
)
-
Examples
Set write timeout for 15 ms
nodetool settimeout write 15
Disable trucate timeout
nodetool settimeout truncate 0