dse cassandra

Starts the database in transactional mode. Command options start the database in other modes and enable advanced features on a node. See Starting DataStax Enterprise.

To change the DSE system properties on start up, see Setting system properties during startup.

Synopsis

dse cassandra [-k] [-s] [-g]
[-Dparameter_name=<value>]
[-f] [-h] [-p <pidfile>]
[-H <JVM_dumpfile>]
[-E <JVM_errorfile>]

When multiple flags are used, list them separately on the command line. For example, ensure there is a space between -k and -s in dse cassandra -k -s.

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.

Options

-k: Start the node in analytics mode. The first time the node starts up the analytics workload type is configured.
-g: Start the node in graph mode. The first time the node starts up the graph workload type is configured.
-s: Start the node in search mode. The first time the node starts up the search workload type is configured.
-E: Change JVM error file.
-f: Start a real-time transactional node in the foreground.
-h: Display the usage and listing of the dse commands.
-H: Change JVM HeapDumpPath.
-p pidfilepath: Create the pid file. The pid file is typically used by monitoring processes and init scripts. Not compatible with -f option.

Examples

Start a node in transactional mode

dse cassandra

In the foreground, start a node in transactional mode

dse cassandra -f

Start a node in DSE Analytics mode

dse cassandra -k

Start a node in SearchAnalytics mode

dse cassandra -k -s

Ensure there is a space between -k and -s in dse cassandra -k -s.

Start a node in DSE Analytics, DSE Graph, and DSE Search modes

dse cassandra -k -g -s

Ensure there is a space between -k, -g, and -s in dse cassandra -k -g -s.

Start a node in DSE Search mode and change the location of the search index data on the server

dse cassandra -s -Ddse.solr.data.dir=filepath

See Managing the location of DSE Search data.

Start a node in transactional mode without joining the ring

dse cassandra -Dcassandra.join_ring=false

Start a node in transactional mode to test compaction and compression strategies

dse cassandra -Dcassandra.write_survey=true

Experiment with different strategies and benchmark write performance differences without affecting the production workload. See Testing compaction and compression.

Start a node in transactional mode and pass the dead node IP address

dse cassandra -Dcassandra.replace_address=10.91.176.160

Start a node in transactional mode and create pid.txt

dse cassandra -p pid.txt

Start a node in transactional mode and disable DSE Metrics Collector

dse cassandra -Dinsights.default_mode=disabled