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 DSE installation for integrated client applications.


dse client-tool <connection_options> configuration import <file>
[--cqlshrc [<file>]]
Syntax conventions Description


Literal keyword.


Not literal.


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.


Set, list, map, or tuple. Angle brackets ( < > ) enclose data types in a set, list, map, or tuple. Separate the data types with a comma.


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.


Search CQL only: Identify the entity and literal value to overwrite the XML element in the schema and solrconfig files.


Generate a cqlshrc file for the DSE client node.


Path to cqlshrc file to be generated. When a file is not specified, the default file is the ~/.cassandra/cqlshrc file.


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.


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

Was this helpful?

Give Feedback

How can we improve the documentation?

© 2024 DataStax | Privacy policy | Terms of use

Apache, Apache Cassandra, Cassandra, Apache Tomcat, Tomcat, Apache Lucene, Apache Solr, Apache Hadoop, Hadoop, Apache Pulsar, Pulsar, Apache Spark, Spark, Apache TinkerPop, TinkerPop, Apache Kafka and Kafka are either registered trademarks or trademarks of the Apache Software Foundation or its subsidiaries in Canada, the United States and/or other countries. Kubernetes is the registered trademark of the Linux Foundation.

General Inquiries: +1 (650) 389-6000, info@datastax.com