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 legend
| Syntax conventions | Description |
|---|---|
Italic, bold, or |
Syntax diagrams and code samples use one or more of these styles to mark placeholders for variable values. Replace placeholders with a valid option or your own user-defined value. In CQL statements, angle brackets are required to enclose data types in a set, list, map, or tuple.
Separate the data types with a comma.
For example: In Search CQL statements, angle brackets are used to identify the entity and literal value to overwrite the XML element in the schema and |
|
Square brackets surround optional command arguments. Do not type the square brackets. |
|
Parentheses identify a group to choose from. Do not type the parentheses. |
|
A pipe separates alternative elements. Type any one of the elements. Do not type the pipe. |
|
Indicates that you can repeat the syntax element as often as required. |
|
Single quotation marks must surround literal strings in CQL statements.
Use single quotation marks to preserve upper case.
+
For Search CQL only: Single quotation marks surround an entire XML schema declaration, such as |
|
Map collection.
Curly braces enclose maps ( |
|
Ends a CQL statement. |
|
Separate command line options from command arguments with two hyphens. This syntax is useful when arguments might be mistaken for command line options. |
Options
If an option has a short and long form, both forms are given, separated by a comma.
- -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.
- timeout_in_ms
-
Time to wait in milliseconds. Set to
0to disable 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 truncate timeout
nodetool settimeout truncate 0