dse gremlin-console
DSE Gremlin Console automatically connects at startup to the DataStax Enterprise (DSE) server. as configured in the remote.yaml file. Override the configured host and port from the command line.
Synopsis
dse gremlin-console [-u username [-p password]] [hostname[:port]] [options]
Syntax legend
| 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: In Search CQL statements, angle brackets are used to identify the entity and literal value to overwrite the XML element in the schema and |
|
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 |
|
Map collection.
Curly braces enclose maps ( |
|
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. |
DSE connection parameters
When starting the Gremlin Console using this command it automatically connects to the host specified in the remote.yaml.
- -u username
-
When you enable DSE Authentication, use this option to log in to the database.
Set the username in a file or as an environment variable.
- -p password
-
Optional password for DSE authentication. If omitted when a user name is specified, the password prompt appears.
Set the password in a file or as an environment variable.
- hostname
-
The hostname of the DSE node to which the console connects. Overrides the setting in the remote.yaml.
- port
-
Port number of the DSE database port, default is 9042. Overrides the setting in the remote.yaml.
Options
Gremlin console options.
- -C, --color
-
Disable use of ANSI colors.
- -D, --debug
-
Enabled debug console output.
- -Q, --quiet
-
Suppress superfluous console output.
- -v, --verbose
-
Enable verbose console output
- -e, --execute=SCRIPT_NAME [ARG1 ARG2 …]
-
Execute the specified script and close the console on completion.
- -h, --help
-
Display this help message.
- -i, --interactive=SCRIPT_NAME [ARG1 ARG2 … ]
-
Execute the specified script and leave the console open on completion.
- -l
-
Set the logging level of components that use standard logging output independent of the Console.
- -v, --version
-
Display the version.