dse command connection options
Options to authenticate connections to the database and to JMX for dse commands.
Synopsis
dse
[-f <config_file> |
-u <username> -p <password>]
[-a <jmx_username> [-b <jmx_password>]]
<command> [<options>]
Syntax conventions | Description |
---|---|
UPPERCASE |
Literal keyword. |
Lowercase |
Not literal. |
<`Italics>` |
Variable value. Replace with a valid option or user-defined value. |
|
Optional.
Square brackets ( |
|
Group.
Parentheses ( |
|
Or.
A vertical bar ( |
|
Repeatable.
An ellipsis ( |
|
Single quotation ( |
|
Map collection.
Braces ( |
|
Set, list, map, or tuple.
Angle brackets ( |
|
End CQL statement.
A semicolon ( |
|
Separate the command line options from the command arguments with two hyphens ( |
|
Search CQL only: Single quotation marks ( |
|
Search CQL only: Identify the entity and literal value to overwrite the XML element in the schema and solrconfig files. |
Specify how to connect and authenticate to the database for dse commands.
This list shows short form (-f <filename>
) and long form (--config-file=<filename>
):
- -f, --config-file config_filename
-
File path to configuration file that stores credentials. The credentials in this configuration file override the ~/.dserc credentials. If not specified, then use
~/.dserc
if it exists.The configuration file can contain DataStax Enterprise and JMX login credentials. For example:
username=<username> password=<password> jmx_username=<jmx_username> jmx_password=<jmx_password>
The credentials in the configuration file are stored in clear text. DataStax recommends restricting access to this file only to the specific user.
- -u username
-
Role to authenticate for database access.
- -p, --password password
-
Password to authenticate for database access.
- -a, --jmxusername jmx_username
-
User name for authenticating with secure local JMX.
- -b, --jmxpassword jmx_password
-
Password for authenticating with secure local JMX. If you do not provide a password, you are prompted to enter one.
Examples
To authenticate a connection to the database
dse -u user1 -p mypassword
To authenticate a connection using a configuration file
dse -f configfile