dse client-tool configuration import

Imports configuration file and generates local configuration files and a cqlshrc file with settings from the imported file so the DSE client applications can remotely access the running DSE cluster.

Run this command on a client node to set up the local DataStax Enterprise (DSE) installation for integrated client applications.

Synopsis

dse client-tool <connection_options> configuration import <file>
[--cqlshrc [<file>]]
[--force]

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.

--cqlshrc: Generate a cqlshrc file for the DSE client node.
file: Path to cqlshrc file to be generated. When a file is not specified, the default file is the ~/.cassandra/cqlshrc file.
--force: Force an overwrite of existing configuration files. By default, the import command fails if the configuration files already exist.
--set-keystore-password password: The keystore password for connection to the database when SSL client authentication is enabled.
--set-keystore-path path: The path to the SSL keystore when SSL client authentication is enabled. All nodes must store the keystore in the same location.
--set-keystore-type type: The keystore type when SSL client authentication is enabled. If not specified, the default is JKS.
--set-truststore-password password: Include the specified truststore password in the configuration file.
--set-truststore-path path: Path to SSL truststore on Spark nodes. All nodes must store the truststore in the same location.
--set-truststore-type type: The truststore type when SSL client authentication is enabled. If not specified, the default is JKS.

Examples

Run the import command on the client node.

Import the configuration file with default values:

dse client-tool configuration import dse-config.jar

Create a local cqlshrc file with the default name:

dse client-tool configuration import dse-config.jar --cqlshrc

Force an overwrite of the existing configuration file:

dse client-tool configuration import dse-config.jar --force