| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width,initial-scale=1.0"> |
| <title>Cassandra Stress | Apache Cassandra Documentation</title> |
| <link rel="stylesheet" href="../../../../assets/css/site.css"> |
| <link rel="schema.dcterms" href="https://purl.org/dc/terms/"> |
| <meta name="dcterms.subject" content="Cassandra"> |
| <meta name="dcterms.identifier" content="5.0"> |
| <meta name="generator" content="Antora 2.3.4"> |
| <link rel="icon" href="../../../../assets/img/favicon.ico" type="image/x-icon"> |
| <script> |
| const script = document.createElement("script"); |
| const domain = window.location.hostname; |
| script.type = "text/javascript"; |
| script.src = "https://plausible.cassandra.apache.org/js/plausible.js"; |
| script.setAttribute("data-domain",domain); |
| script.setAttribute("defer",'true'); |
| script.setAttribute("async",'true'); |
| document.getElementsByTagName("head")[0].appendChild(script); |
| </script> </head> |
| <body class="docs-wrapper article"> |
| <div class="container mx-auto relative"> |
| <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script> |
| <meta property="og:type" content="website" /> |
| <meta property="og:url" content="/" /> |
| <meta property="og:site_name" content="Apache Cassandra" /> |
| |
| <header id="top-nav"> |
| <div class="inner relative"> |
| <div class="header-social-icons text-right"> |
| <a href="https://twitter.com/cassandra?lang=en" target="_blank" styles="margin-left: 20px;"><img src="../../../../assets/img/twitter-icon-circle-white.svg" alt="twitter icon" width="24"></a> |
| <a href="https://www.linkedin.com/company/apache-cassandra/" target="_blank" styles="margin-left: 20px;"><img src="../../../../assets/img/LI-In-Bug.png" alt="linked-in icon" width="24"></a> |
| <a href="https://www.youtube.com/c/PlanetCassandra" target="_blank" styles="margin-left: 20px;"><img src="../../../../assets/img/youtube-icon.png" alt="youtube icon" width="24"></a> |
| </div> |
| <div class="cf"> |
| <div class="logo left"><a href="/"><img src="../../../../assets/img/logo-white-r.png" alt="Cassandra Logo"></a></div> |
| <div class="mobile-nav-icon right"> |
| <img class="toggle-icon" src="../../../../assets/img/hamburger-nav.svg"> |
| </div> |
| <ul class="main-nav nav-links right flex flex-vert-center flex-space-between"> |
| <li> |
| <a class="nav-link hide-mobile">Get Started</a> |
| <ul class="sub-menu bg-white"> |
| <li class="pa-micro"> |
| <a href="/_/cassandra-basics.html"> |
| <div class="sub-nav-icon"> |
| <img src="../../../../assets/img/sub-menu-basics.png" alt="cassandra basics icon"> |
| </div> |
| <div class="sub-nav-text teal py-small"> |
| Cassandra Basics |
| </div> |
| </a> |
| </li> |
| <li class="pa-micro"> |
| <a href="/_/quickstart.html"> |
| <div class="sub-nav-icon"> |
| <img src="../../../../assets/img/sub-menu-rocket.png" alt="cassandra basics icon"> |
| </div> |
| <div class="sub-nav-text teal py-small"> |
| Quickstart |
| </div> |
| </a> |
| </li> |
| <li class="pa-micro"> |
| <a href="/_/ecosystem.html"> |
| <div class="sub-nav-icon"> |
| <img src="../../../../assets/img/sub-menu-ecosystem.png" alt="cassandra basics icon"> |
| </div> |
| <div class="sub-nav-text teal py-small"> |
| Ecosystem |
| </div> |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li><a class="nav-link" href="/doc/latest/">Documentation</a></li> |
| <li> |
| <a class="nav-link" href="/_/community.html">Community</a> |
| <ul class="sub-menu bg-white"> |
| <li class="pa-micro"> |
| <a href="/_/community.html#code-of-conduct"> |
| <div class="sub-nav-icon"> |
| <img src="../../../../assets/img/sub-menu-welcome.png" alt="welcome icon"> |
| </div> |
| <div class="sub-nav-text teal py-small"> |
| Welcome |
| </div> |
| </a> |
| </li> |
| <li class="pa-micro hide-mobile"> |
| <a href="/_/community.html#discussions"> |
| <div class="sub-nav-icon"> |
| <img src="../../../../assets/img/sub-menu-discussions.png" alt="discussions icon"> |
| </div> |
| <div class="sub-nav-text teal py-small"> |
| Discussions |
| </div> |
| </a> |
| </li> |
| <li class="pa-micro hide-mobile"> |
| <a href="/_/community.html#project-governance"> |
| <div class="sub-nav-icon"> |
| <img src="../../../../assets/img/sub-menu-governance.png" alt="Governance icon"> |
| </div> |
| <div class="sub-nav-text teal py-small"> |
| Governance |
| </div> |
| </a> |
| </li> |
| <li class="pa-micro hide-mobile"> |
| <a href="/_/community.html#how-to-contribute"> |
| <div class="sub-nav-icon"> |
| <img src="../../../../assets/img/sub-menu-contribute.png" alt="Contribute icon"> |
| </div> |
| <div class="sub-nav-text teal py-small"> |
| Contribute |
| </div> |
| </a> |
| </li> |
| <li class="pa-micro hide-mobile"> |
| <a href="/_/community.html#meet-the-community"> |
| <div class="sub-nav-icon"> |
| <img src="../../../../assets/img/sub-menu-community.png" alt="Meet the Community icon"> |
| </div> |
| <div class="sub-nav-text teal py-small"> |
| Meet the Community |
| </div> |
| </a> |
| </li> |
| <li class="pa-micro hide-mobile"> |
| <a href="/_/cassandra-catalyst-program.html"> |
| <div class="sub-nav-icon"> |
| <img src="../../../../assets/img/sub-menu-catalyst.png" alt="Catalyst icon"> |
| </div> |
| <div class="sub-nav-text teal py-small"> |
| Catalyst Program |
| </div> |
| </a> |
| </li> |
| <li class="pa-micro hide-mobile"> |
| <a href="/_/events.html"> |
| <div class="sub-nav-icon"> |
| <img src="../../../../assets/img/sub-menu-events.png" alt="Events icon"> |
| </div> |
| <div class="sub-nav-text teal py-small"> |
| Events |
| </div> |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li> |
| <a class="nav-link hide-mobile">Learn</a> |
| <ul class="sub-menu bg-white"> |
| <li class="pa-micro"> |
| <a href="/_/Apache-Cassandra-5.0-Moving-Toward-an-AI-Driven-Future.html"> |
| <div class="sub-nav-icon"> |
| <img src="../../../../assets/img/sub-menu-basics.png" alt="Basics icon"> |
| </div> |
| <div class="sub-nav-text teal py-small"> |
| Cassandra 5.0 |
| </div> |
| </a> |
| </li> |
| <li class="pa-micro"> |
| <a href="/_/case-studies.html"> |
| <div class="sub-nav-icon"> |
| <img src="../../../../assets/img/sub-menu-case-study.png" alt="Case Studies icon"> |
| </div> |
| <div class="sub-nav-text teal py-small"> |
| Case Studies |
| </div> |
| </a> |
| </li> |
| <li class="pa-micro"> |
| <a href="/_/resources.html"> |
| <div class="sub-nav-icon"> |
| <img src="../../../../assets/img/sub-menu-resources.png" alt="Resources icon"> |
| </div> |
| <div class="sub-nav-text teal py-small"> |
| Resources |
| </div> |
| </a> |
| </li> |
| <li class="pa-micro"> |
| <a href="/_/blog.html"> |
| <div class="sub-nav-icon"> |
| <img src="../../../../assets/img/sub-menu-blog.png" alt="Blog icon"> |
| </div> |
| <div class="sub-nav-text teal py-small"> |
| Blog |
| </div> |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li><a class="nav-link btn btn--filled" href="/_/download.html">Download Now</a></li> |
| </ul> |
| </div> |
| </div> |
| </header> |
| |
| <div class="hero hero--home grad"> |
| <div class="eye"></div> |
| <div id="docs-content" class="text-center flex flex-center flex-column relative z2 ma-xlarge"> |
| <h2>Cassandra Documentation</h2> |
| </div> |
| </div> |
| <div class="body px-medium py-medium container"> |
| <div class="docs-nav-bar flex flex-space-between mb-medium"> |
| <div id="mobile-docs-nav-burger" class="hidden"> |
| <svg viewBox="0 0 24 24" width="36" height="36" stroke="#1c81a0" stroke-width="2.5" fill="none" stroke-linecap="round" stroke-linejoin="round" class="css-i6dzq1"><line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line></svg> |
| </div> |
| <div class="docs-nav-item relative"> |
| <input id="search-input" type="text" placeholder="Search docs"> |
| </div> |
| <div class="versions-wrapper"> |
| <h4>Version:</h4> |
| <div class="nav-panel-explore" data-panel="explore"> |
| |
| <div id="version-toggle" class="context"> |
| <span class="version">5.0</span> |
| </div> |
| <ul id="versions-list" class="components"> |
| <li class="component"> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../../_/index.html">master</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component is-current"> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../../trunk/index.html">trunk</a> |
| </li> |
| <li class="version is-current"> |
| <a href="../../index.html">5.0</a> |
| </li> |
| <li class="version is-latest"> |
| <a href="../../../4.1/index.html">4.1</a> |
| </li> |
| <li class="version"> |
| <a href="../../../4.0/index.html">4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../3.11/index.html">3.11</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> </div> |
| <div class="cf relative"> |
| <nav class="nav docs-nav full-800"> |
| <div class="nav-menu"> |
| <ul class="nav-list"> |
| <li class="nav-item is-active" data-depth="0"> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="1"> |
| <span class="nav-line"> |
| <button class="nav-toggle"></button> |
| <a class="nav-link" href="../../index.html">Main</a> |
| </span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../../../_/glossary.html">Glossary</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../../../_/bugs.html">How to report bugs</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../../../_/contactus.html">Contact us</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <span class="nav-line"> |
| <button class="nav-toggle"></button> |
| <a class="nav-link" href="../../../../_/development/index.html">Development</a> |
| </span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../../../_/development/gettingstarted.html">Getting started</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../../../_/development/ide.html">Building and IDE integration</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../../../_/development/testing.html">Testing</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../../../_/development/patches.html">Contributing code changes</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../../../_/development/code_style.html">Code style</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../../../_/development/how_to_review.html">Review checklist</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../../../_/development/how_to_commit.html">How to commit</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../../../_/development/documentation.html">Working on documentation</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../../../_/development/ci.html">Jenkins CI environment</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../../../_/development/dependencies.html">Dependency management</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../../../../_/development/release_process.html">Release process</a> |
| </span> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item is-active" data-depth="0"> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="1"> |
| <span class="nav-line"> |
| <button class="nav-toggle"></button> |
| <span class="nav-text">Cassandra</span> |
| </span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../overview/faq/index.html">FAQ</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <span class="nav-line"> |
| <button class="nav-toggle"></button> |
| <a class="nav-link" href="../getting-started/index.html">Getting Started</a> |
| </span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../getting-started/cassandra-quickstart.html">Cassandra Quickstart</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../getting-started/sai-quickstart.html">SAI Quickstart</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../getting-started/vector-search-quickstart.html">Vector Search Quickstart</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../installing/installing.html">Installing Cassandra</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../getting-started/configuring.html">Configuring Cassandra</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../getting-started/querying.html">Inserting and querying</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../getting-started/drivers.html">Client drivers</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../getting-started/production.html">Production recommendations</a> |
| </span> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <span class="nav-line"> |
| <button class="nav-toggle"></button> |
| <a class="nav-link" href="../new/index.html">What’s new</a> |
| </span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../reference/java17.html">Support for Java</a> |
| </span> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <span class="nav-line"> |
| <button class="nav-toggle"></button> |
| <a class="nav-link" href="../architecture/index.html">Architecture</a> |
| </span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../architecture/overview.html">Overview</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../architecture/dynamo.html">Dynamo</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../architecture/storage-engine.html">Storage Engine</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../architecture/guarantees.html">Guarantees</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../architecture/messaging.html">Improved Internode Messaging</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../architecture/streaming.html">Improved Streaming</a> |
| </span> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <span class="nav-line"> |
| <button class="nav-toggle"></button> |
| <a class="nav-link" href="../developing/data-modeling/index.html">Data Modeling</a> |
| </span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../developing/data-modeling/intro.html">Introduction</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../developing/data-modeling/data-modeling_conceptual.html">Conceptual data modeling</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../developing/data-modeling/data-modeling_rdbms.html">RDBMS design</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../developing/data-modeling/data-modeling_queries.html">Defining application queries</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../developing/data-modeling/data-modeling_logical.html">Logical data modeling</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../developing/data-modeling/data-modeling_physical.html">Physical data modeling</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../developing/data-modeling/data-modeling_refining.html">Evaluating and refining data models</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../developing/data-modeling/data-modeling_schema.html">Defining database schema</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../developing/data-modeling/data-modeling_tools.html">Cassandra data modeling tools</a> |
| </span> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <span class="nav-line"> |
| <button class="nav-toggle"></button> |
| <a class="nav-link" href="../developing/cql/index.html">Cassandra Query Language (CQL)</a> |
| </span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../developing/cql/definitions.html">Definitions</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../developing/cql/types.html">Data types</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../developing/cql/ddl.html">Data definition (DDL)</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../developing/cql/dml.html">Data manipulation (DML)</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../developing/cql/dynamic-data-masking.html">Dynamic Data Masking (DDM)</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../developing/cql/operators.html">Operators</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <button class="nav-toggle"></button> |
| <a class="nav-link" href="../developing/cql/indexing/indexing-concepts.html">Indexing concepts</a> |
| </span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="4"> |
| <span class="nav-line"> |
| <button class="nav-toggle"></button> |
| <a class="nav-link" href="../developing/cql/indexing/sai/sai-overview.html">SAI Overview</a> |
| </span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="5"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../developing/cql/indexing/sai/sai-concepts.html">Concepts</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="5"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../getting-started/sai-quickstart.html">SAI Quickstart</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="5"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../developing/cql/indexing/sai/sai-faq.html">SAI FAQ</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="5"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../developing/cql/indexing/sai/sai-working-with.html">Working with SAI</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="5"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../developing/cql/indexing/sai/operations/sai-operations.html">SAI operations</a> |
| </span> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <span class="nav-line"> |
| <button class="nav-toggle"></button> |
| <a class="nav-link" href="../developing/cql/indexing/2i/2i-overview.html">Secondary indexes (2i) overview</a> |
| </span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="5"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../developing/cql/indexing/2i/2i-concepts.html">Concepts</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="5"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../developing/cql/indexing/2i/2i-working-with.html">Working with 2i</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="5"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../developing/cql/indexing/2i/operations/2i-build.html">Rebuild 2i</a> |
| </span> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../developing/cql/mvs.html">Materialized views</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../developing/cql/functions.html">Functions</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../developing/cql/json.html">JSON</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../developing/cql/security.html">Security</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../developing/cql/triggers.html">Triggers</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../developing/cql/appendices.html">Appendices</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../developing/cql/changes.html">Changes</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../developing/cql/SASI.html">SASI</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../developing/cql/cql_singlefile.html">Single file of CQL information</a> |
| </span> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <span class="nav-line"> |
| <button class="nav-toggle"></button> |
| <a class="nav-link" href="../vector-search/overview.html">Vector Search overview</a> |
| </span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <button class="nav-toggle"></button> |
| <a class="nav-link" href="../vector-search/concepts.html">Concepts</a> |
| </span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="4"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../vector-search/data-modeling.html">Data Modeling</a> |
| </span> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../getting-started/vector-search-quickstart.html">Vector Search Quickstart</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../vector-search/vector-search-working-with.html">Working with Vector Search</a> |
| </span> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <span class="nav-line"> |
| <button class="nav-toggle"></button> |
| <a class="nav-link" href="../managing/index.html">Managing</a> |
| </span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <button class="nav-toggle"></button> |
| <a class="nav-link" href="../managing/configuration/index.html">Configuring</a> |
| </span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="4"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../managing/configuration/cass_yaml_file.html">cassandra.yaml</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../managing/configuration/cass_rackdc_file.html">cassandra-rackdc.properties</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../managing/configuration/cass_env_sh_file.html">cassandra-env.sh</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../managing/configuration/cass_topo_file.html">cassandra-topologies.properties</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../managing/configuration/cass_cl_archive_file.html">commitlog-archiving.properties</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../managing/configuration/cass_logback_xml_file.html">logback.xml</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../managing/configuration/cass_jvm_options_file.html">jvm-* files</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../managing/configuration/configuration.html">Liberating cassandra.yaml Parameters' Names from Their Units</a> |
| </span> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <button class="nav-toggle"></button> |
| <a class="nav-link" href="../managing/operating/index.html">Operating</a> |
| </span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="4"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../managing/operating/backups.html">Backups</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../managing/operating/bloom_filters.html">Bloom filters</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../managing/operating/bulk_loading.html">Bulk loading</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../managing/operating/cdc.html">Change Data Capture (CDC)</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../managing/operating/compaction/index.html">Compaction</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../managing/operating/compression.html">Compression</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../managing/operating/hardware.html">Hardware</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../managing/operating/hints.html">Hints</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <span class="nav-line"> |
| <button class="nav-toggle"></button> |
| <a class="nav-link" href="../managing/operating/logging.html">Logging</a> |
| </span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="5"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../managing/operating/auditlogging.html">Audit logging</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="5"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../managing/operating/audit_logging.html">Audit logging 2</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="5"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../managing/operating/fqllogging.html">Full query logging</a> |
| </span> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../managing/operating/metrics.html">Monitoring metrics</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../managing/operating/repair.html">Repair</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../managing/operating/read_repair.html">Read repair</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../managing/operating/security.html">Security</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../managing/operating/snitch.html">Snitches</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../managing/operating/topo_changes.html">Topology changes</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../managing/operating/transientreplication.html">Transient replication</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../managing/operating/virtualtables.html">Virtual tables</a> |
| </span> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <button class="nav-toggle"></button> |
| <a class="nav-link" href="../managing/tools/index.html">Tools</a> |
| </span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="4"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../managing/tools/cqlsh.html">cqlsh: the CQL shell</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../managing/tools/nodetool/nodetool.html">nodetool</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../managing/tools/sstable/index.html">SSTable tools</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <span class="nav-line"> |
| <a class="nav-link" href="#cassandra:managing/tools/cassandra_stress.adoc">cassandra-stress</a> |
| </span> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <span class="nav-line"> |
| <button class="nav-toggle"></button> |
| <a class="nav-link" href="../troubleshooting/index.html">Troubleshooting</a> |
| </span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../troubleshooting/finding_nodes.html">Finding misbehaving nodes</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../troubleshooting/reading_logs.html">Reading Cassandra logs</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../troubleshooting/use_nodetool.html">Using nodetool</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../troubleshooting/use_tools.html">Using external tools to deep-dive</a> |
| </span> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <span class="nav-line"> |
| <button class="nav-toggle"></button> |
| <a class="nav-link" href="../reference/index.html">Reference</a> |
| </span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../reference/cql-commands/alter-table.html">ALTER TABLE</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../reference/cql-commands/create-index.html">CREATE INDEX</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../reference/cql-commands/create-custom-index.html">CREATE CUSTOM INDEX</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../reference/cql-commands/create-table.html">CREATE TABLE</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../reference/cql-commands/drop-index.html">DROP INDEX</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../reference/cql-commands/drop-table.html">DROP TABLE</a> |
| </span> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <span class="nav-line"> |
| <a class="nav-link" href="../integrating/plugins/index.html">Plug-ins</a> |
| </span> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </nav> |
| <aside class="toc sidebar"> |
| <div class="toc-menu"></div> |
| </aside> |
| <main class="article default-main full-800" data-ceiling="topbar"> |
| <div class="article-banner"> |
| <p>You are viewing the documentation for a prerelease version.</p> |
| </div> |
| <div class="article-header"> |
| <nav class="crumbs" aria-label="breadcrumbs"> |
| <ul> |
| <li class="crumb"><a href="../../index.html">Cassandra</a></li> |
| <li class="crumb"><a href="cassandra-stress.html">Cassandra Stress</a></li> |
| </ul> |
| </nav> |
| <div class="tools" role="navigation"> |
| <ul> |
| <li class="tool edit"><a href="https://github.com/apache/cassandra/edit/cassandra-5.0/doc/modules/cassandra/pages/tooling/cassandra-stress.adoc" title="Edit Page" target="_blank" rel="noopener">Edit</a></li> |
| </ul> |
| </div> |
| </div> |
| <article class="doc"> |
| <h1 class="page">Cassandra Stress</h1> |
| <div id="preamble"> |
| <div class="sectionbody"> |
| <div class="admonitionblock important"> |
| <table> |
| <tr> |
| <td class="icon"> |
| <i class="fa icon-important" title="Important"></i> |
| </td> |
| <td class="content"> |
| <div class="paragraph"> |
| <p>The <code>cassandra-stress</code> tool is deprecated. |
| A better tool for benchmarking Cassandra is <a href="https://docs.nosqlbench.io/">NoSQLBench</a>.</p> |
| </div> |
| </td> |
| </tr> |
| </table> |
| </div> |
| <div class="paragraph"> |
| <p>The <code>cassandra-stress</code> tool is used to benchmark and load-test a Cassandra cluster. |
| <code>cassandra-stress</code> supports testing arbitrary CQL tables and queries, allowing users to benchmark their own data model.</p> |
| </div> |
| <div class="paragraph"> |
| <p>This documentation focuses on user mode to test personal schema.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="usage"><a class="anchor" href="#usage"></a>Usage</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>There are several operation types:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>write-only, read-only, and mixed workloads of standard data</p> |
| </li> |
| <li> |
| <p>write-only and read-only workloads for counter columns</p> |
| </li> |
| <li> |
| <p>user configured workloads, running custom queries on custom schemas</p> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>The syntax is <code>cassandra-stress <command> [options]</code>. |
| For more information on a given command or options, run <code>cassandra-stress help <command|option></code>.</p> |
| </div> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Commands</dt> |
| <dd> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">read:</dt> |
| <dd> |
| <p>Multiple concurrent reads - the cluster must first be populated by a |
| write test</p> |
| </dd> |
| <dt class="hdlist1">write:</dt> |
| <dd> |
| <p>Multiple concurrent writes against the cluster</p> |
| </dd> |
| <dt class="hdlist1">mixed:</dt> |
| <dd> |
| <p>Interleaving of any basic commands, with configurable ratio and |
| distribution - the cluster must first be populated by a write test</p> |
| </dd> |
| <dt class="hdlist1">counter_write:</dt> |
| <dd> |
| <p>Multiple concurrent updates of counters.</p> |
| </dd> |
| <dt class="hdlist1">counter_read:</dt> |
| <dd> |
| <p>Multiple concurrent reads of counters. The cluster must first be |
| populated by a counterwrite test.</p> |
| </dd> |
| <dt class="hdlist1">user:</dt> |
| <dd> |
| <p>Interleaving of user provided queries, with configurable ratio and |
| distribution.</p> |
| </dd> |
| <dt class="hdlist1">help:</dt> |
| <dd> |
| <p>Print help for a command or option</p> |
| </dd> |
| <dt class="hdlist1">print:</dt> |
| <dd> |
| <p>Inspect the output of a distribution definition</p> |
| </dd> |
| </dl> |
| </div> |
| </dd> |
| <dt class="hdlist1">Primary Options</dt> |
| <dd> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">-pop:</dt> |
| <dd> |
| <p>Population distribution and intra-partition visit order</p> |
| </dd> |
| <dt class="hdlist1">-insert:</dt> |
| <dd> |
| <p>Insert specific options relating to various methods for batching and |
| splitting partition updates</p> |
| </dd> |
| <dt class="hdlist1">-col:</dt> |
| <dd> |
| <p>Column details such as size and count distribution, data generator, |
| names, comparator and if super columns should be used</p> |
| </dd> |
| <dt class="hdlist1">-rate:</dt> |
| <dd> |
| <p>Thread count, rate limit or automatic mode (default is auto)</p> |
| </dd> |
| <dt class="hdlist1">-mode:</dt> |
| <dd> |
| <p>Additional options for authentication and connection properties. Also, |
| "simplenative" can be selected as an alternative to the standalone Java driver</p> |
| </dd> |
| <dt class="hdlist1">-errors:</dt> |
| <dd> |
| <p>How to handle errors when encountered during stress</p> |
| </dd> |
| <dt class="hdlist1">-sample:</dt> |
| <dd> |
| <p>Specify the number of samples to collect for measuring latency</p> |
| </dd> |
| <dt class="hdlist1">-schema:</dt> |
| <dd> |
| <p>Replication settings, compression, compaction, etc.</p> |
| </dd> |
| <dt class="hdlist1">-node:</dt> |
| <dd> |
| <p>Nodes to connect to</p> |
| </dd> |
| <dt class="hdlist1">-log:</dt> |
| <dd> |
| <p>Where to log progress to, and the interval at which to do it</p> |
| </dd> |
| <dt class="hdlist1">-transport:</dt> |
| <dd> |
| <p>Custom transport factories</p> |
| </dd> |
| <dt class="hdlist1">-port:</dt> |
| <dd> |
| <p>The port to connect to cassandra nodes on</p> |
| </dd> |
| <dt class="hdlist1">-graph:</dt> |
| <dd> |
| <p>Graph recorded metrics</p> |
| </dd> |
| <dt class="hdlist1">-tokenrange:</dt> |
| <dd> |
| <p>Token range settings</p> |
| </dd> |
| <dt class="hdlist1">-jmx:</dt> |
| <dd> |
| <p>Username and password for JMX connection</p> |
| </dd> |
| <dt class="hdlist1">-credentials-file <path>:</dt> |
| <dd> |
| <p>Credentials file to specify for CQL, JMX and transport</p> |
| </dd> |
| <dt class="hdlist1">-reporting:</dt> |
| <dd> |
| <p>Frequency of printing statistics and header for stress output</p> |
| </dd> |
| </dl> |
| </div> |
| </dd> |
| <dt class="hdlist1">Suboptions</dt> |
| <dd> |
| <p>Every command and primary option has its own collection of suboptions. |
| These are too numerous to list here. For information on the suboptions |
| for each command or option, please use the help command, |
| <code>cassandra-stress help <command|option></code>.</p> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="user-mode"><a class="anchor" href="#user-mode"></a>User mode</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>User mode allows you to stress your own schemas, to save you time |
| in the long run. Find out if your application can scale using stress test with your schema.</p> |
| </div> |
| <div class="sect2"> |
| <h3 id="profile"><a class="anchor" href="#profile"></a>Profile</h3> |
| <div class="paragraph"> |
| <p>User mode defines a profile using YAML. |
| Multiple YAML files may be specified, in which case operations in the ops argument are referenced as |
| specname.opname.</p> |
| </div> |
| <div class="paragraph"> |
| <p>An identifier for the profile:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml">specname: staff_activities</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>The keyspace for the test:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml">keyspace: staff</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>CQL for the keyspace. Optional if the keyspace already exists:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml">keyspace_definition: | |
| CREATE KEYSPACE stresscql WITH replication = {'class': 'SimpleStrategy', 'replication_factor': 3};</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>The table to be stressed:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml">table: staff_activities</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>CQL for the table. Optional if the table already exists:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml">table_definition: | |
| CREATE TABLE staff_activities ( |
| name text, |
| when timeuuid, |
| what text, |
| PRIMARY KEY(name, when, what) |
| )</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Optional meta-information on the generated columns in the above table. |
| The min and max only apply to text and blob types. The distribution |
| field represents the total unique population distribution of that column |
| across rows:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml">columnspec: |
| - name: name |
| size: uniform(5..10) # The names of the staff members are between 5-10 characters |
| population: uniform(1..10) # 10 possible staff members to pick from |
| - name: when |
| cluster: uniform(20..500) # Staff members do between 20 and 500 events |
| - name: what |
| size: normal(10..100,50)</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Supported types are:</p> |
| </div> |
| <div class="paragraph"> |
| <p>An exponential distribution over the range [min..max]:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml">EXP(min..max)</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>An extreme value (Weibull) distribution over the range [min..max]:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml">EXTREME(min..max,shape)</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>A gaussian/normal distribution, where mean=(min+max)/2, and stdev is |
| (mean-min)/stdvrng:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml">GAUSSIAN(min..max,stdvrng)</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>A gaussian/normal distribution, with explicitly defined mean and stdev:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml">GAUSSIAN(min..max,mean,stdev)</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>A uniform distribution over the range [min, max]:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml">UNIFORM(min..max)</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>A fixed distribution, always returning the same value:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml">FIXED(val)</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>If preceded by ~, the distribution is inverted</p> |
| </div> |
| <div class="paragraph"> |
| <p>Defaults for all columns are size: uniform(4..8), population: |
| uniform(1..100B), cluster: fixed(1)</p> |
| </div> |
| <div class="paragraph"> |
| <p>Insert distributions:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml">insert: |
| # How many partition to insert per batch |
| partitions: fixed(1) |
| # How many rows to update per partition |
| select: fixed(1)/500 |
| # UNLOGGED or LOGGED batch for insert |
| batchtype: UNLOGGED</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Currently all inserts are done inside batches.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Read statements to use during the test:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml">queries: |
| events: |
| cql: select * from staff_activities where name = ? |
| fields: samerow |
| latest_event: |
| cql: select * from staff_activities where name = ? LIMIT 1 |
| fields: samerow</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Running a user mode test:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml">cassandra-stress user profile=./example.yaml duration=1m "ops(insert=1,latest_event=1,events=1)" truncate=once</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>This will create the schema then run tests for 1 minute with an equal |
| number of inserts, latest_event queries and events queries. Additionally |
| the table will be truncated once before the test.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The full example can be found here:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml">spacenam: example # idenitifier for this spec if running with multiple yaml files |
| keyspace: example |
| |
| # Would almost always be network topology unless running something locally |
| keyspace_definition: | |
| CREATE KEYSPACE example WITH replication = {'class': 'SimpleStrategy', 'replication_factor': 3}; |
| |
| table: staff_activities |
| |
| # The table under test. Start with a partition per staff member |
| # Is this a good idea? |
| table_definition: | |
| CREATE TABLE staff_activities ( |
| name text, |
| when timeuuid, |
| what text, |
| PRIMARY KEY(name, when) |
| ) |
| |
| columnspec: |
| - name: name |
| size: uniform(5..10) # The names of the staff members are between 5-10 characters |
| population: uniform(1..10) # 10 possible staff members to pick from |
| - name: when |
| cluster: uniform(20..500) # Staff members do between 20 and 500 events |
| - name: what |
| size: normal(10..100,50) |
| |
| insert: |
| # we only update a single partition in any given insert |
| partitions: fixed(1) |
| # we want to insert a single row per partition and we have between 20 and 500 |
| # rows per partition |
| select: fixed(1)/500 |
| batchtype: UNLOGGED # Single partition unlogged batches are essentially noops |
| |
| queries: |
| events: |
| cql: select * from staff_activities where name = ? |
| fields: samerow |
| latest_event: |
| cql: select * from staff_activities where name = ? LIMIT 1 |
| fields: samerow</code></pre> |
| </div> |
| </div> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Running a user mode test with multiple yaml files</dt> |
| <dd> |
| <p> cassandra-stress user profile=./example.yaml,./example2.yaml |
| duration=1m "ops(ex1.insert=1,ex1.latest_event=1,ex2.insert=2)" |
| truncate=once |
| This will run operations as specified in both the example.yaml and |
| example2.yaml files. example.yaml and example2.yaml can reference the |
| same table, although care must be taken that the table definition is identical |
| (data generation specs can be different).</p> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="lightweight-transaction-support"><a class="anchor" href="#lightweight-transaction-support"></a>Lightweight transaction support</h3> |
| <div class="paragraph"> |
| <p>cassandra-stress supports lightweight transactions. |
| To use this feature, the command will first read current data from Cassandra, and then uses read values to |
| fulfill lightweight transaction conditions.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Lightweight transaction update query:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml">queries: |
| regularupdate: |
| cql: update blogposts set author = ? where domain = ? and published_date = ? |
| fields: samerow |
| updatewithlwt: |
| cql: update blogposts set author = ? where domain = ? and published_date = ? IF body = ? AND url = ? |
| fields: samerow</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>The full example can be found here:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml"># Keyspace Name |
| keyspace: stresscql |
| |
| # The CQL for creating a keyspace (optional if it already exists) |
| # Would almost always be network topology unless running something locall |
| keyspace_definition: | |
| CREATE KEYSPACE stresscql WITH replication = {'class': 'SimpleStrategy', 'replication_factor': 1}; |
| |
| # Table name |
| table: blogposts |
| |
| # The CQL for creating a table you wish to stress (optional if it already exists) |
| table_definition: | |
| CREATE TABLE blogposts ( |
| domain text, |
| published_date timeuuid, |
| url text, |
| author text, |
| title text, |
| body text, |
| PRIMARY KEY(domain, published_date) |
| ) WITH CLUSTERING ORDER BY (published_date DESC) |
| AND compaction = { 'class':'LeveledCompactionStrategy' } |
| AND comment='A table to hold blog posts' |
| |
| ### Column Distribution Specifications ### |
| |
| columnspec: |
| - name: domain |
| size: gaussian(5..100) #domain names are relatively short |
| population: uniform(1..10M) #10M possible domains to pick from |
| |
| - name: published_date |
| cluster: fixed(1000) #under each domain we will have max 1000 posts |
| |
| - name: url |
| size: uniform(30..300) |
| |
| - name: title #titles shouldn't go beyond 200 chars |
| size: gaussian(10..200) |
| |
| - name: author |
| size: uniform(5..20) #author names should be short |
| |
| - name: body |
| size: gaussian(100..5000) #the body of the blog post can be long |
| |
| ### Batch Ratio Distribution Specifications ### |
| |
| insert: |
| partitions: fixed(1) # Our partition key is the domain so only insert one per batch |
| |
| select: fixed(1)/1000 # We have 1000 posts per domain so 1/1000 will allow 1 post per batch |
| |
| batchtype: UNLOGGED # Unlogged batches |
| |
| |
| # |
| # A list of queries you wish to run against the schema |
| # |
| queries: |
| singlepost: |
| cql: select * from blogposts where domain = ? LIMIT 1 |
| fields: samerow |
| regularupdate: |
| cql: update blogposts set author = ? where domain = ? and published_date = ? |
| fields: samerow |
| updatewithlwt: |
| cql: update blogposts set author = ? where domain = ? and published_date = ? IF body = ? AND url = ? |
| fields: samerow</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="graphing"><a class="anchor" href="#graphing"></a>Graphing</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>Graphs can be generated for each run of stress.</p> |
| </div> |
| <div class="imageblock"> |
| <div class="content"> |
| <img src="../_images/example-stress-graph.png" alt="example cassandra-stress graph"> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>To create a new graph:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml">cassandra-stress user profile=./stress-example.yaml "ops(insert=1,latest_event=1,events=1)" -graph file=graph.html title="Awesome graph"</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>To add a new run to an existing graph point to an existing file and add |
| a revision name:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml">cassandra-stress user profile=./stress-example.yaml duration=1m "ops(insert=1,latest_event=1,events=1)" -graph file=graph.html title="Awesome graph" revision="Second run"</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="faq"><a class="anchor" href="#faq"></a>FAQ</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p><strong>How do you use NetworkTopologyStrategy for the keyspace?</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>Use the schema option making sure to either escape the parenthesis or |
| enclose in quotes:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml">cassandra-stress write -schema "replication(strategy=NetworkTopologyStrategy,datacenter1=3)"</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p><strong>How do you use SSL?</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>Use the transport option:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml">cassandra-stress "write n=100k cl=ONE no-warmup" -transport "truststore=$HOME/jks/truststore.jks truststore-password=cassandra"</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Is Cassandra Stress a secured tool?</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>Cassandra stress is not a secured tool. Serialization and other aspects |
| of the tool offer no security guarantees.</p> |
| </div> |
| </div> |
| </div> |
| </article> |
| </main> |
| </div> |
| </div> |
| <footer class="grad grad--two flex-center pb-xlarge"> |
| <div class="inner text-center z2 relative"> |
| <h2 class="white py-small">Get started with Cassandra, fast.</h2> |
| <a id="footer-cta" href="/_/quickstart.html" class="btn btn--filled ma-medium">Quickstart Guide</a> |
| </div> |
| <div class="inner flex flex-distribute-items mt-xlarge z2 relative"> |
| <div class="col-2"> |
| <div id="footer-logo" class="logo logo--footer mb-medium"><img src="../../../../assets/img/logo-white-r.png" alt="Cassandra Logo"></div> |
| <p>Apache Cassandra<img src="../../../../assets/img/registered.svg" alt="®" style="width:18px;"> powers mission-critical deployments with improved performance and unparalleled levels of scale in the cloud.</p> |
| <div class="footer-social-icons"> |
| <a href="https://twitter.com/cassandra?lang=en" target="_blank"><img src="../../../../assets/img/twitter-icon-circle-white.svg" alt="twitter icon" width="24"></a> |
| <a href="https://www.linkedin.com/company/apache-cassandra/" target="_blank"><img src="../../../../assets/img/LI-In-Bug.png" alt="linked-in icon" width="24"></a> |
| <a href="https://www.youtube.com/c/PlanetCassandra" target="_blank"><img src="../../../../assets/img/youtube-icon.png" alt="youtube icon" width="24"></a> |
| </div> |
| </div> |
| <div class="col-2 flex flex-center"> |
| <ul class="columns-2"> |
| <li class="mb-small"><a href="/">Home</a></li> |
| <li class="mb-small"><a href="/_/cassandra-basics.html">Cassandra Basics</a></li> |
| <li class="mb-small"><a href="/_/quickstart.html">Quickstart</a></li> |
| <li class="mb-small"><a href="/_/ecosystem.html">Ecosystem</a></li> |
| <li class="mb-small"><a href="/doc/latest/">Documentation</a></li> |
| <li class="mb-small"><a href="/_/community.html">Community</a></li> |
| <li class="mb-small"><a href="/_/case-studies.html">Case Studies</a></li> |
| <li class="mb-small"><a href="/_/resources.html">Resources</a></li> |
| <li class="mb-small"><a href="/_/blog.html">Blog</a></li> |
| </ul> |
| </div> |
| </div> |
| </footer> |
| <div class="lower-footer bg-white pa-medium"> |
| <div class="flex flex-row flex-vert-center"> |
| <div class="pr-medium"><img src="../../../../assets/img//feather-small.png" alt="ASF" width="20"></div> |
| <div class="pr-medium"><a href="http://www.apache.org/" target="_blank">Foundation</a></div> |
| <div class="pr-medium"><a href="https://www.apache.org/events/current-event.html" target="_blank">Events</a></div> |
| <div class="pr-medium"><a href="https://www.apache.org/licenses/" target="_blank">License</a></div> |
| <div class="pr-medium"><a href="https://www.apache.org/foundation/thanks" target="_blank">Thanks</a></div> |
| <div class="pr-medium"><a href="https://www.apache.org/security" target="_blank">Security</a></div> |
| <div class="pr-medium"><a href="https://privacy.apache.org/policies/privacy-policy-public.html" target="_blank">Privacy</a></div> |
| <div class="pr-medium"><a href="https://www.apache.org/foundation/sponsorship" target="_blank">Sponsorship</a></div> |
| </div> |
| <p class="my-medium">© 2009-<script>document.write(new Date().getFullYear())</script> <a href="https://apache.org" target="_blank">The Apache Software Foundation</a> under the terms of the Apache License 2.0. Apache, the Apache feather logo, Apache Cassandra, Cassandra, and the Cassandra logo, are either registered trademarks or trademarks of The Apache Software Foundation.</p> |
| </div> |
| <div id="fade" class="hidden"></div> |
| <div id="modal" class="hidden"> |
| <div id="close-modal" class="cursor-pointer"><svg viewBox="0 0 24 24" width="24" height="24" stroke="currentColor" stroke-width="2" fill="none" stroke-linecap="round" stroke-linejoin="round" class="css-i6dzq1"><line x1="18" y1="6" x2="6" y2="18"></line><line x1="6" y1="6" x2="18" y2="18"></line></svg></div> |
| <div id="mod-content" class="vid-mod-content resp-container"></div> |
| </div> |
| <script src="../../../../assets/js/site.js"></script> |
| <script async src="../../../../assets/js/vendor/highlight.js"></script> |
| <script src="../../../../assets/js/vendor/lunr.js"></script> |
| <script src="../../../../assets/js/vendor/search.js" id="search-script" data-base-path="../../../.." data-page-path="/Cassandra/5.0/cassandra/tooling/cassandra-stress.html"></script> |
| <script async src="../../../../assets/../search-index.js"></script> |
| <script> |
| jQuery(function(){ |
| var windowW = $(window).width(); |
| $(document) |
| .on('click','.mobile-nav-icon',function(){ |
| $('.main-nav').fadeIn(); |
| }) |
| .on('click','.main-nav',function(){ |
| if(windowW <= 1000){ |
| $(this).fadeOut(); |
| } |
| }) |
| .on('click','#version-toggle',function(){ |
| $(this).toggleClass('active'); |
| $(this).next().fadeToggle(); |
| }) |
| .on('click','#mobile-docs-nav-burger', function(){ |
| $(this).toggleClass('active'); |
| $('.docs-nav').toggleClass('active'); |
| }); |
| var url = window.location.pathname; |
| var isQuickstart = url.includes('quickstart.html'); |
| if(isQuickstart){ |
| var footerCTA = document.getElementById('footer-cta'); |
| footerCTA.innerHTML = 'Get latest updates'; |
| footerCTA.setAttribute('href', '/_/blog.html'); |
| } |
| }); |
| </script> |
| </div> |
| </body> |
| </html> |
