cassandra-stress help

Returns a synopsis and brief description for each cassandra-stress command.


cassandra-stress help [<command>] [<option>]
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.


Command options


Set the consistency level to use during cassandra-stress. Options are ONE, QUORUM, LOCAL_QUORUM, EACH_QUORUM, ALL, and ANY. Default is LOCAL_ONE.


Distribution clustering runs of operations of the same kind.


Specify the time to run, in seconds, minutes or hours.


Specify a standard error of the mean; when this value is reached, cassandra-stress will end. Default is 0.02.


Specify a minimum number of iterations to run before accepting uncertainly convergence.


Specify a maximum number of iterations to run before accepting uncertainly convergence.


Specify the number of operations to run.


Do not warmup the process, do a cold start.


Specify what operations to run and the number of each. (only with the user option)


Designate the YAML file to use with cassandra-stress. (only with the user option)


Truncate the table created during cassandra-stress. Options are never, once, or always. Default is never.

Command arguments


Column details, such as size and count distribution, data generator, names, and comparator.


-col names=? [slice] [super=?] [comparator=?] [timestamp=?] [size=DIST(?)]
-col [n=DIST(?)] [slice] [super=?] [comparator=?] [timestamp=?] [size=DIST(?)]

How to handle errors when encountered during stress testing.


-errors [retries=N] [ignore] [skip-read-validation]
  • retries=<N> Number of times to try each operation before failing.

  • ignore Do not fail on errors.

  • skip-read-validation Skip read validation and message output.


Graph results of cassandra-stress tests. Multiple tests can be graphed together.


-graph file=? [revision=?] [title=?] [op=?]

Insert specific options relating to various methods for batching and splitting partition updates.


-insert [revisit=DIST(?)] [visits=DIST(?)] partitions=DIST(?) [batchtype=?] select-ratio=DIST(?) row-population-ratio=DIST(?)

Where to log progress and the interval to use.


-log [level=?] [no-summary] [file=?] [hdrfile=?] [interval=?] [no-settings] [no-progress] [show-queries] [query-log-file=?]

Thrift or CQL with options.


-mode thrift [smart] [user=?] [password=?]
-mode native [unprepared] cql3 [compression=?] [port=?] [user=?] [password=?] [auth-provider=?] [maxPending=?] [connectionsPerHost=?] [protocolVersion=?]
-mode simplenative [prepared] cql3 [port=?]

Nodes to connect to.


-node [datacenter=?] [whitelist] [file=?] []

Population distribution and intra-partition visit order.


-pop seq=? [no-wrap] [read-lookback=DIST(?)] [contents=?]
-pop [dist=DIST(?)] [contents=?]

Specify port for connecting Cassandra nodes. Port can be specified for Cassandra native protocol, Thrift protocol or a JMX port for retrieving statistics.


-port [native=?] [thrift=?] [jmx=?]

Set the rate using the following options:

-rate threads=<N> [throttle=<N>] [fixed=<N>]


  • threads=<N> number of clients to run concurrently.

  • throttle=<N> throttle operations per second across all clients to a maximum rate (or less) with no implied schedule. Default is 0.

  • fixed=<N> expect fixed rate of operations per second across all clients with implied schedule. Default is 0.


-rate [threads>=<N>] [threads<=<N>] [auto]


  • threads>=<N> run at least this many clients concurrently. Default is 4.

  • threads⇐<N> run at most this many clients concurrently. Default is 1000.

  • auto stop increasing threads once throughput saturates.


Replication settings, compression, compaction, and so on.


-schema [replication(?)] [keyspace=?] [compaction(?)] [compression=?]

Specify a server to send the stress command to.


-sendto <host>

Token range settings.


-tokenrange [no-wrap] [split-factor=?] [savedata=?]

Custom transport factories.


-transport [factory=?] [truststore=?] [truststore-password=?] [keystore=?] [keystore-password=?] [ssl-protocol=?] [ssl-alg=?] [store-type=?] [ssl-ciphers=?]


To display help for an option:

cassandra-stress help -schema


replication([strategy=?][factor=?][<option 1..N>=?]):                 Define the replication strategy and any parameters
    strategy=? (default=org.apache.cassandra.locator.SimpleStrategy)  The replication strategy to use
    factor=? (default=1)                                              The number of replicas
keyspace=? (default=keyspace1)                                        The keyspace name to use
compaction([strategy=?][<option 1..N>=?]):                            Define the compaction strategy and any parameters
    strategy=?                                                        The compaction strategy to use
compression=?                                                         Specify the compression to use for SSTable, default:no compression

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,