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

Synopsis

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

Syntax conventions

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.

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

`dse client-tool configuration import`

Synopsis

Examples

Import the configuration file with default values:

Create a local `cqlshrc` file with the default name:

Force an overwrite of the existing configuration file:

Was this helpful?

Give Feedback

dse client-tool configuration import

Synopsis

Examples

Import the configuration file with default values:

Create a local cqlshrc file with the default name:

Force an overwrite of the existing configuration file:

Was this helpful?

`dse client-tool configuration import`

Create a local `cqlshrc` file with the default name: