dse command connection options
dse command options to authenticate connections to the database and to JMX.
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 ( [ ] ) 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. |
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