| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width,initial-scale=1.0"> |
| <title>CREATE INDEX | Apache Cassandra Documentation</title> |
| <link rel="stylesheet" href="../../../../../assets/css/site.css"> |
| <meta name="description" content="Defines a new secondary index (2i) or storage-attached index (SAI) for a single column of a table."> |
| <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 is-current-path is-active" 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 is-current-path is-active" 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="alter-table.html">ALTER TABLE</a> |
| </span> |
| </li> |
| <li class="nav-item is-current-page is-active" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="create-index.html">CREATE INDEX</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="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="create-table.html">CREATE TABLE</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="drop-index.html">DROP INDEX</a> |
| </span> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <span class="nav-line"> |
| <a class="nav-link" href="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">Cassandra</li> |
| <li class="crumb"><a href="../index.html">Reference</a></li> |
| <li class="crumb"><a href="create-index.html">CREATE INDEX</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/cql-commands/create-index.adoc" title="Edit Page" target="_blank" rel="noopener">Edit</a></li> |
| </ul> |
| </div> |
| </div> |
| <article class="doc"> |
| <h1 class="page">CREATE INDEX</h1> |
| <div id="preamble"> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>Defines a new secondary index (2i) or storage-attached index (SAI) for a single column of a table.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Apache Cassandra supports creating a secondary index or storage-attached index on most columns, including the partition and cluster columns of a <code>PRIMARY KEY</code>, collections, and static columns. |
| For maps, you can index using the key, value, or entries (a key:value pair).</p> |
| </div> |
| <div class="paragraph"> |
| <p>All column date types except the following are supported for SAI indexes:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code>counter</code></p> |
| </li> |
| <li> |
| <p>non-frozen user-defined type (UDT)</p> |
| </li> |
| </ul> |
| </div> |
| <div class="sidebarblock"> |
| <div class="content"> |
| <div class="title">One exception</div> |
| <div class="paragraph"> |
| <p>You cannot define an SAI index based on the partition key when it’s comprised of only one column. |
| If you attempt to create an SAI index in this case, SAI issues an error message.</p> |
| </div> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p><strong>See also:</strong> <a href="create-custom-index.html" class="page">CREATE CUSTOM INDEX</a> for Storage-Attached Indexes (SAI), <a href="drop-index.html" class="page">DROP INDEX</a></p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="syntax"><a class="anchor" href="#syntax"></a>Syntax</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>BNF definition:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-bnf hljs" data-lang="bnf">index_name::= re('[a-zA-Z_0-9]+')</code></pre> |
| </div> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre>CREATE INDEX [ IF NOT EXISTS ] <index_name> |
| ON [<keyspace_name>.]<table_name> |
| ( [ ( KEYS | FULL | ENTRIES ) ] <column_name>) |
| // | [ (KEYS(<map_name>)) ] |
| // | [ (VALUES(<map_name>)) ] |
| // | [ (ENTRIES(<map_name>)) ] |
| [USING 'sai'] |
| [ WITH OPTIONS = { <option_map> } ];</pre> |
| </div> |
| </div> |
| <div class="exampleblock"> |
| <div class="title">Syntax legend</div> |
| <div class="content"> |
| <table class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Legend</caption> |
| <colgroup> |
| <col style="width: 50%;"> |
| <col style="width: 50%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Syntax conventions</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">UPPERCASE</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Literal keyword.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Lowercase</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Not literal.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>< ></code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Variable value. |
| Replace with a user-defined value.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>[]</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Optional. |
| Square brackets (<code>[]</code>) surround optional command arguments. |
| Do not type the square brackets.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>( )</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Group. |
| Parentheses ( <code>( )</code> ) identify a group to choose from. |
| Do not type the parentheses.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>|</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Or. |
| A vertical bar (<code>|</code>) separates alternative elements. |
| Type any one of the elements. |
| Do not type the vertical bar.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>...</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Repeatable. |
| An ellipsis ( <code>...</code> ) indicates that you can repeat the syntax element as often as required.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>'<Literal string>'</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Single quotation (<code>'</code>) marks must surround literal strings in CQL statements. |
| Use single quotation marks to preserve upper case.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>{ <key> : <value> }</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Map collection. |
| Braces (<code>{ }</code>) enclose map collections or key value pairs. |
| A colon separates the key and the value.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#datatype1>"><datatype2</a></code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Set, list, map, or tuple. |
| Angle brackets ( <code>< ></code> ) enclose data types in a set, list, map, or tuple. |
| Separate the data types with a comma.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><cql_statement>;</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">End CQL statement. |
| A semicolon (<code>;</code>) terminates all CQL statements.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>[--]</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Separate the command line options from the command arguments with two hyphens ( <code>--</code> ). |
| This syntax is useful when arguments might be mistaken for command line options.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>' <<schema\> ... |
| </schema\>> '</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Search CQL only: Single quotation marks (<code>'</code>) surround an entire XML schema declaration.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>@<xml_entity>='<xml_entity_type>'</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Search CQL only: Identify the entity and literal value to overwrite the XML element in the schema and solrConfig files.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="required-parameters"><a class="anchor" href="#required-parameters"></a>Required parameters</h2> |
| <div class="sectionbody"> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 25%;"> |
| <col style="width: 75%;"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Parameter</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">table_name</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Name of the table to index.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">column_name</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Name of the column to index. |
| SAI allows only alphanumeric characters and underscores in names. |
| SAI returns <code>InvalidRequestException</code> if you try to define an index on a column name that contains other characters, and does not create the index.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="optional-parameters"><a class="anchor" href="#optional-parameters"></a>Optional parameters</h2> |
| <div class="sectionbody"> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 25%;"> |
| <col style="width: 75%;"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Parameter</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">index_name</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Name of the index. |
| Enclose in quotes to use special characters or preserve capitalization. |
| If no name is specified, Apache Cassandra names the index as <code><table_name>\_<column_name>\_idx</code>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">keyspace_name</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Name of the keyspace that contains the table to index. |
| If no name is specified, the current keyspace is used.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">map_name</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Used with <a href="../../developing/cql/collections/collection-create.html" class="page">collections</a>, identifier of the <code>map_name</code> specified in <code>CREATE TABLE</code> …​ |
| <code>map(<map_name>)</code>. |
| The regular column syntax applies for collection types <code>list</code> and <code>set</code>.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 33.3333%;"> |
| <col style="width: 33.3333%;"> |
| <col style="width: 33.3334%;"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">option_map</p></td> |
| <td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock">Define options in JSON simple format.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top" rowspan="4"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>case_sensitive</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Ignore case in matching string values. Default: <code>true</code></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>normalize</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">When set to <code>true</code>, perform <a href="https://unicode.org/faq/normalization.html">Unicode normalization</a> on indexed strings. |
| SAI supports Normalization Form C (NFC) Unicode. |
| When set to <code>true</code>, SAI normalizes the different versions of a given Unicode character to a single version, retaining all the marks and symbols in the index. |
| For example, SAI would change the character Å (U+212B) to Å (U+00C5).</p> |
| <p class="tableblock">When implementations keep strings in a normalized form, equivalent strings have a unique binary representation. |
| See <a href="https://unicode.org/reports/tr15/">Unicode Standard Annex #15, Unicode Normalization Forms</a>.</p> |
| <p class="tableblock">Default: <code>false</code>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ascii</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">When set to <code>true</code>, SAI converts alphabetic, numeric, and symbolic characters that are not in the Basic Latin Unicode block (the first 127 ASCII characters) to the ASCII equivalent, if one exists. |
| For example, this option changes à to a. |
| Default: <code>false</code>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>similarity_function</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Vector search relies on computing the similarity or distance between vectors to identify relevant matches. |
| The similarity function is used to compute the similarity between two vectors. |
| Valid options are: <code>EUCLIDEAN</code>, <code>DOT_PRODUCT</code>, <code>COSINE</code> |
| Default: <code>COSINE</code></p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="usage-notes"><a class="anchor" href="#usage-notes"></a>Usage notes</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>If the column already contains data, it is indexed during the execution of this statement. |
| After an index has been created, it is automatically updated when data in the column changes.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Indexing with the <code>CREATE INDEX</code> command can impact performance. |
| Before creating an index, be aware of when and <a href="../../developing/cql/indexing/2i/2i-when-to-use.html#when-no-index" class="page">when not to create an index</a>.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Restriction:</strong> Indexing counter columns is not supported.</p> |
| </div> |
| <div class="sect2"> |
| <h3 id="sai-indexes"><a class="anchor" href="#sai-indexes"></a>SAI indexes</h3> |
| <div class="paragraph"> |
| <p>You can define an SAI index on one of the columns in a table’s composite partition key, i.e., a partition key comprised of multiple columns. |
| If you need to query based on one of those columns, an SAI index is a helpful option. |
| In fact, you can define an SAI index on each column in a composite partition key, if needed.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Defining one or more SAI indexes based on any column in a database table allows queries to use the indexed column to filter results.</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="sai-query-operators"><a class="anchor" href="#sai-query-operators"></a>SAI query operators</h3> |
| <div class="paragraph"> |
| <p>SAI supports the following query operators for tables with SAI indexes:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>Numerics: <code>=</code>, <code><</code>, <code>></code>, <code>⇐</code>, <code>>=</code>, <code>AND</code>, <code>OR</code>, <code>IN</code></p> |
| </li> |
| <li> |
| <p>Strings: <code>=</code>, <code>CONTAINS</code>, <code>CONTAINS KEY</code>, <code>AND</code>, <code>OR</code>, <code>IN</code></p> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>SAI does not support the following query operators for tables with SAI indexes:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>Strings or Numerics: <code>LIKE</code></p> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>See the <a href="../../developing/cql/indexing/sai/sai-overview.html" class="page">SAI section</a>.</p> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="examples"><a class="anchor" href="#examples"></a>Examples</h2> |
| <div class="sectionbody"> |
| <div class="sect2"> |
| <h3 id="creating-a-sai-index-on-a-clustering-column"><a class="anchor" href="#creating-a-sai-index-on-a-clustering-column"></a>Creating a SAI index on a clustering column</h3> |
| <div class="paragraph"> |
| <p>Define a table having a <a href="create-table.html#cqlPKcomposite" class="page">composite partition key</a>, and then create an index on a clustering column.</p> |
| </div> |
| <div class="tabset is-loading"> |
| <div class="ulist tabs"> |
| <ul> |
| <li> |
| <p><a id="tabset1_create-table"></a>CREATE TABLE</p> |
| </li> |
| <li> |
| <p><a id="tabset1_create-index"></a>CREATE INDEX</p> |
| </li> |
| <li> |
| <p><a id="tabset1_select-query"></a>SELECT query</p> |
| </li> |
| <li> |
| <p><a id="tabset1_select-result"></a>SELECT result</p> |
| </li> |
| </ul> |
| </div> |
| <div class="content"> |
| <div class="tab-pane" aria-labelledby="tabset1_create-table"> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-language-cql hljs" data-lang="language-cql">CREATE TABLE IF NOT EXISTS cycling.rank_by_year_and_name ( |
| race_year int, |
| race_name text, |
| cyclist_name text, |
| rank int, |
| PRIMARY KEY ((race_year, race_name), rank) |
| );</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="tab-pane" aria-labelledby="tabset1_create-index"> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-language-cql hljs" data-lang="language-cql">CREATE INDEX IF NOT EXISTS rank_idx |
| ON cycling.rank_by_year_and_name (rank);</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="tab-pane" aria-labelledby="tabset1_select-query"> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-language-cql hljs" data-lang="language-cql">SELECT * FROM rank_by_year_and_name WHERE rank = 1;</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="tab-pane" aria-labelledby="tabset1_select-result"> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-language-cql hljs" data-lang="language-cql"> race_year | race_name | rank | cyclist_name |
| -----------+--------------------------------------------+------+------------------- |
| 2014 | 4th Tour of Beijing | 1 | Phillippe GILBERT |
| 2014 | Tour of Japan - Stage 4 - Minami > Shinshu | 1 | Daniel MARTIN |
| 2015 | Giro d'Italia - Stage 11 - Forli > Imola | 1 | Ilnur ZAKARIN |
| 2015 | Tour of Japan - Stage 4 - Minami > Shinshu | 1 | Benjamin PRADES |
| |
| (4 rows)</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="creating-an-index-on-a-set-or-list-collection"><a class="anchor" href="#creating-an-index-on-a-set-or-list-collection"></a>Creating an index on a set or list collection</h3> |
| <div class="paragraph"> |
| <p>Create an index on a set or list collection column as you would any other column. |
| Enclose the name of the collection column in parentheses at the end of the <code>CREATE INDEX</code> statement. |
| For example, add a collection of teams to the <code>cyclist_career_teams</code> table to index the data in the teams set.</p> |
| </div> |
| <div class="tabset is-loading"> |
| <div class="ulist tabs"> |
| <ul> |
| <li> |
| <p><a id="tabset2_create-table"></a>CREATE TABLE</p> |
| </li> |
| <li> |
| <p><a id="tabset2_create-index"></a>CREATE INDEX</p> |
| </li> |
| <li> |
| <p><a id="tabset2_select-query"></a>SELECT query</p> |
| </li> |
| <li> |
| <p><a id="tabset2_select-result"></a>SELECT result</p> |
| </li> |
| </ul> |
| </div> |
| <div class="content"> |
| <div class="tab-pane" aria-labelledby="tabset2_create-table"> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-language-cql hljs" data-lang="language-cql">CREATE TABLE IF NOT EXISTS cycling.cyclist_career_teams ( |
| id UUID PRIMARY KEY, |
| lastname text, |
| teams set<text> |
| );</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="tab-pane" aria-labelledby="tabset2_create-index"> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-language-cql hljs" data-lang="language-cql">CREATE INDEX IF NOT EXISTS teams_idx |
| ON cycling.cyclist_career_teams (teams);</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="tab-pane" aria-labelledby="tabset2_select-query"> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-language-cql hljs" data-lang="language-cql">SELECT * FROM cyclist_career_teams WHERE teams CONTAINS 'Rabobank-Liv Woman Cycling Team';</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="tab-pane" aria-labelledby="tabset2_select-result"> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-language-cql hljs" data-lang="language-cql"> id | lastname | teams |
| --------------------------------------+-----------------+------------------------------------------------------------------------------------------------------ |
| 5b6962dd-3f90-4c93-8f61-eabfa4a803e2 | VOS | {'Nederland bloeit', 'Rabobank Women Team', 'Rabobank-Liv Giant', 'Rabobank-Liv Woman Cycling Team'} |
| 1c9ebc13-1eab-4ad5-be87-dce433216d40 | BRAND | {'AA Drink - Leontien.nl', 'Leontien.nl', 'Rabobank-Liv Giant', 'Rabobank-Liv Woman Cycling Team'} |
| e7cd5752-bc0d-4157-a80f-7523add8dbcd | VAN DER BREGGEN | {'Rabobank-Liv Woman Cycling Team', 'Sengers Ladies Cycling Team', 'Team Flexpoint'} |
| |
| (3 rows)</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="CreatIdxCollKey"><a class="anchor" href="#CreatIdxCollKey"></a>Creating an index on map keys</h3> |
| <div class="paragraph"> |
| <p>You can create an index on <a href="#cassandra:developing/cql/indexing/2i/_2i-create-on-collection.adoc" class="page unresolved">map collection keys</a>. |
| If an index of the map values of the collection exists, drop that index before creating an index on the map collection keys. |
| Assume a cyclist table contains this map data where <code>nation is the map key and `Canada</code> is the map value`:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-no-highlight hljs" data-lang="no-highlight">{'nation':'CANADA' }</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>To index map keys, use the <code>KEYS</code> keyword and map name in nested parentheses in the CREATE INDEX statement. |
| To run a <code>SELECT</code> query on the table, use <a href="#cassandra:reference/cql-commands/select.adoc#filtering-on-collections" class="page unresolved">CONTAINS KEY</a> in <code>WHERE</code> clauses. |
| This query returns cyclist teams that have an entry for the year 2015.</p> |
| </div> |
| <div class="tabset is-loading"> |
| <div class="ulist tabs"> |
| <ul> |
| <li> |
| <p><a id="tabset3_create-table"></a>CREATE TABLE</p> |
| </li> |
| <li> |
| <p><a id="tabset3_create-index"></a>CREATE INDEX</p> |
| </li> |
| <li> |
| <p><a id="tabset3_select-query"></a>SELECT query</p> |
| </li> |
| <li> |
| <p><a id="tabset3_select-result"></a>SELECT result</p> |
| </li> |
| </ul> |
| </div> |
| <div class="content"> |
| <div class="tab-pane" aria-labelledby="tabset3_create-table"> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-language-cql hljs" data-lang="language-cql">CREATE TABLE IF NOT EXISTS cycling.cyclist_teams ( |
| id uuid PRIMARY KEY, |
| firstname text, |
| lastname text, |
| teams map<int, text> |
| );</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="tab-pane" aria-labelledby="tabset3_create-index"> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-language-cql hljs" data-lang="language-cql">CREATE INDEX IF NOT EXISTS team_year_keys_idx |
| ON cycling.cyclist_teams ( KEYS (teams) );</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="tab-pane" aria-labelledby="tabset3_select-query"> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-language-cql hljs" data-lang="language-cql">SELECT * |
| FROM cycling.cyclist_teams |
| WHERE teams CONTAINS KEY 2015;</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="tab-pane" aria-labelledby="tabset3_select-result"> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-language-cql hljs" data-lang="language-cql"> id | firstname | lastname | teams |
| --------------------------------------+-----------+------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| cb07baad-eac8-4f65-b28a-bddc06a0de23 | Elizabeth | ARMITSTEAD | {2011: 'Team Garmin - Cervelo', 2012: 'AA Drink - Leontien.nl', 2013: 'Boels:Dolmans Cycling Team', 2014: 'Boels:Dolmans Cycling Team', 2015: 'Boels:Dolmans Cycling Team'} |
| 5b6962dd-3f90-4c93-8f61-eabfa4a803e2 | Marianne | VOS | {2015: 'Rabobank-Liv Woman Cycling Team'} |
| |
| (2 rows)</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="creating-an-index-on-map-entries"><a class="anchor" href="#creating-an-index-on-map-entries"></a>Creating an index on map entries</h3> |
| <div class="paragraph"> |
| <p>You can create an index on map entries. |
| An <code>ENTRIES</code> index can be created only on a map column of a table that doesn’t have an existing index.</p> |
| </div> |
| <div class="paragraph"> |
| <p>To index collection entries, use the <code>ENTRIES</code> keyword and map name in nested parentheses. |
| To query the map entries in the table, use a <code>WHERE</code> clause with the map name and a value. |
| This query finds cyclists who are the same age.</p> |
| </div> |
| <div class="tabset is-loading"> |
| <div class="ulist tabs"> |
| <ul> |
| <li> |
| <p><a id="tabset4_create-table"></a>CREATE TABLE</p> |
| </li> |
| <li> |
| <p><a id="tabset4_create-index"></a>CREATE INDEX</p> |
| </li> |
| <li> |
| <p><a id="tabset4_select-query"></a>SELECT query</p> |
| </li> |
| <li> |
| <p><a id="tabset4_select-result"></a>SELECT result</p> |
| </li> |
| </ul> |
| </div> |
| <div class="content"> |
| <div class="tab-pane" aria-labelledby="tabset4_create-table"> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-language-cql hljs" data-lang="language-cql">CREATE TABLE IF NOT EXISTS cycling.birthday_list ( |
| cyclist_name text PRIMARY KEY, |
| blist map<text, text> |
| );</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="tab-pane" aria-labelledby="tabset4_create-index"> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-language-cql hljs" data-lang="language-cql">CREATE INDEX IF NOT EXISTS blist_idx |
| ON cycling.birthday_list ( ENTRIES(blist) );</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="tab-pane" aria-labelledby="tabset4_select-query"> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-language-cql hljs" data-lang="language-cql">SELECT * |
| FROM cycling.birthday_list |
| WHERE blist[ 'age' ] = '23';</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="tab-pane" aria-labelledby="tabset4_select-result"> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-language-cql hljs" data-lang="language-cql"> cyclist_name | blist |
| ------------------+---------------------------------------------------------- |
| Claudio HEINEN | {'age': '23', 'bday': '27/07/1992', 'nation': 'GERMANY'} |
| Laurence BOURQUE | {'age': '23', 'bday': '27/07/1992', 'nation': 'CANADA'} |
| |
| (2 rows)</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Use the same index to find cyclists from the same country:</p> |
| </div> |
| <div class="tabset is-loading"> |
| <div class="ulist tabs"> |
| <ul> |
| <li> |
| <p><a id="tabset5_create-table"></a>CREATE TABLE</p> |
| </li> |
| <li> |
| <p><a id="tabset5_create-index"></a>CREATE INDEX</p> |
| </li> |
| <li> |
| <p><a id="tabset5_select-query"></a>SELECT query</p> |
| </li> |
| <li> |
| <p><a id="tabset5_select-result"></a>SELECT result</p> |
| </li> |
| </ul> |
| </div> |
| <div class="content"> |
| <div class="tab-pane" aria-labelledby="tabset5_create-table"> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-language-cql hljs" data-lang="language-cql">CREATE TABLE IF NOT EXISTS cycling.birthday_list ( |
| cyclist_name text PRIMARY KEY, |
| blist map<text, text> |
| );</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="tab-pane" aria-labelledby="tabset5_create-index"> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-language-cql hljs" data-lang="language-cql">CREATE INDEX IF NOT EXISTS blist_idx |
| ON cycling.birthday_list ( ENTRIES(blist) );</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="tab-pane" aria-labelledby="tabset5_select-query"> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-language-cql hljs" data-lang="language-cql">SELECT * |
| FROM cycling.birthday_list |
| WHERE blist[ 'nation' ] = 'NETHERLANDS';</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="tab-pane" aria-labelledby="tabset5_select-result"> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-language-cql hljs" data-lang="language-cql"> cyclist_name | blist |
| ---------------+-------------------------------------------------------------- |
| Luc HAGENAARS | {'age': '28', 'bday': '27/07/1987', 'nation': 'NETHERLANDS'} |
| Toine POELS | {'age': '52', 'bday': '27/07/1963', 'nation': 'NETHERLANDS'} |
| |
| (2 rows)</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="creating-an-index-on-map-values"><a class="anchor" href="#creating-an-index-on-map-values"></a>Creating an index on map values</h3> |
| <div class="paragraph"> |
| <p>To create an index on map values, use the <code>VALUES</code> keyword and map name in nested parentheses. |
| To query the table, use a <code>WHERE</code> clause with the map name and the value it contains.</p> |
| </div> |
| <div class="tabset is-loading"> |
| <div class="ulist tabs"> |
| <ul> |
| <li> |
| <p><a id="tabset6_create-table"></a>CREATE TABLE</p> |
| </li> |
| <li> |
| <p><a id="tabset6_create-index"></a>CREATE INDEX</p> |
| </li> |
| <li> |
| <p><a id="tabset6_select-query"></a>SELECT query</p> |
| </li> |
| <li> |
| <p><a id="tabset6_select-result"></a>SELECT result</p> |
| </li> |
| </ul> |
| </div> |
| <div class="content"> |
| <div class="tab-pane" aria-labelledby="tabset6_create-table"> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-language-cql hljs" data-lang="language-cql">CREATE TABLE IF NOT EXISTS cycling.birthday_list ( |
| cyclist_name text PRIMARY KEY, |
| blist map<text, text> |
| );</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="tab-pane" aria-labelledby="tabset6_create-index"> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-language-cql hljs" data-lang="language-cql">CREATE INDEX IF NOT EXISTS blist_values_idx |
| ON cycling.birthday_list ( VALUES(blist) );</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="tab-pane" aria-labelledby="tabset6_select-query"> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-language-cql hljs" data-lang="language-cql">SELECT * |
| FROM cycling.birthday_list |
| WHERE blist CONTAINS 'NETHERLANDS';</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="tab-pane" aria-labelledby="tabset6_select-result"> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-language-cql hljs" data-lang="language-cql"> cyclist_name | blist |
| ---------------+-------------------------------------------------------------- |
| Luc HAGENAARS | {'age': '28', 'bday': '27/07/1987', 'nation': 'NETHERLANDS'} |
| Toine POELS | {'age': '52', 'bday': '27/07/1963', 'nation': 'NETHERLANDS'} |
| |
| (2 rows)</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="creating-an-index-on-the-full-content-of-a-frozen-collection"><a class="anchor" href="#creating-an-index-on-the-full-content-of-a-frozen-collection"></a>Creating an index on the full content of a frozen collection</h3> |
| <div class="paragraph"> |
| <p>You can create an index on a full <code>FROZEN</code> collection. |
| A <code>FULL</code> index can be created on a set, list, or map column of a table that doesn’t have an existing index.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Create an index on the full content of a <code>FROZEN</code> <code>list</code>. |
| The table in this example stores the number of Pro wins, Grand Tour races, and Classic races that a cyclist has competed in. |
| To index collection entries, use the <code>FULL</code> keyword and collection name in nested parentheses. |
| For example, index the frozen list <code>rnumbers</code>. |
| To query the table, use a <code>WHERE</code> clause with the collection name and values.</p> |
| </div> |
| <div class="tabset is-loading"> |
| <div class="ulist tabs"> |
| <ul> |
| <li> |
| <p><a id="tabset7_create-table"></a>CREATE TABLE</p> |
| </li> |
| <li> |
| <p><a id="tabset7_create-index"></a>CREATE INDEX</p> |
| </li> |
| <li> |
| <p><a id="tabset7_select-query"></a>SELECT query</p> |
| </li> |
| <li> |
| <p><a id="tabset7_select-result"></a>SELECT result</p> |
| </li> |
| </ul> |
| </div> |
| <div class="content"> |
| <div class="tab-pane" aria-labelledby="tabset7_create-table"> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-language-cql hljs" data-lang="language-cql">CREATE TABLE IF NOT EXISTS cycling.race_starts ( |
| cyclist_name text PRIMARY KEY, |
| rnumbers FROZEN<LIST<int>> |
| );</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="tab-pane" aria-labelledby="tabset7_create-index"> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-language-cql hljs" data-lang="language-cql">CREATE INDEX IF NOT EXISTS rnumbers_idx |
| ON cycling.race_starts ( FULL(rnumbers) );</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="tab-pane" aria-labelledby="tabset7_select-query"> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-language-cql hljs" data-lang="language-cql">SELECT * |
| FROM cycling.race_starts |
| WHERE rnumbers = [39, 7, 14];</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="tab-pane" aria-labelledby="tabset7_select-result"> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-language-cql hljs" data-lang="language-cql"> cyclist_name | rnumbers |
| ----------------+------------- |
| John DEGENKOLB | [39, 7, 14] |
| |
| (1 rows)</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </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/trunk/cassandra/reference/cql-commands/create-index.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> |
