dse gremlin-console

DSE Gremlin Console automatically connects at startup to DataStax Enterprise (DSE) server. as configured in the remote.yaml file. Override the configured host and port from the command line.


dse gremlin-console [-u username [-p password]] [hostname[:port]] [options]
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.

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 DataStax Enterprise Authentication is enabled use this option to login 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.


The hostname of the DataStax Enterprise to which the console connects. Overrides the setting in the remote.yaml.


Port number of the DataStax Enterpise database port, default is 9042. Overrides the setting in the remote.yaml.


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.


Set the logging level of components that use standard logging output independent of the Console.

-v, --version

Display the version.

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