dse client-tool help

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

Synopsis

dse client-tool help [<subcommand>]

Syntax conventions Description

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.

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.

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