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

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 DSE Authentication is enabled, use this option to log in to the database.

Set the password in a <user_home_location>/.dserc file or as an environment variable.

-p password

Optional password for DSE authentication. If omitted when a username is specified, the password prompt appears.

Set the password in a <user_home_location>/.dserc file or as an environment variable.

hostname

The hostname of the DSE database 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.

`dse gremlin-console`

Synopsis

DSE connection parameters

Options

Was this helpful?

Give Feedback