dse nodesync
Modifies CQL nodesync
property on one or more
tables, enables tracing and monitoring.
The NodeSync service continuous background repair is enabled on a per table basis.
Modifies CQL
nodesync
property on one or more tables, enables nodesync
tracing and monitoring. Important: Tables with NodeSync enabled will be
skipped for repair operations run against all or specific keyspaces. For individual
tables, running the
repair
command will be rejected when NodeSync
is enabled.Synopsis
[dse] nodesync
[(-ca cql_Authprovider | --cql-auth-provider cql_Authprovider)]
[(-cp cql_password | --cql-password cql_password)]
[(-cs | --cql-ssl)]
[(-cu cql_username | --cql-username cql_username)]
[(-h cql_host | --host cql_host)]
[help]
[(-jp jmx_password | --jmx-password jmx_password)]
[(-jpf jmx_password_file | --jmx-password-file jmx_password_file)]
[(-js | --jmx-ssl)]
[(-ju jmx_username | --jmx-username jmx_username)]
[(-p cql_port | --port cql_port )]
subcommand [options]
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. |
Main options
The following options apply to all
nodesync
commands.- -ca, --cql-auth-provider cql_Authprovider
- CQL auth provider class name.
- -cp, --cql-password cql_password
- CQL password.
- -cs | --cql-ssl
- Use SSL for CQL connection.
- -cu, --cql-username cql_username
- CQL username.
- -h, --host cql_host
- Connect to the specified remote CQL host.
- help
- Displays options and usage instructions. Use
nodesync help subcommand
for more information on a specific command. - -jp, --jmx-password jmx_password
- JMX password.
- -jpf, --jmx-password-file jmx_password_file
- Path to JMX password file.
- -js | --jmx-ssl
- Use SSL for JMX.
- -ju, --jmx-username jmx_username
- JMX username.
- -p, --port cql_port
- Connection port for CQL.
- -k, --keyspace keyspace_name
- Specify a default keyspace for unqualified table names or wildcards in the
table_list
. - --quiet
- Suppress warning and error messages.
- -v | --verbose
- Display all messages.
- --
- Separates table list from the rest of the command.
- table_list
- Target tables using any of the following methods:
- Qualified table names:
keyspace_name.table_name
. For example,cycling.comments
. - Default keyspace -k option with:
- Unqualified table names. For example
-k cycling cyclist_alt_stats comments cyclist_races
. - An asterisk in double quotes to select all tables. For example,
-k cycling "*"
.
- Unqualified table names. For example
- Qualified table names:
- -n, --nodes node_list
- Only disable tracing on the listed nodes. Specify the host name or IP address in a
comma separated list.
Default: all nodes.
- --quiet
- Suppresses messages from displaying on
stdout
.
Example
Display top-level help
nodesync help
usage: nodesync [(-js | --jmx-ssl)] [(-p <cqlPort> | --port <cqlPort>)]
[(-cu <cqlUsername> | --cql-username <cqlUsername>)]
[(-jp <jmxPassword> | --jmx-password <jmxPassword>)]
[(-jpf <jmxPasswordFile> | --jmx-password-file <jmxPasswordFile>)]
[(-ca <cqlAuthProvider> | --cql-auth-provider <cqlAuthProvider>)]
[(-ju <jmxUsername> | --jmx-username <jmxUsername>)]
[(-cp <cqlPassword> | --cql-password <cqlPassword>)] [(-cs | --cql-ssl)]
[(-h <cqlHost> | --host <cqlHost>)] <command> [<args>]
The most commonly used nodesync commands are:
disable Disable nodesync on the specified tables
enable Enable nodesync on the specified tables
help Display help information
tracing Enable/disable tracing for NodeSync
validation Monitor/manage user-triggered validations
See 'nodesync help <command>' for more information on a specific command.
For more command-specific help, see nodesync help.