| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width,initial-scale=1.0"> |
| <title>Virtual tables for SAI indexes and SSTables | Apache Cassandra Documentation</title> |
| <link rel="stylesheet" href="../../../../assets/css/site.css"> |
| <meta name="description" content="Provides details about virtual tables for Storage Attached Indexing (SAI) indexes and SSTables."> |
| <link rel="schema.dcterms" href="https://purl.org/dc/terms/"> |
| <meta name="dcterms.subject" content="Cassandra"> |
| <meta name="dcterms.identifier" content="trunk"> |
| <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:description" content="" /> |
| <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">trunk</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 is-current"> |
| <a href="../../index.html">trunk</a> |
| </li> |
| <li class="version"> |
| <a href="../../../5.0/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="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="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="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="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="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="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="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="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="sai-virtual-table-indexes.html">Virtual tables for SAI indexes and SSTables</a></li> |
| </ul> |
| </nav> |
| <div class="tools" role="navigation"> |
| <ul> |
| <li class="tool edit"><a href="https://github.com/apache/cassandra/edit/trunk/doc/modules/cassandra/pages/reference/sai-virtual-table-indexes.adoc" title="Edit Page" target="_blank" rel="noopener">Edit</a></li> |
| </ul> |
| </div> |
| </div> |
| <article class="doc"> |
| <h1 class="page">Virtual tables for SAI indexes and SSTables</h1> |
| <div id="preamble"> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>Storage Attached Indexing (SAI) provides CQL-based virtual tables that enable you to discover the current state of system metadata for SAI indices and associated SSTables. |
| These virtual tables reside in the <code>system_views</code> keyspace.</p> |
| </div> |
| <div class="paragraph"> |
| <p>For related information, see the <a href="#cassandra:developing/indexing/sai/sai-overview.adoc" class="page unresolved">SAI information</a>.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="system_views-indexes"><a class="anchor" href="#system_views-indexes"></a>system_views.indexes</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>The <code>system_views.indexes</code> virtual table contains stateful information about SAI indexes. |
| This view provides information at the column index level, including the index name, number of indexed SSTables, disk usage, and index state. |
| From the index state, the data reveals if the index is currently building, and whether the index can be queried.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Use CQL to view the table’s description. |
| Example:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-language-cql hljs" data-lang="language-cql">DESCRIBE TABLE system_views.indexes;</code></pre> |
| </div> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-results hljs" data-lang="results">/* |
| Warning: Table system_views.indexes is a virtual table and cannot be recreated with CQL. |
| Structure, for reference: |
| VIRTUAL TABLE system_views.indexes ( |
| keyspace_name text, |
| index_name text, |
| analyzer text, |
| cell_count bigint, |
| column_name text, |
| indexed_sstable_count int, |
| is_building boolean, |
| is_queryable boolean, |
| is_string boolean, |
| per_column_disk_size bigint, |
| per_table_disk_size bigint, |
| table_name text, |
| PRIMARY KEY (keyspace_name, index_name) |
| ) WITH CLUSTERING ORDER BY (index_name ASC) |
| AND comment = 'Storage-attached column index metadata'; |
| */</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>To view the current data, submit a query such as:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-language-cql hljs" data-lang="language-cql">SELECT * FROM system_views.indexes;</code></pre> |
| </div> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-results hljs" data-lang="results"> keyspace_name | index_name | analyzer | cell_count | column_name | indexed_sstable_count | is_building | is_queryable | is_string | per_column_disk_size | per_table_disk_size | table_name |
| ---------------+----------------------+-------------------------------------------------------------+------------+--------------+-----------------------+-------------+--------------+-----------+----------------------+---------------------+------------------ |
| cycling | age_sai_idx | NoOpAnalyzer{} | 0 | age | 0 | False | True | False | 0 | 0 | cyclist_semi_pro |
| cycling | country_sai_idx | NonTokenizingAnalyzer{caseSensitive=false, normalized=true} | 0 | country | 0 | False | True | True | 0 | 0 | cyclist_semi_pro |
| cycling | lastname_sai_idx | NonTokenizingAnalyzer{caseSensitive=false, normalized=true} | 0 | lastname | 0 | False | True | True | 0 | 0 | cyclist_semi_pro |
| cycling | registration_sai_idx | NoOpAnalyzer{} | 0 | registration | 0 | False | True | False | 0 | 0 | cyclist_semi_pro |
| |
| (4 rows)</code></pre> |
| </div> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <caption class="title">system_views.indexes metadata</caption> |
| <colgroup> |
| <col style="width: 25.9259%;"> |
| <col style="width: 18.5185%;"> |
| <col style="width: 55.5556%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Column name</th> |
| <th class="tableblock halign-left valign-top">CQL type</th> |
| <th class="tableblock halign-left valign-top">Meaning</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>keyspace_name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>text</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The name of the keyspace to which the index belongs.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>index_name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>text</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The name of the index.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>analyzer</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>text</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The <code>toString</code> representation of the analyzer used by the index.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>cell_count</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bigint</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The number of indexed table cells, or the number of index value-key entries. |
| This is the sum of the number of index entries in each SSTable.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>column_name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>text</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The name of the indexed column.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>indexed_sstable_count</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The number of indexed SSTables. |
| Note that SSTables without relevant data won’t be indexed or counted here.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>is_building</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Whether there is a on going build for the index.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>is_queryable</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Whether it is possible to query the index. |
| It won’t be possible if the initial task build hasn’t finished yet.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>is_string</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Whether the index is for a text field (<code>ascii</code>, <code>text</code>, or <code>varchar</code>).</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>per_column_disk_size</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bigint</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The on-disk size of the index components that are exclusive to the column, in bytes.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>per_table_disk_size</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bigint</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The on-disk size of the index components that are shared with other SAI indexes for the same table, in bytes.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>table_name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>text</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The name of the table to which the indexed column belongs.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="system_views-sstable_indexes"><a class="anchor" href="#system_views-sstable_indexes"></a>system_views.sstable_indexes</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>The <code>system_views.sstable_indexes</code> virtual table has a row per SAI index and SSTable. |
| This view describes individual SSTable indexes, and includes information around disk size, min/max row ID, the min/max ring token, and the write-time version of the index.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Use CQL to view the table’s description. |
| Example:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-language-cql hljs" data-lang="language-cql">DESCRIBE TABLE system_views.sstable_indexes;</code></pre> |
| </div> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-results hljs" data-lang="results">/* |
| Warning: Table system_views.sstable_indexes is a virtual table and cannot be recreated with CQL. |
| Structure, for reference: |
| VIRTUAL TABLE system_views.sstable_indexes ( |
| keyspace_name text, |
| index_name text, |
| sstable_name text, |
| cell_count bigint, |
| column_name text, |
| end_token text, |
| format_version text, |
| max_row_id bigint, |
| min_row_id bigint, |
| per_column_disk_size bigint, |
| per_table_disk_size bigint, |
| start_token text, |
| table_name text, |
| PRIMARY KEY (keyspace_name, index_name, sstable_name) |
| ) WITH CLUSTERING ORDER BY (index_name ASC, sstable_name ASC) |
| AND comment = 'SSTable index metadata'; |
| */</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>To view the current data, submit a query such as:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-language-cql hljs" data-lang="language-cql">SELECT * FROM system_views.sstable_indexes;</code></pre> |
| </div> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <caption class="title">system_views.sstable_indexes metadata<</caption> |
| <colgroup> |
| <col style="width: 25.9259%;"> |
| <col style="width: 18.5185%;"> |
| <col style="width: 55.5556%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Column name</th> |
| <th class="tableblock halign-left valign-top">CQL type</th> |
| <th class="tableblock halign-left valign-top">Meaning</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>keyspace_name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>text</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The name of the keyspace to which the index belongs.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>index_name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>text</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The name of the index.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>sstable_name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>text</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The name of the SSTable.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>cell_count</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bigint</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The number of indexed table cells, or the number of index value-key entries.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>column_name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>text</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The name of the indexed column.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>start_token</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>text</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The start of the token range covered by the indexed SSTable.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>end_token</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>text</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The end of the token range covered by the indexed SSTable.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>min_row_id</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bigint</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The minimum row id in the SSTable index.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>max_row_id</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bigint</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The maximum row id in the SSTable index.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>per_column_disk_size</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bigint</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The on-disk size of the SSTable index components that are exclusive to the column, in bytes.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>per_table_disk_size</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bigint</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The on-disk size of the SSTable index components that are shared with other SAI indexes for the same table, in bytes.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>table_name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>text</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The name of the table to which the indexed column belongs.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="system_views-sstable_index_segments"><a class="anchor" href="#system_views-sstable_index_segments"></a>system_views.sstable_index_segments</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>The <code>system_views.sstable_index_segments</code> virtual table has a row per SAI index and SSTable segment. |
| This view describes the segments of the SSTable indexes. |
| It exposes the segment row ID offset and most of the information in the SSTable-level virtual table, specifically at a segment granularity.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Use CQL to view the table’s description. |
| Example:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-language-cql hljs" data-lang="language-cql">DESCRIBE TABLE system_views.sstable_index_segments;</code></pre> |
| </div> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-results hljs" data-lang="results">/* |
| Warning: Table system_views.sstable_index_segments is a virtual table and cannot be recreated with CQL. |
| Structure, for reference: |
| VIRTUAL TABLE system_views.sstable_index_segments ( |
| keyspace_name text, |
| index_name text, |
| sstable_name text, |
| segment_row_id_offset bigint, |
| cell_count bigint, |
| column_name text, |
| component_metadata frozen<map<text, map<text, text>>>, |
| end_token text, |
| max_sstable_row_id bigint, |
| max_term text, |
| min_sstable_row_id bigint, |
| min_term text, |
| start_token text, |
| table_name text, |
| PRIMARY KEY (keyspace_name, index_name, sstable_name, segment_row_id_offset) |
| ) WITH CLUSTERING ORDER BY (index_name ASC, sstable_name ASC, segment_row_id_offset ASC) |
| AND comment = 'SSTable index segment metadata'; |
| */</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>To view the current data, submit a query such as:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-language-cql hljs" data-lang="language-cql">SELECT * FROM system_views.sstable_index_segments;</code></pre> |
| </div> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <caption class="title">system_views.sstable_index_segments metadata</caption> |
| <colgroup> |
| <col style="width: 26.3157%;"> |
| <col style="width: 28.9473%;"> |
| <col style="width: 44.737%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Column name</th> |
| <th class="tableblock halign-left valign-top">CQL type</th> |
| <th class="tableblock halign-left valign-top">Meaning</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>keyspace_name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>text</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The name of the keyspace to which the index belongs.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>index_name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>text</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The name of the index.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>sstable_name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>text</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The name of the SSTable.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>segment_row_id_offset</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bigint</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The row id offset for the SSTable segment.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>cell_count</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bigint</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The number of indexed segments, or the number of index segments value-key entries.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>column_name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>text</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The name of the indexed column.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>component_metadata</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>frozen<map<text, map<text, text>>></code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The component metadata in the SSTable segment.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>end_token</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>text</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The end of the token range covered by the SSTable segment.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>max_sstable_row_id</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bigint</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The maximum row id in the SSTable segment.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>max_term</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>text</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The maximum term in the SSTable segment.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>min_sstable_row_id</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bigint</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The minimum row id in the SSTable segment.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>min_term</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>text</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The minimum term in the SSTable segment.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>start_token</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>text</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The start of the token range covered by the SSTable segment.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>table_name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>text</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The name of the table to which the SSTable segment belongs.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </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/trunk/cassandra/reference/sai-virtual-table-indexes.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> |
