nodesync validation

Monitors and manages user-triggered validations.

Synopsis

[dse] nodesync <main_options> validation
(cancel <id> |
list |
submit [(-r <KB> | --rate <KB>)]  [--] <table_name> [<range> ...] )
[(--quiet | (-v | --verbose))]

Syntax legend

Syntax conventions Description

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: `<datatype2` In Search CQL statements, angle brackets are used to identify the entity and literal value to overwrite the XML element in the schema and `solrconfig` files, such as `@<xml_entity>='<xml_entity_type>'`.
`[ ]`	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 `'<<schema> ... </schema>>'`
`{ }`	Map collection. Curly braces enclose maps (`{ <key_datatype>:<value_datatype> }`) or key value pairs (`{ <key>:<value> }`). A colon separates the key and the value.
`;`	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.

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: <datatype2

In Search CQL statements, angle brackets are used to identify the entity and literal value to overwrite the XML element in the schema and solrconfig files, such as @<xml_entity>='<xml_entity_type>'.

[ ]

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 '<<schema> ... </schema>>'

{ }

Map collection. Curly braces enclose maps ({ <key_datatype>:<value_datatype> }) or key value pairs ({ <key>:<value> }). A colon separates the key and the value.

;

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.

Common options

The following options are available 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.

The keyspace must be an alterable keyspace: system_distributed keyspace or a user-created keyspace. An error results when attempting to run these commands on an unalterable keyspace such as system_auth.

For example, when the keyspace is alterable:

nodesync disable -v -k system_distributed "*"

Nodesync disabled for system_distributed.nodesync_status
Nodesync disabled for system_distributed.backups
...
Nodesync disabled for system_distributed.repair_history
--
+
As compared to an unalterable keyspace:
+
[source,console]
--
nodesync disable -v -k system_auth "*"

Error: Keyspace [system_auth] is not alterable.
--
+
You can use a CQL command to enable or disable nodesync for unalterable keyspaces, such as a `system_*` keyspace.
For example:
+
[source,console]
--
ALTER TABLE system_auth.roles WITH nodesync = {'enabled': 'false'};

--quiet: Suppress warning and error messages.

-v, --verbose: Enable verbose console output
--: 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 "*".

-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.

Validation options

cancel id: Cancel the specified user-triggered validation.

list [(-a | --all)]: List user validations. Use -a to list all, running or validations that completed in the past day.

Default: Only running validations are displayed.

submit [options] table_name [range]: Submit a forced user validation.

-r KB, --rate KB Rate to be used just for this validation, in KB per second.
--quiet: Suppress warning and error messages.

--: Separates command-line options from the list of argument. Use when arguments might be mistaken for command-line options.
-v, --verbose: Enable verbose console output

Examples

List all nodesync validations:

nodesync validation list --all

Identifier                            Table                 Status      Outcome  Duration  ETA  Progress  Validated  Repaired

1e6255f0-7754-11e9-aad8-579eeacd08f6  cycling.comments      running     ?             0ms    ?        0%         0B        0B
0ac37290-7754-11e9-ab57-0f1d9fa56691  cycling.cyclist_races successful  success      24ms    -      100%         0B        0B
Possible Outcome values are:
All data was in sync or successfully repaired.

?: Operation still in progress. No outcome available yet.
uncompleted: Some partitions could not be repaired because there were not enough live replicas. Errors may or may not have occurred. Any errors are written to the console.
failed: Errors occurred, but enough replicas were available for partitions that did not have errors. Any errors are written to the console.
partial: Enough (but not all) replicas were alive to repair or check that the data was in sync among the live replicas.
success: All data was in sync or successfully repaired.