dse client-tool help

Returns a synopsis and brief description for each dse client-tool subcommand.

Synopsis

dse client-tool help [<subcommand>]

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.

Examples

To view a list of dse client-tool subcommands:

dse client-tool help

Results:

usage: dse client-tool [--keystore-path <sslKeyStorePath>]
        [--truststore-type <sslTrustStoreType>] [--port <port>]
        [--sasl-protocol-name <saslProtocolName>] [-a <authorization username>]
        [--truststore-password <sslTrustStorePassword>] [-u <username>]
        [--truststore-path <sslTrustStorePath>] [-t <delegation token>]
        [--ssl-protocol <sslProtocol>] [--ssl-enabled <sslEnabled>] [-p <password>]
        [--keystore-password <sslKeyStorePassword>] [--keystore-type <sslKeyStoreType>]
        [--use-server-config] [--cipher-suites <sslCipherSuites>] [--host <address>]
        [--kerberos-enabled <kerberosEnabled>] <command> [<args>]

The most commonly used dse client-tool commands are:
    alwayson-sql    Performs operation related to AlwaysOn SQL Service
    cassandra       Performs general operations, unrelated to any specific component
    configuration   Manages the external configuration
    help            Display help information
    spark           Performs operation related to integrated Spark

See 'dse client-tool help <command>' for more information on a specific command.
To view help for a specific dse client-tool subcommands:

dse client-tool help spark

dse client-tool help

Synopsis

Examples

To view a list of dse client-tool subcommands:

Was this helpful?

Give Feedback