mirror of
https://github.com/scylladb/scylladb.git
synced 2026-04-26 19:35:12 +00:00
1144 lines
86 KiB
HTML
1144 lines
86 KiB
HTML
|
||
|
||
<!DOCTYPE html>
|
||
<html class="no-js" lang="en" style="visibility: hidden;">
|
||
|
||
|
||
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width initial-scale=1" />
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||
<title>
|
||
Definitions | ScyllaDB Docs
|
||
</title>
|
||
<meta name="description" content="ScyllaDB is an Apache Cassandra-compatible NoSQL data store that can handle 1 million transactions per second on a single server." />
|
||
<link rel="icon" href="../_static/img/favicon.ico" type="image/x-icon" />
|
||
<link rel="icon" href="../_static/img/favicon-32x32.png" sizes="32x32" />
|
||
<link rel="icon" href="../_static/img/favicon-228x228.png" sizes="192x192" />
|
||
<link rel="apple-touch-icon" href="../_static/img/favicon-228x228.png" />
|
||
<meta name="msapplication-TileImage" href="../_static/img/favicon-228x228.png" />
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<link rel="canonical" href="https://opensource.docs.scylladb.com/stable/cql/definitions.html"/>
|
||
|
||
|
||
<link rel="author" href="mailto:info@scylladb.com" />
|
||
|
||
|
||
|
||
|
||
|
||
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
|
||
<link rel="preload" as="style"
|
||
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,400;0,500;0,700;1,400&display=swap" />
|
||
|
||
<!-- async CSS -->
|
||
<link rel="stylesheet" media="print" onload="this.onload=null;this.removeAttribute('media');"
|
||
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,400;0,500;0,700;1,400&display=swap" />
|
||
|
||
<!-- no-JS fallback -->
|
||
<noscript>
|
||
<link rel="stylesheet"
|
||
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,400;0,500;0,700;1,400&display=swap" />
|
||
</noscript>
|
||
|
||
|
||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/biel-search@latest/dist/biel-search/biel-search.css">
|
||
<script type="module" src="https://cdn.jsdelivr.net/npm/biel-search@latest/dist/biel-search/biel-search.esm.js"></script>
|
||
|
||
|
||
|
||
|
||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=03e43079" />
|
||
|
||
|
||
|
||
<link rel="stylesheet" type="text/css" href="../_static/css/main.css?v=041c0933" />
|
||
|
||
|
||
|
||
<link rel="stylesheet" type="text/css" href="../_static/sphinx_collapse.css?v=226d88b4" />
|
||
|
||
|
||
|
||
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
|
||
|
||
|
||
|
||
<link rel="stylesheet" type="text/css" href="../_static/css/custom.css?v=5a6d8084" />
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<meta name="robots" content="noindex">
|
||
|
||
|
||
|
||
<script type="text/javascript" src="../_static/js/runtime.bundle.js"></script>
|
||
<script type="text/javascript" src="../_static/js/main.bundle.js"></script>
|
||
|
||
|
||
<script src="../_static/documentation_options.js?v=5929fcd5"></script>
|
||
|
||
|
||
|
||
<script src="../_static/doctools.js?v=fd6eb6e6"></script>
|
||
|
||
|
||
|
||
<script src="../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||
|
||
|
||
|
||
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>
|
||
|
||
|
||
|
||
<script src="../_static/copybutton.js?v=f281be69"></script>
|
||
|
||
|
||
|
||
|
||
<!-- Local meta tags -->
|
||
|
||
|
||
<!-- Google Tag Manager docs -->
|
||
<script>
|
||
(function (w, d, s, l, i) {
|
||
w[l] = w[l] || [];
|
||
w[l].push({
|
||
"gtm.start": new Date().getTime(),
|
||
event: "gtm.js"
|
||
});
|
||
var f = d.getElementsByTagName(s)[0],
|
||
j = d.createElement(s),
|
||
dl = l != "dataLayer" ? "&l=" + l : "";
|
||
j.async = true;
|
||
j.src = "https://www.googletagmanager.com/gtm.js?id=" + i + dl;
|
||
f.parentNode.insertBefore(j, f);
|
||
})(window, document, "script", "dataLayer", "GTM-54NWVS4");
|
||
</script>
|
||
<!-- End Google Tag Manager -->
|
||
|
||
<!-- Google Tag Manager global -->
|
||
<script>
|
||
(function (w, d, s, l, i) {
|
||
w[l] = w[l] || [];
|
||
w[l].push({
|
||
"gtm.start": new Date().getTime(),
|
||
event: "gtm.js"
|
||
});
|
||
var f = d.getElementsByTagName(s)[0],
|
||
j = d.createElement(s),
|
||
dl = l != "dataLayer" ? "&l=" + l : "";
|
||
j.async = true;
|
||
j.src = "https://www.googletagmanager.com/gtm.js?id=" + i + dl;
|
||
f.parentNode.insertBefore(j, f);
|
||
})(window, document, "script", "dataLayer", "GTM-T8P2JP");
|
||
</script>
|
||
<!-- End Google Tag Manager -->
|
||
|
||
<!-- Expertrec -->
|
||
|
||
<!-- End Expertrec -->
|
||
|
||
|
||
|
||
</head>
|
||
|
||
<body class="brand-open-source">
|
||
<section class="promo-banner promo-banner--hide" style="display: none;">
|
||
<div class="promo-banner-wrapper">
|
||
<div class="promo-banner__content">
|
||
|
||
<div class="promo-banner__title">ScyllaDB University LIVE, FREE Virtual Training Event | March 21</div>
|
||
<a class="promo-banner__button button button--reverse" href="https://lp.scylladb.com/university-live-2023-03-registration?siteplacement=docs"
|
||
target="_blank" rel="noopener noreferrer">Register for Free</a>
|
||
</div>
|
||
<button class="promo-banner__close">
|
||
<i class="icon-cancel"></i>
|
||
</button>
|
||
</div>
|
||
</section>
|
||
<header class="header">
|
||
<div class="header-logo">
|
||
<a class="header-logo__img" href="https://scylladb.com/">
|
||
<img src="../_static/img/scylladb-logo-horizontal.svg" alt="ScyllaDB Documentation Logo" />
|
||
</a>
|
||
<span class="header-logo__bar"></span>
|
||
<a class="header-logo__text" href="https://docs.scylladb.com/">
|
||
Documentation
|
||
</a>
|
||
</div>
|
||
<div class="header-navigation">
|
||
<ul class="dropdown menu scylla-dropdown scylla-dropdown--header" data-dropdown-menu>
|
||
<li class="scylla-dropdown__item">
|
||
<a href="#" class="scylla-dropdown__title">Deployments <i class="chevron icon-arrow-dropdown"></i></a>
|
||
<ul class="menu scylla-dropdown__content">
|
||
<li>
|
||
<a href="https://docs.scylladb.com/scylla-cloud/">
|
||
<i class="icon-docs-cloud"></i>Cloud</a>
|
||
</li>
|
||
<li>
|
||
<a href="https://docs.scylladb.com/manual/">
|
||
<i class="icon-server"></i>Server</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="scylla-dropdown__item">
|
||
<a href="#" class="scylla-dropdown__title">Tools <i class="chevron icon-arrow-dropdown"></i></a>
|
||
<ul class="menu scylla-dropdown__content">
|
||
<li>
|
||
<a href="https://manager.docs.scylladb.com/">
|
||
<i class="icon-docs-manager"></i>ScyllaDB Manager</a>
|
||
</li>
|
||
<li>
|
||
<a href="https://monitoring.docs.scylladb.com/">
|
||
<i class="icon-docs-monitoring"></i>ScyllaDB
|
||
Monitoring Stack</a>
|
||
</li>
|
||
<li>
|
||
<a href="https://operator.docs.scylladb.com/">
|
||
<i class="icon-docs-operator"></i>ScyllaDB Operator
|
||
</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="scylla-dropdown__item">
|
||
<a href="#" class="scylla-dropdown__title">Drivers <i class="chevron icon-arrow-dropdown"></i></a>
|
||
<ul class="menu scylla-dropdown__content">
|
||
<li>
|
||
<a href="https://docs.scylladb.com/stable/drivers/cql-drivers">
|
||
<i class="icon-docs-nsql-guides"></i>CQL Drivers
|
||
</a>
|
||
</li>
|
||
<li>
|
||
<a href="https://docs.scylladb.com/stable/drivers/dynamo-drivers">
|
||
<i class="icon-docs-alternator"></i>DynamoDB Drivers
|
||
</a>
|
||
|
||
<li>
|
||
<a href="https://docs.scylladb.com/stable/versioning/driver-support">
|
||
<i class="icon-docs-blog"></i>Supported Driver Versions
|
||
</a>
|
||
</li>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="scylla-dropdown__item">
|
||
<a href="#" class="scylla-dropdown__title">Resources
|
||
<i class="chevron icon-arrow-dropdown"></i></a>
|
||
<ul class="menu scylla-dropdown__content">
|
||
<li>
|
||
<a href="https://university.scylladb.com">
|
||
<i class="icon-university"></i>
|
||
ScyllaDB University
|
||
</a>
|
||
</li>
|
||
<li>
|
||
<a href="https://forum.scylladb.com">
|
||
<i class="icon-docs-community"></i>
|
||
Community Forum
|
||
</a>
|
||
</li>
|
||
<li>
|
||
<a href="https://docs.scylladb.com/stable/get-started/develop-with-scylladb/tutorials-example-projects.html">
|
||
<i class="icon-docs-training"></i>
|
||
Tutorials
|
||
</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<div class="header-button">
|
||
<a href="https://docs.scylladb.com/manual/stable/getting-started/install-scylla/index.html" class="button"><i class="icon-download me-2"></i> Install</a>
|
||
</div>
|
||
</div>
|
||
<div class="header-search-box">
|
||
<i class="dark-theme-toggler icon-theme"></i>
|
||
|
||
<biel-search-button
|
||
project="ddfdo8m94k"
|
||
button-style="rounded"
|
||
hide-filters="false"
|
||
header-title="ScyllaDB chatbot (beta)"
|
||
modal-position="top-center">
|
||
Search
|
||
</biel-search-button>
|
||
|
||
<biel-button class="header-ask-ai" project="ddfdo8m94k"
|
||
header-title="ScyllaDB chatbot (beta)"
|
||
button-position="default"
|
||
modal-position="sidebar-right"
|
||
button-style="dark">
|
||
Ask AI
|
||
</biel-button>
|
||
|
||
|
||
</div>
|
||
<div class="side-nav-toggle">
|
||
<i class="dark-theme-toggler icon-theme"></i>
|
||
<div class="side-nav-toggle__button" data-toggle="side-nav">
|
||
<i class="icon-menu"></i>
|
||
</div>
|
||
</div>
|
||
</header>
|
||
<div class="title"></div>
|
||
<section
|
||
class="layout layout--sidebar layout--has-secondary-sidebar ">
|
||
<div class="content large-order-2">
|
||
|
||
<div class="pre-content">
|
||
<div class="breadcrumbs">
|
||
<span class="bread__item">
|
||
<a href="https://docs.scylladb.com"
|
||
class="bread__highlight">
|
||
<i class="icon-home"></i> ScyllaDB Docs
|
||
</a>
|
||
</span>
|
||
<span class="bread__item">
|
||
<a href="../index.html"
|
||
class="bread__highlight">
|
||
ScyllaDB Open Source
|
||
</a>
|
||
</span>
|
||
|
||
<span class="bread__item">
|
||
<a href="index.html" class="bread__highlight">
|
||
CQL Reference
|
||
</a>
|
||
</span>
|
||
|
||
<span class="bread__item bread__item--last">Definitions</span>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<div class="sidebar-right-layout">
|
||
<div class="body-container">
|
||
|
||
|
||
<div class="content-body"
|
||
|
||
data-view-source-url="https://github.com/scylladb/scylladb/blob/master/docs/cql/definitions.rst"
|
||
>
|
||
|
||
|
||
<div class="admonition caution">
|
||
<p class="admonition-title">Caution</p>
|
||
<p>
|
||
You're viewing documentation for a previous version.
|
||
<a href="https://docs.scylladb.com/manual/">Switch to the latest stable version.</a>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
|
||
<section id="definitions">
|
||
<h1>Definitions<a class="headerlink" href="#definitions" title="Link to this heading">¶</a></h1>
|
||
<section id="conventions">
|
||
<span id="id1"></span><h2>Conventions<a class="headerlink" href="#conventions" title="Link to this heading">¶</a></h2>
|
||
<p>To aid in specifying the CQL syntax, we will use the following conventions in this document:</p>
|
||
<ul class="simple">
|
||
<li><p>Language rules will be given in an informal <a class="reference external" href="http://en.wikipedia.org/wiki/Backus%E2%80%93Naur_Form#Variants">BNF variant</a> notation. In particular, we’ll use square brackets
|
||
(<code class="docutils literal notranslate"><span class="pre">[</span> <span class="pre">item</span> <span class="pre">]</span></code>) for optional items, <code class="docutils literal notranslate"><span class="pre">*</span></code> and <code class="docutils literal notranslate"><span class="pre">+</span></code> for repeated items (where <code class="docutils literal notranslate"><span class="pre">+</span></code> imply at least one).</p></li>
|
||
<li><p>The grammar will also use the following convention for convenience: non-terminal term will be lowercase (and link to
|
||
their definition) while terminal keywords will be provided “all caps”. Note, however, that keywords are
|
||
<a class="reference internal" href="#identifiers"><span class="std std-ref">Identifiers and keywords</span></a> and are thus case insensitive in practice. We will also define some early construction using
|
||
regexp, which we’ll indicate with <code class="docutils literal notranslate"><span class="pre">re(<some</span> <span class="pre">regular</span> <span class="pre">expression>)</span></code>.</p></li>
|
||
<li><p>The grammar is provided for documentation purposes and leaves some minor details out. For instance, the comma on the
|
||
last column definition in a <code class="docutils literal notranslate"><span class="pre">CREATE</span> <span class="pre">TABLE</span></code> statement is optional but supported if present even though the grammar in
|
||
this document suggests otherwise. Also, not everything accepted by the grammar is necessarily valid CQL.</p></li>
|
||
<li><p>References to keywords or pieces of CQL code in running text will be shown in a <code class="docutils literal notranslate"><span class="pre">fixed-width</span> <span class="pre">font</span></code>.</p></li>
|
||
</ul>
|
||
</section>
|
||
<section id="identifiers">
|
||
<span id="identifiers-and-keywords"></span><h2>Identifiers and keywords<a class="headerlink" href="#identifiers" title="Link to this heading">¶</a></h2>
|
||
<p>The CQL language uses <em>identifiers</em> (or <em>names</em>) to identify tables, columns, and other objects. An identifier is a token
|
||
matching the regular expression <code class="docutils literal notranslate"><span class="pre">[a-zA-Z][a-zA-Z0-9_]*</span></code>.</p>
|
||
<p>A number of such identifiers, like <code class="docutils literal notranslate"><span class="pre">SELECT</span></code> or <code class="docutils literal notranslate"><span class="pre">WITH</span></code>, are <em>keywords</em>. They have a fixed meaning for the language,
|
||
and most are reserved. The list of those keywords can be found in <a class="reference internal" href="appendices.html#appendix-a"><span class="std std-ref">Appendix A: CQL Keywords</span></a>.</p>
|
||
<p>Identifiers and (unquoted) keywords are case insensitive. Thus <code class="docutils literal notranslate"><span class="pre">SELECT</span></code> is the same as <code class="docutils literal notranslate"><span class="pre">select</span></code> or <code class="docutils literal notranslate"><span class="pre">sElEcT</span></code>, and
|
||
<code class="docutils literal notranslate"><span class="pre">myId</span></code> is the same than <code class="docutils literal notranslate"><span class="pre">myid</span></code> or <code class="docutils literal notranslate"><span class="pre">MYID</span></code>. A convention often used (in particular by the samples of this
|
||
documentation) is to use upper case for keywords and lower case for other identifiers.</p>
|
||
<p>There is a second kind of identifier called <em>quoted identifiers</em>, defined by enclosing an arbitrary sequence of
|
||
characters (non-empty) in double-quotes(<code class="docutils literal notranslate"><span class="pre">"</span></code>). Quoted identifiers are never keywords. Thus <code class="docutils literal notranslate"><span class="pre">"select"</span></code> is not a
|
||
reserved keyword and can be used to refer to a column (note that using this is particularly advised), while <code class="docutils literal notranslate"><span class="pre">select</span></code>
|
||
would raise a parsing error. Also, contrary to unquoted identifiers and keywords, quoted identifiers are case
|
||
sensitive (<code class="docutils literal notranslate"><span class="pre">"My</span> <span class="pre">Quoted</span> <span class="pre">Id"</span></code> is <em>different</em> from <code class="docutils literal notranslate"><span class="pre">"my</span> <span class="pre">quoted</span> <span class="pre">id"</span></code>). A fully lowercase quoted identifier that matches
|
||
<code class="docutils literal notranslate"><span class="pre">[a-zA-Z][a-zA-Z0-9_]*</span></code> is, however, <em>equivalent</em> to the unquoted identifier obtained by removing the double-quote (so
|
||
<code class="docutils literal notranslate"><span class="pre">"myid"</span></code> is equivalent to <code class="docutils literal notranslate"><span class="pre">myid</span></code> and to <code class="docutils literal notranslate"><span class="pre">myId</span></code> but different from <code class="docutils literal notranslate"><span class="pre">"myId"</span></code>). Inside a quoted identifier, the
|
||
double-quote character can be repeated to escape it, so <code class="docutils literal notranslate"><span class="pre">"foo</span> <span class="pre">""</span> <span class="pre">bar"</span></code> is a valid identifier.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p><em>quoted identifiers</em> allow to declare columns with arbitrary names, and those can sometimes clash with
|
||
specific names used by the server. For instance, when using a conditional update, the server will respond with a
|
||
result-set containing a special result named <code class="docutils literal notranslate"><span class="pre">"[applied]"</span></code>. If you’ve declared a column with such a name, this
|
||
could potentially confuse some tools and should be avoided. In general, unquoted identifiers should be preferred, but
|
||
if you use quoted identifiers, it is strongly advised to avoid any name enclosed by squared brackets (like
|
||
<code class="docutils literal notranslate"><span class="pre">"[applied]"</span></code>) and any name that looks like a function call (like <code class="docutils literal notranslate"><span class="pre">"f(x)"</span></code>).</p>
|
||
</div>
|
||
<p>More formally, we have:</p>
|
||
<div class="highlight-cql notranslate"><div class="highlight"><pre><span></span><span class="n">identifier</span><span class="p">:</span> <span class="o">`</span><span class="n">unquoted_identifier</span><span class="o">`</span> <span class="o">|</span> <span class="o">`</span><span class="n">quoted_identifier</span><span class="o">`</span>
|
||
<span class="n">unquoted_identifier</span><span class="p">:</span> <span class="n">re</span><span class="p">(</span><span class="s1">'[a-zA-Z][a-zA-Z0-9_]*'</span><span class="p">)</span>
|
||
<span class="n">quoted_identifier</span><span class="p">:</span> <span class="s1">'"'</span> <span class="p">(</span><span class="n">any</span> <span class="n">character</span> <span class="k">where</span> <span class="s s-Name">" can appear if doubled)+ '"</span><span class="s1">'</span>
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="constants">
|
||
<span id="id2"></span><h2>Constants<a class="headerlink" href="#constants" title="Link to this heading">¶</a></h2>
|
||
<p>CQL defines the following kind of <em>constants</em>:</p>
|
||
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>constant: `string` | `integer` | `float` | `boolean` | `uuid` | `blob` | NULL
|
||
|
||
string: '\'' (any character where ' can appear if doubled)+ '\''
|
||
: '$$' (any character other than '$$') '$$'
|
||
|
||
integer: re('-?[0-9]+')
|
||
|
||
float: re('-?[0-9]+(\.[0-9]*)?([eE][+-]?[0-9+])?') | NAN | INFINITY
|
||
|
||
boolean: TRUE | FALSE
|
||
|
||
uuid: `hex`{8}-`hex`{4}-`hex`{4}-`hex`{4}-`hex`{12}
|
||
|
||
hex: re("[0-9a-fA-F]")
|
||
|
||
blob: '0' ('x' | 'X') `hex`+
|
||
</pre></div>
|
||
</div>
|
||
<p>In other words:</p>
|
||
<ul class="simple">
|
||
<li><p>A string constant is an arbitrary sequence of characters enclosed by single-quote(<code class="docutils literal notranslate"><span class="pre">'</span></code>). A single-quote
|
||
can be included by repeating it, e.g. <code class="docutils literal notranslate"><span class="pre">'It''s</span> <span class="pre">raining</span> <span class="pre">today'</span></code>. Those are not to be confused with quoted
|
||
<a class="reference internal" href="#identifiers"><span class="std std-ref">Identifiers and keywords</span></a> that use double-quotes. Alternatively, a string can be defined by enclosing the arbitrary sequence
|
||
of characters by two dollar characters, in which case single-quote can be used without escaping (<code class="docutils literal notranslate"><span class="pre">$$It's</span> <span class="pre">raining</span>
|
||
<span class="pre">today$$</span></code>). That latter form is often used when defining user-defined functions to avoid having to
|
||
escape single-quote characters in function body (as they are more likely to occur than <code class="docutils literal notranslate"><span class="pre">$$</span></code>).</p></li>
|
||
<li><p>Integer, float, and boolean constant are defined as expected. Note, however, than float allows the special <code class="docutils literal notranslate"><span class="pre">NaN</span></code> and
|
||
<code class="docutils literal notranslate"><span class="pre">Infinity</span></code> constants.</p></li>
|
||
<li><p>CQL supports <a class="reference external" href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> constants.</p></li>
|
||
<li><p>Blob content types are provided in hexadecimal and prefixed by <code class="docutils literal notranslate"><span class="pre">0x</span></code>.</p></li>
|
||
<li><p>The special <code class="docutils literal notranslate"><span class="pre">NULL</span></code> constant denotes the absence of value.</p></li>
|
||
</ul>
|
||
<p>For how these constants are typed, see the <a class="reference internal" href="types.html"><span class="doc">data-types</span></a> document.</p>
|
||
</section>
|
||
<section id="terms">
|
||
<h2>Terms<a class="headerlink" href="#terms" title="Link to this heading">¶</a></h2>
|
||
<p>CQL has the notion of a <em>term</em>, which denotes the kind of values that CQL support. Terms are defined by:</p>
|
||
<div class="highlight-cql notranslate"><div class="highlight"><pre><span></span><span class="n">term</span><span class="p">:</span> <span class="o">`</span><span class="n">constant</span><span class="o">`</span> <span class="o">|</span> <span class="o">`</span><span class="n">literal</span><span class="o">`</span> <span class="o">|</span> <span class="o">`</span><span class="n">function_call</span><span class="o">`</span> <span class="o">|</span> <span class="o">`</span><span class="n">arithmetic_operation</span><span class="o">`</span> <span class="o">|</span> <span class="o">`</span><span class="n">type_hint</span><span class="o">`</span> <span class="o">|</span> <span class="o">`</span><span class="n">bind_marker</span><span class="o">`</span>
|
||
|
||
<span class="n">literal</span><span class="p">:</span> <span class="o">`</span><span class="n">collection_literal</span><span class="o">`</span> <span class="o">|</span> <span class="o">`</span><span class="n">udt_literal</span><span class="o">`</span> <span class="o">|</span> <span class="o">`</span><span class="n">tuple_literal</span><span class="o">`</span>
|
||
|
||
<span class="n">function_call</span><span class="p">:</span> <span class="o">`</span><span class="n">identifier</span><span class="o">`</span> <span class="s1">'('</span> <span class="p">[</span> <span class="o">`</span><span class="n">term</span><span class="o">`</span> <span class="p">(</span><span class="s1">','</span> <span class="o">`</span><span class="n">term</span><span class="o">`</span><span class="p">)</span><span class="o">*</span> <span class="p">]</span> <span class="s1">')'</span>
|
||
|
||
<span class="n">arithmetic_operation</span><span class="p">:</span> <span class="s1">'-'</span> <span class="o">`</span><span class="n">term</span><span class="o">`</span> <span class="o">|</span> <span class="o">`</span><span class="n">term</span><span class="o">`</span> <span class="p">(</span><span class="s1">'+'</span> <span class="o">|</span> <span class="s1">'-'</span> <span class="o">|</span> <span class="s1">'*'</span> <span class="o">|</span> <span class="s1">'/'</span> <span class="o">|</span> <span class="s1">'%'</span><span class="p">)</span> <span class="o">`</span><span class="n">term</span><span class="o">`</span>
|
||
|
||
<span class="n">type_hint</span><span class="p">:</span> <span class="s1">'('</span> <span class="o">`</span><span class="n">cql_type</span><span class="o">`</span> <span class="o">`</span><span class="p">)</span><span class="o">`</span> <span class="n">term</span>
|
||
|
||
<span class="n">bind_marker</span><span class="p">:</span> <span class="s1">'?'</span> <span class="o">|</span> <span class="s1">':'</span> <span class="o">`</span><span class="n">identifier</span><span class="o">`</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>A term is thus one of:</p>
|
||
<ul class="simple">
|
||
<li><p>A <a class="reference internal" href="#constants"><span class="std std-ref">constant</span></a>.</p></li>
|
||
<li><p>A literal for either <a class="reference internal" href="types.html#collections"><span class="std std-ref">a collection</span></a>, a user-defined type or a tuple
|
||
(see the linked sections for details).</p></li>
|
||
<li><p>An arithmetic operation between terms.</p></li>
|
||
<li><p>A <em>type hint</em></p></li>
|
||
<li><p>A bind marker, which denotes a variable to be bound at execution time. See the section on <a class="reference internal" href="#prepared-statements"><span class="std std-ref">Prepared Statements</span></a>
|
||
for details. A bind marker can be either anonymous (<code class="docutils literal notranslate"><span class="pre">?</span></code>) or named (<code class="docutils literal notranslate"><span class="pre">:some_name</span></code>). The latter form provides a more
|
||
convenient way to refer to the variable for binding it and should generally be preferred.</p></li>
|
||
</ul>
|
||
</section>
|
||
<section id="comments">
|
||
<h2>Comments<a class="headerlink" href="#comments" title="Link to this heading">¶</a></h2>
|
||
<p>A comment in CQL is a line beginning by either double dashes (<code class="docutils literal notranslate"><span class="pre">--</span></code>) or double slash (<code class="docutils literal notranslate"><span class="pre">//</span></code>).</p>
|
||
<p>Multi-line comments are also supported through enclosure within <code class="docutils literal notranslate"><span class="pre">/*</span></code> and <code class="docutils literal notranslate"><span class="pre">*/</span></code> (but nesting is not supported).</p>
|
||
<div class="highlight-cql notranslate"><div class="highlight"><pre><span></span><span class="c1">-- This is a comment</span>
|
||
<span class="c1">// This is a comment too</span>
|
||
<span class="cm">/* This is</span>
|
||
<span class="cm"> a multi-line comment */</span>
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="statements">
|
||
<h2>Statements<a class="headerlink" href="#statements" title="Link to this heading">¶</a></h2>
|
||
<p>CQL consists of statements that can be divided into the following categories:</p>
|
||
<ul class="simple">
|
||
<li><p><a class="reference internal" href="ddl.html"><span class="doc">Data Definition</span></a> statements - to define and change how the data is stored (keyspaces and tables).</p></li>
|
||
<li><p><a class="reference internal" href="dml.html"><span class="doc">Data Manipulation</span></a> statements - for selecting, inserting and deleting data.</p></li>
|
||
<li><p><a class="reference internal" href="../operating-scylla/security/authorization.html#cql-permissions"><span class="std std-ref">Permissions</span></a> statements.</p></li>
|
||
<li><p>cql-triggers statements.</p></li>
|
||
</ul>
|
||
<p>All the statements are listed below and are described in the rest of this documentation (see links above):</p>
|
||
<div class="highlight-cql notranslate"><div class="highlight"><pre><span></span><span class="n">cql_statement</span><span class="p">:</span> <span class="o">`</span><span class="n">statement</span><span class="o">`</span> <span class="p">[</span> <span class="s1">';'</span> <span class="p">]</span>
|
||
<span class="n">statement</span><span class="p">:</span> <span class="o">`</span><span class="n">ddl_statement</span><span class="o">`</span>
|
||
<span class="p">:</span> <span class="o">|</span> <span class="o">`</span><span class="n">dml_statement</span><span class="o">`</span>
|
||
<span class="p">:</span> <span class="o">|</span> <span class="o">`</span><span class="n">secondary_index_statement</span><span class="o">`</span>
|
||
<span class="p">:</span> <span class="o">|</span> <span class="o">`</span><span class="n">materialized_view_statement</span><span class="o">`</span>
|
||
<span class="p">:</span> <span class="o">|</span> <span class="o">`</span><span class="n">role_or_permission_statement</span><span class="o">`</span>
|
||
<span class="p">:</span> <span class="o">|</span> <span class="o">`</span><span class="n">udf_statement</span><span class="o">`</span>
|
||
<span class="p">:</span> <span class="o">|</span> <span class="o">`</span><span class="n">udt_statement</span><span class="o">`</span>
|
||
<span class="p">:</span> <span class="o">|</span> <span class="o">`</span><span class="n">trigger_statement</span><span class="o">`</span>
|
||
<span class="n">ddl_statement</span><span class="p">:</span> <span class="o">`</span><span class="n">use_statement</span><span class="o">`</span>
|
||
<span class="p">:</span> <span class="o">|</span> <span class="o">`</span><span class="n">create_keyspace_statement</span><span class="o">`</span>
|
||
<span class="p">:</span> <span class="o">|</span> <span class="o">`</span><span class="n">alter_keyspace_statement</span><span class="o">`</span>
|
||
<span class="p">:</span> <span class="o">|</span> <span class="o">`</span><span class="n">drop_keyspace_statement</span><span class="o">`</span>
|
||
<span class="p">:</span> <span class="o">|</span> <span class="o">`</span><span class="n">create_table_statement</span><span class="o">`</span>
|
||
<span class="p">:</span> <span class="o">|</span> <span class="o">`</span><span class="n">alter_table_statement</span><span class="o">`</span>
|
||
<span class="p">:</span> <span class="o">|</span> <span class="o">`</span><span class="n">drop_table_statement</span><span class="o">`</span>
|
||
<span class="p">:</span> <span class="o">|</span> <span class="o">`</span><span class="n">truncate_statement</span><span class="o">`</span>
|
||
<span class="n">dml_statement</span><span class="p">:</span> <span class="o">`</span><span class="n">select_statement</span><span class="o">`</span>
|
||
<span class="p">:</span> <span class="o">|</span> <span class="o">`</span><span class="n">insert_statement</span><span class="o">`</span>
|
||
<span class="p">:</span> <span class="o">|</span> <span class="o">`</span><span class="n">update_statement</span><span class="o">`</span>
|
||
<span class="p">:</span> <span class="o">|</span> <span class="o">`</span><span class="n">delete_statement</span><span class="o">`</span>
|
||
<span class="p">:</span> <span class="o">|</span> <span class="o">`</span><span class="n">batch_statement</span><span class="o">`</span>
|
||
<span class="n">trigger_statement</span><span class="p">:</span> <span class="o">`</span><span class="n">create_trigger_statement</span><span class="o">`</span>
|
||
<span class="p">:</span> <span class="o">|</span> <span class="o">`</span><span class="n">drop_trigger_statement</span><span class="o">`</span>
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="prepared-statements">
|
||
<span id="id3"></span><h2>Prepared Statements<a class="headerlink" href="#prepared-statements" title="Link to this heading">¶</a></h2>
|
||
<p>CQL supports <em>prepared statements</em>. Prepared statements are an optimization that allows parsing a query only once but
|
||
executes it multiple times with different concrete values.</p>
|
||
<p>Any statement that uses at least one bind marker (see <code class="xref std std-token docutils literal notranslate"><span class="pre">bind_marker</span></code>) will need to be <em>prepared</em>. After which, the statement
|
||
can be <em>executed</em> by provided concrete values for each of its markers. The exact details of how a statement is prepared
|
||
and then executed depends on the CQL driver used, and you should refer to your driver documentation.</p>
|
||
<p>© 2016, The Apache Software Foundation.</p>
|
||
<p><a class="reference internal" href="index.html"><span class="doc">Apache Cassandra Query Language</span></a></p>
|
||
</section>
|
||
</section>
|
||
|
||
</div>
|
||
|
||
<div class="post-content">
|
||
|
||
<div class="feedback-container">
|
||
<p class="feedback-container__title">Was this page helpful?</p>
|
||
<span data-tooltip tabindex="1" title="Yes" data-position="top">
|
||
<button class="feedback-container__button" id="feedback-positive">
|
||
<i class="feedback-container__icon icon-docs-thumbs-up"></i>
|
||
</button>
|
||
</span>
|
||
<span data-tooltip tabindex="1" title="No" data-position="top">
|
||
<button class="feedback-container__button" id="feedback-negative">
|
||
<i class="feedback-container__icon icon-docs-thumbs-down"></i>
|
||
</button>
|
||
</span>
|
||
<div class="feedback-container__message" id="feedback-message"></div>
|
||
</div>
|
||
|
||
<script>
|
||
function resetFeedbackButtonActive() {
|
||
const feedbackButtons = document.getElementsByClassName('feedback-container__button');
|
||
for (let i = 0; i < feedbackButtons.length; i++) {
|
||
feedbackButtons[i].classList.remove('active');
|
||
}
|
||
}
|
||
|
||
function showMessage(liked) {
|
||
const feedbackMessage = document.getElementById('feedback-message');
|
||
const themeGithubRepository = true;
|
||
let message = 'Great! Thanks for your feedback.';
|
||
if (themeGithubRepository && !liked) {
|
||
message = "Thanks for your feedback! Please don't hesitate to <a href='https://github.com/scylladb/scylladb/issues/new?title=docs:%20Issue on page Definitions&&body=I%20would%20like%20to%20report%20an%20issue%20on%20page%20https://opensource.docs.scylladb.com/branch-6.2/cql/definitions%0A%0A%23%23%23%20Problem%0A%0A%23%23%23%20%20Suggest%20a%20fix&labels=documentation'>create an issue</a> if you have any suggestions on how we can improve.";
|
||
}
|
||
feedbackMessage.innerHTML = message;
|
||
}
|
||
|
||
function sendGaEvent(liked) {
|
||
const event_label = liked ? "positive" : "negative";
|
||
const event = "feedback_" + event_label;
|
||
window.dataLayer = window.dataLayer || [];
|
||
window.dataLayer.push({
|
||
'event': event,
|
||
});
|
||
}
|
||
|
||
const positiveFeebackButton = document.getElementById('feedback-positive');
|
||
const negativeFeedbackButton = document.getElementById('feedback-negative');
|
||
|
||
positiveFeebackButton.addEventListener('click', function() {
|
||
resetFeedbackButtonActive();
|
||
sendGaEvent(true);
|
||
showMessage(true);
|
||
positiveFeebackButton.classList.add('active');
|
||
});
|
||
|
||
negativeFeedbackButton.addEventListener('click', function() {
|
||
resetFeedbackButtonActive();
|
||
sendGaEvent(false);
|
||
showMessage(false);
|
||
negativeFeedbackButton.classList.add('active');
|
||
});
|
||
</script>
|
||
|
||
<div class="content-navigation">
|
||
<div class="navigation navigation--prev">
|
||
|
||
<a class="navigation__link" href="types.html">
|
||
<button class="navigation__button">
|
||
<i class="icon-chevron-left"></i>
|
||
</button>
|
||
<div class="navigation__title">
|
||
<span class="colored">PREVIOUS</span> <br />Data Types
|
||
</div>
|
||
</a>
|
||
|
||
</div>
|
||
<div class="navigation navigation--next">
|
||
|
||
<a class="navigation__link" href="secondary-indexes.html">
|
||
<div class="navigation__title">
|
||
<span class="colored">NEXT</span> <br />Global Secondary Indexes
|
||
</div>
|
||
<button class="navigation__button">
|
||
<i class="icon-chevron-right"></i>
|
||
</button>
|
||
</a>
|
||
|
||
</div>
|
||
</div>
|
||
<!-- Post content text -->
|
||
</div>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="sidebar-right large-order-3">
|
||
<div class="secondary-side-nav custom-scroll-bar">
|
||
|
||
<ul class="contribute">
|
||
<li class="contribute__item">
|
||
<a class="button button-sm" href="https://github.com/scylladb/scylladb/issues/new?title=docs:%20Issue on page Definitions&&body=I%20would%20like%20to%20report%20an%20issue%20on%20page%20https://opensource.docs.scylladb.com/branch-6.2/cql/definitions%0A%0A%23%23%23%20Problem%0A%0A%23%23%23%20%20Suggest%20a%20fix&labels=documentation"
|
||
target="_blank">
|
||
<i class="icon-github" aria-hidden="true"></i>Create an issue
|
||
</a>
|
||
</li>
|
||
|
||
<li class="contribute__item">
|
||
<a class="button button-sm" href="https://github.com/scylladb/scylladb/edit/master/docs/cql/definitions.rst"
|
||
target="_blank">
|
||
<i class="icon-edit" aria-hidden="true"></i>Edit this page
|
||
</a>
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
|
||
<div class="secondary-side-nav__content">
|
||
<p class="topic-title">On this page</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#">Definitions</a><ul>
|
||
<li><a class="reference internal" href="#conventions">Conventions</a></li>
|
||
<li><a class="reference internal" href="#identifiers">Identifiers and keywords</a></li>
|
||
<li><a class="reference internal" href="#constants">Constants</a></li>
|
||
<li><a class="reference internal" href="#terms">Terms</a></li>
|
||
<li><a class="reference internal" href="#comments">Comments</a></li>
|
||
<li><a class="reference internal" href="#statements">Statements</a></li>
|
||
<li><a class="reference internal" href="#prepared-statements">Prepared Statements</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
<div class="sidebar-left large-order-1">
|
||
|
||
|
||
<div id="side-nav" class="side-nav custom-scroll-bar" data-closable data-toggler=".show">
|
||
<button class="collapsible-button">
|
||
<i class="icon-docs-menu-collapse"></i>
|
||
</button>
|
||
<div class="side-nav-content custom-scroll-bar">
|
||
<div class="side-nav__title">
|
||
<a href="../index.html">ScyllaDB Open Source</a>
|
||
</div>
|
||
<div class="side-nav__search">
|
||
|
||
<biel-search-button
|
||
project="ddfdo8m94k"
|
||
button-style="rounded"
|
||
hide-filters="false"
|
||
hide-ctrl-k="true"
|
||
header-title="ScyllaDB chatbot (beta)"
|
||
modal-position="top-center">
|
||
Search
|
||
</biel-search-button>
|
||
|
||
<biel-button class="side-nav__ask-ai" project="ddfdo8m94k"
|
||
header-title="ScyllaDB chatbot (beta)"
|
||
button-position="default"
|
||
modal-position="sidebar-right"
|
||
button-style="dark">
|
||
Ask AI
|
||
</biel-button>
|
||
|
||
|
||
</div>
|
||
<div class="side-nav__versions"><ul class="dropdown menu scylla-dropdown scylla-dropdown--versions" data-dropdown-menu>
|
||
<li class="scylla-dropdown__item">
|
||
<a class="scylla-dropdown__title" href="#">
|
||
|
||
6.2
|
||
|
||
<i class="chevron icon-docs-chevron-right"></i>
|
||
</a>
|
||
<ul class="menu scylla-dropdown__content">
|
||
|
||
|
||
<li>
|
||
<a href="definitions.html">6.2</a>
|
||
</li>
|
||
|
||
|
||
|
||
<li>
|
||
<a href="../../branch-6.1/cql/definitions.html">6.1</a>
|
||
</li>
|
||
|
||
|
||
|
||
<li>
|
||
<a href="../../branch-6.0/cql/definitions.html">6.0</a>
|
||
</li>
|
||
|
||
|
||
|
||
<li>
|
||
<a href="../../branch-5.4/cql/definitions.html">5.4</a>
|
||
</li>
|
||
|
||
|
||
|
||
<li>
|
||
<a href="../../branch-5.2/cql/definitions.html">5.2</a>
|
||
</li>
|
||
|
||
|
||
|
||
<li>
|
||
<a href="../../branch-5.1/cql/definitions.html">5.1</a>
|
||
</li>
|
||
|
||
|
||
|
||
</ul>
|
||
</li>
|
||
</ul></div>
|
||
<div class="side-nav__content">
|
||
<ul class="current">
|
||
<li class="toctree-l1 has-children"><a class="reference internal" href="../getting-started/index.html">Getting Started</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label for="toctree-checkbox-1"><i class="icon-chevron-right"></i></label><div class="break"></div><ul>
|
||
<li class="toctree-l2 has-children"><a class="reference internal" href="../getting-started/install-scylla/index.html">Install ScyllaDB</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label for="toctree-checkbox-2"><i class="icon-chevron-right"></i></label><div class="break"></div><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../getting-started/install-scylla/launch-on-aws.html">Launch ScyllaDB on AWS</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../getting-started/install-scylla/launch-on-gcp.html">Launch ScyllaDB on GCP</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../getting-started/install-scylla/launch-on-azure.html">Launch ScyllaDB on Azure</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../getting-started/installation-common/scylla-web-installer.html">ScyllaDB Web Installer for Linux</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../getting-started/install-scylla/install-on-linux.html">Install ScyllaDB Linux Packages</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../getting-started/install-scylla/install-jmx.html">Install scylla-jmx Package</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../getting-started/install-scylla/run-in-docker.html">Run ScyllaDB in Docker</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../getting-started/installation-common/unified-installer.html">Install ScyllaDB Without root Privileges</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../getting-started/installation-common/air-gapped-install.html">Air-gapped Server Installation</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../getting-started/installation-common/disable-housekeeping.html">ScyllaDB Housekeeping and how to disable it</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../getting-started/installation-common/dev-mod.html">ScyllaDB Developer Mode</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../getting-started/configure.html">Configure ScyllaDB</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../getting-started/config-commands.html">ScyllaDB Configuration Reference</a></li>
|
||
<li class="toctree-l2 has-children"><a class="reference internal" href="../getting-started/requirements.html">ScyllaDB Requirements</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label for="toctree-checkbox-3"><i class="icon-chevron-right"></i></label><div class="break"></div><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../getting-started/system-requirements.html">System Requirements</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../getting-started/os-support.html">OS Support by Linux Distributions and Version</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../getting-started/cloud-instance-recommendations.html">Cloud Instance Recommendations</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../getting-started/scylla-in-a-shared-environment.html">ScyllaDB in a Shared Environment</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2 has-children"><a class="reference internal" href="../using-scylla/migrate-scylla.html">Migrate to ScyllaDB</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label for="toctree-checkbox-4"><i class="icon-chevron-right"></i></label><div class="break"></div><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/procedures/cassandra-to-scylla-migration-process.html">Migration Process from Cassandra to ScyllaDB</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../using-scylla/cassandra-compatibility.html">ScyllaDB and Apache Cassandra Compatibility</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../using-scylla/mig-tool-review.html">Migration Tools Overview</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2 has-children"><a class="reference internal" href="../using-scylla/integrations/index.html">Integration Solutions</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/><label for="toctree-checkbox-5"><i class="icon-chevron-right"></i></label><div class="break"></div><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../using-scylla/integrations/integration-spark.html">Integrate ScyllaDB with Spark</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../using-scylla/integrations/integration-kairos.html">Integrate ScyllaDB with KairosDB</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../using-scylla/integrations/integration-presto.html">Integrate ScyllaDB with Presto</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../using-scylla/integrations/integration-elasticsearch.html">Integrate ScyllaDB with Elasticsearch</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../using-scylla/integrations/integration-k8.html">Integrate ScyllaDB with Kubernetes</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../using-scylla/integrations/integration-janus.html">Integrate ScyllaDB with the JanusGraph Graph Data System</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../using-scylla/integrations/integration-datadog.html">Integrate ScyllaDB with DataDog</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../using-scylla/integrations/integration-kafka.html">Integrate ScyllaDB with Kafka</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../using-scylla/integrations/integration-iota.html">Integrate ScyllaDB with IOTA Chronicle</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../using-scylla/integrations/integration-spring.html">Integrate ScyllaDB with Spring</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../using-scylla/integrations/sink-kafka-connector.html">Shard-Aware Kafka Connector for ScyllaDB</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../using-scylla/integrations/integration-ansible.html">Install ScyllaDB with Ansible</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../using-scylla/integrations/integration-databricks.html">Integrate ScyllaDB with Databricks</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../using-scylla/integrations/integration-jaeger.html">Integrate ScyllaDB with Jaeger Server</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../using-scylla/integrations/integration-mindsdb.html">Integrate ScyllaDB with MindsDB</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../getting-started/tutorials.html">Tutorials</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1 has-children"><a class="reference internal" href="../operating-scylla/index.html">ScyllaDB for Administrators</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"/><label for="toctree-checkbox-6"><i class="icon-chevron-right"></i></label><div class="break"></div><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../operating-scylla/admin.html">Administration Guide</a></li>
|
||
<li class="toctree-l2 has-children"><a class="reference internal" href="../operating-scylla/procedures/index.html">Procedures</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"/><label for="toctree-checkbox-7"><i class="icon-chevron-right"></i></label><div class="break"></div><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/procedures/cluster-management/index.html">Cluster Management</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/procedures/backup-restore/index.html">Backup & Restore</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/procedures/config-change/index.html">Change Configuration</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/procedures/maintenance/index.html">Maintenance</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/procedures/tips/index.html">Best Practices</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/benchmarking-scylla.html">Benchmarking ScyllaDB</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/procedures/cassandra-to-scylla-migration-process.html">Migrate from Cassandra to ScyllaDB</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../getting-started/installation-common/disable-housekeeping.html">Disable Housekeeping</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2 has-children"><a class="reference internal" href="../operating-scylla/security/index.html">Security</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"/><label for="toctree-checkbox-8"><i class="icon-chevron-right"></i></label><div class="break"></div><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/security/security-checklist.html">ScyllaDB Security Checklist</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/security/authentication.html">Enable Authentication</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/security/runtime-authentication.html">Enable and Disable Authentication Without Downtime</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/security/create-superuser.html">Creating a Custom Superuser</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/security/gen-cqlsh-file.html">Generate a cqlshrc File</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../troubleshooting/password-reset.html">Reset Authenticator Password</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/security/enable-authorization.html">Enable Authorization</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/security/authorization.html">Grant Authorization CQL Reference</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/security/certificate-authentication.html">Certificate-based Authentication</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/security/rbac-usecase.html">Role Based Access Control (RBAC)</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/security/client-node-encryption.html">Encryption: Data in Transit Client to Node</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/security/node-node-encryption.html">Encryption: Data in Transit Node to Node</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/security/generate-certificate.html">Generating a self-signed Certificate Chain Using openssl</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/security/saslauthd.html">Configure SaslauthdAuthenticator</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2 has-children"><a class="reference internal" href="../operating-scylla/admin-tools/index.html">Admin Tools</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"/><label for="toctree-checkbox-9"><i class="icon-chevron-right"></i></label><div class="break"></div><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/nodetool.html">Nodetool Reference</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="cqlsh.html">CQLSh</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/rest.html">Admin REST API</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../using-scylla/tracing.html">Tracing</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/admin-tools/scylla-sstable.html">ScyllaDB SStable</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/admin-tools/scylla-types.html">ScyllaDB Types</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/admin-tools/sstableloader.html">SSTableLoader</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/admin-tools/cassandra-stress.html">cassandra-stress</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/admin-tools/sstabledump.html">SSTabledump</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/admin-tools/sstablemetadata.html">SSTableMetadata</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../getting-started/logging.html">ScyllaDB Logs</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/admin-tools/perftune.html">Seastar Perftune</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/admin-tools/virtual-tables.html">Virtual Tables</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/admin-tools/select-from-mutation-fragments.html">Reading mutation fragments</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/admin-tools/maintenance-socket.html">Maintenance socket</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/admin-tools/maintenance-mode.html">Maintenance mode</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/admin-tools/task-manager.html">Task manager</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference external" href="https://monitoring.docs.scylladb.com/">ScyllaDB Monitoring Stack</a></li>
|
||
<li class="toctree-l2"><a class="reference external" href="https://operator.docs.scylladb.com/">ScyllaDB Operator</a></li>
|
||
<li class="toctree-l2"><a class="reference external" href="https://manager.docs.scylladb.com/">ScyllaDB Manager</a></li>
|
||
<li class="toctree-l2 has-children"><a class="reference internal" href="../upgrade/index.html">Upgrade Procedures</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"/><label for="toctree-checkbox-10"><i class="icon-chevron-right"></i></label><div class="break"></div><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../upgrade/scylladb-versioning.html">ScyllaDB Versioning</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../upgrade/upgrade-opensource/index.html">ScyllaDB Open Source Upgrade</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../upgrade/upgrade-to-enterprise/index.html">ScyllaDB Open Source to ScyllaDB Enterprise Upgrade</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../upgrade/ami-upgrade.html">ScyllaDB Image</a></li>
|
||
<li class="toctree-l3"><a class="reference external" href="https://enterprise.docs.scylladb.com/stable/upgrade/upgrade-enterprise/index.html">ScyllaDB Enterprise</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2 has-children"><a class="reference internal" href="../operating-scylla/system-configuration/index.html">System Configuration</a><input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"/><label for="toctree-checkbox-11"><i class="icon-chevron-right"></i></label><div class="break"></div><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../getting-started/system-configuration.html">System Configuration Guide</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/admin.html">scylla.yaml</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/system-configuration/snitch.html">ScyllaDB Snitches</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../operating-scylla/benchmarking-scylla.html">Benchmarking ScyllaDB</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../operating-scylla/diagnostics.html">ScyllaDB Diagnostic Tools</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1 has-children"><a class="reference internal" href="../using-scylla/index.html">ScyllaDB for Developers</a><input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"/><label for="toctree-checkbox-12"><i class="icon-chevron-right"></i></label><div class="break"></div><ul>
|
||
<li class="toctree-l2"><a class="reference external" href="https://docs.scylladb.com/stable/get-started/develop-with-scylladb/index.html">Develop with ScyllaDB</a></li>
|
||
<li class="toctree-l2"><a class="reference external" href="https://docs.scylladb.com/stable/get-started/develop-with-scylladb/tutorials-example-projects.html">Tutorials and Example Projects</a></li>
|
||
<li class="toctree-l2"><a class="reference external" href="https://docs.scylladb.com/stable/get-started/learn-resources/index.html">Learn to Use ScyllaDB</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../using-scylla/alternator/index.html">ScyllaDB Alternator</a></li>
|
||
<li class="toctree-l2 has-children"><a class="reference internal" href="../using-scylla/drivers/index.html">ScyllaDB Drivers</a><input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"/><label for="toctree-checkbox-13"><i class="icon-chevron-right"></i></label><div class="break"></div><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../using-scylla/drivers/cql-drivers/index.html">ScyllaDB CQL Drivers</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../using-scylla/drivers/dynamo-drivers/index.html">ScyllaDB DynamoDB Drivers</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1 current has-children"><a class="reference internal" href="index.html">CQL Reference</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"/><label for="toctree-checkbox-14"><i class="icon-chevron-right"></i></label><div class="break"></div><ul class="current">
|
||
<li class="toctree-l2"><a class="reference internal" href="cqlsh.html">CQLSh: the CQL shell</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="appendices.html">Appendices</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="compaction.html">Compaction</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="consistency.html">Consistency Levels</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="consistency-calculator.html">Consistency Level Calculator</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="ddl.html">Data Definition</a></li>
|
||
<li class="toctree-l2 has-children"><a class="reference internal" href="dml.html">Data Manipulation</a><input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"/><label for="toctree-checkbox-15"><i class="icon-chevron-right"></i></label><div class="break"></div><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="dml/select.html">SELECT</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="dml/insert.html">INSERT</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="dml/update.html">UPDATE</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="dml/delete.html">DELETE</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="dml/batch.html">BATCH</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="types.html">Data Types</a></li>
|
||
<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Definitions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="secondary-indexes.html">Global Secondary Indexes</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="time-to-live.html">Expiring Data with Time to Live (TTL)</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="functions.html">Functions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="wasm.html">Wasm support for user-defined functions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="json.html">JSON Support</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="mv.html">Materialized Views</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="non-reserved-keywords.html">Non-Reserved CQL Keywords</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="reserved-keywords.html">Reserved CQL Keywords</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="service-levels.html">Service Levels</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="cql-extensions.html">ScyllaDB CQL Extensions</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1 has-children"><a class="reference internal" href="../alternator/alternator.html">Alternator: DynamoDB API in Scylla</a><input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"/><label for="toctree-checkbox-16"><i class="icon-chevron-right"></i></label><div class="break"></div><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../alternator/getting-started.html">Getting Started With ScyllaDB Alternator</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../alternator/compatibility.html">ScyllaDB Alternator for DynamoDB users</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1 has-children"><a class="reference internal" href="../features/index.html">Features</a><input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"/><label for="toctree-checkbox-17"><i class="icon-chevron-right"></i></label><div class="break"></div><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../features/lwt.html">Lightweight Transactions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../features/secondary-indexes.html">Global Secondary Indexes</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../features/local-secondary-indexes.html">Local Secondary Indexes</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../features/materialized-views.html">Materialized Views</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../features/counters.html">Counters</a></li>
|
||
<li class="toctree-l2 has-children"><a class="reference internal" href="../features/cdc/index.html">Change Data Capture</a><input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"/><label for="toctree-checkbox-18"><i class="icon-chevron-right"></i></label><div class="break"></div><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../features/cdc/cdc-intro.html">CDC Overview</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../features/cdc/cdc-log-table.html">The CDC Log Table</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../features/cdc/cdc-basic-operations.html">Basic operations in CDC</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../features/cdc/cdc-streams.html">CDC Streams</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../features/cdc/cdc-stream-generations.html">CDC Stream Generations</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../features/cdc/cdc-querying-streams.html">Querying CDC Streams</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../features/cdc/cdc-advanced-types.html">Advanced column types</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../features/cdc/cdc-preimages.html">Preimages and postimages</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../features/cdc/cdc-consistency.html">Data Consistency in CDC</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../features/workload-attributes.html">Workload Attributes</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1 has-children"><a class="reference internal" href="../architecture/index.html">ScyllaDB Architecture</a><input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"/><label for="toctree-checkbox-19"><i class="icon-chevron-right"></i></label><div class="break"></div><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../architecture/tablets.html">Data Distribution with Tablets</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../architecture/ringarchitecture/index.html">ScyllaDB Ring Architecture</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../architecture/architecture-fault-tolerance.html">ScyllaDB Fault Tolerance</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../architecture/console-CL-full-demo.html">Consistency Level Console Demo</a></li>
|
||
<li class="toctree-l2 has-children"><a class="reference internal" href="../architecture/anti-entropy/index.html">ScyllaDB Anti-Entropy</a><input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"/><label for="toctree-checkbox-20"><i class="icon-chevron-right"></i></label><div class="break"></div><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../architecture/anti-entropy/hinted-handoff.html">ScyllaDB Hinted Handoff</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../architecture/anti-entropy/read-repair.html">ScyllaDB Read Repair</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../operating-scylla/procedures/maintenance/repair.html">ScyllaDB Repair</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2 has-children"><a class="reference internal" href="../architecture/sstable/index.html">SSTable</a><input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"/><label for="toctree-checkbox-21"><i class="icon-chevron-right"></i></label><div class="break"></div><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../architecture/sstable/sstable2/index.html">ScyllaDB SSTable - 2.x</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../architecture/sstable/sstable3/index.html">ScyllaDB SSTable - 3.x</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../architecture/compaction/compaction-strategies.html">Compaction Strategies</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../architecture/raft.html">Raft Consensus Algorithm in ScyllaDB</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../architecture/zero-token-nodes.html">Zero-token Nodes</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1 has-children"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting ScyllaDB</a><input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"/><label for="toctree-checkbox-22"><i class="icon-chevron-right"></i></label><div class="break"></div><ul>
|
||
<li class="toctree-l2 has-children"><a class="reference internal" href="../troubleshooting/support/index.html">Errors and Support</a><input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"/><label for="toctree-checkbox-23"><i class="icon-chevron-right"></i></label><div class="break"></div><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../troubleshooting/report-scylla-problem.html">Report a ScyllaDB problem</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../troubleshooting/error-messages/index.html">Error Messages</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../troubleshooting/log-level.html">Change Log Level</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2 has-children"><a class="reference internal" href="../troubleshooting/startup/index.html">ScyllaDB Startup</a><input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"/><label for="toctree-checkbox-24"><i class="icon-chevron-right"></i></label><div class="break"></div><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../troubleshooting/change-ownership.html">Ownership Problems</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../troubleshooting/scylla-wont-start.html">ScyllaDB will not Start</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../troubleshooting/python-error-no-module-named-yaml.html">ScyllaDB Python Script broken</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2 has-children"><a class="reference internal" href="../troubleshooting/upgrade/index.html">Upgrade</a><input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"/><label for="toctree-checkbox-25"><i class="icon-chevron-right"></i></label><div class="break"></div><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../troubleshooting/missing-dotmount-files.html">Inaccessible configuration files after ScyllaDB upgrade</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2 has-children"><a class="reference internal" href="../troubleshooting/cluster/index.html">Cluster and Node</a><input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"/><label for="toctree-checkbox-26"><i class="icon-chevron-right"></i></label><div class="break"></div><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../troubleshooting/handling-node-failures.html">Handling Node Failures</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../troubleshooting/failed-add-remove-replace.html">Failure to Add, Remove, or Replace a Node</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../troubleshooting/failed-decommission.html">Failed Decommission Problem</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../troubleshooting/timeouts.html">Cluster Timeouts</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../troubleshooting/node-joined-without-any-data.html">Node Joined With No Data</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../troubleshooting/nodetool-nullpointerexception.html">NullPointerException</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../troubleshooting/failed-schema-sync.html">Failed Schema Sync</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2 has-children"><a class="reference internal" href="../troubleshooting/modeling/index.html">Data Modeling</a><input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"/><label for="toctree-checkbox-27"><i class="icon-chevron-right"></i></label><div class="break"></div><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../troubleshooting/large-partition-table.html">ScyllaDB Large Partitions Table</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../troubleshooting/large-rows-large-cells-tables.html">ScyllaDB Large Rows and Cells Table</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../troubleshooting/debugging-large-partition.html">Large Partitions Hunting</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../troubleshooting/failed-update-schema.html">Failure to Update the Schema</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2 has-children"><a class="reference internal" href="../troubleshooting/storage/index.html">Data Storage and SSTables</a><input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"/><label for="toctree-checkbox-28"><i class="icon-chevron-right"></i></label><div class="break"></div><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../troubleshooting/space-up.html">Space Utilization Increasing</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../troubleshooting/drop-table-space-up.html">Disk Space is not Reclaimed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../troubleshooting/sstable-corruption.html">SSTable Corruption Problem</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../troubleshooting/pointless-compactions.html">Pointless Compactions</a></li>
|
||
<li class="toctree-l3"><a class="reference external" href="https://monitoring.docs.scylladb.com/stable/use-monitoring/advisor/heavyCompaction.html">Limiting Compaction</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2 has-children"><a class="reference internal" href="../troubleshooting/CQL/index.html">CQL</a><input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"/><label for="toctree-checkbox-29"><i class="icon-chevron-right"></i></label><div class="break"></div><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../troubleshooting/time-zone.html">Time Range Query Fails</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../troubleshooting/copy-from-failed.html">COPY FROM Fails</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../troubleshooting/clients-table.html">CQL Connection Table</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2 has-children"><a class="reference internal" href="../troubleshooting/monitor/index.html">ScyllaDB Monitor and Manager</a><input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"/><label for="toctree-checkbox-30"><i class="icon-chevron-right"></i></label><div class="break"></div><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../troubleshooting/manager-monitoring-integration.html">Manager and Monitoring integration</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../troubleshooting/reverse-dns-sshd.html">Manager lists healthy nodes as down</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2 has-children"><a class="reference internal" href="../troubleshooting/install-remove/index.html">Installation and Removal</a><input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"/><label for="toctree-checkbox-31"><i class="icon-chevron-right"></i></label><div class="break"></div><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../troubleshooting/autoremove-ubuntu.html">Removing ScyllaDB on Ubuntu breaks system packages</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1 has-children"><a class="reference internal" href="../kb/index.html">Knowledge Base</a><input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"/><label for="toctree-checkbox-32"><i class="icon-chevron-right"></i></label><div class="break"></div><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/cdc-experimental-upgrade.html">Upgrading from experimental CDC</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/compaction.html">Compaction</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/consistency.html">Consistency in ScyllaDB</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/count-all-rows.html">Counting all rows in a table is slow</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/cqlsh-more.html">CQL Query Does Not Display Entire Result Set</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/cqlsh-results.html">When CQLSh query returns partial results with followed by “More”</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/custom-user.html">Run ScyllaDB and supporting services as a custom user:group</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/customizing-cpuset.html">Customizing CPUSET</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/decode-stack-trace.html">Decoding Stack Traces</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/disk-utilization.html">Snapshots and Disk Utilization</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/dpdk-hardware.html">DPDK mode</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/flamegraph.html">Debug your database with Flame Graphs</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/gc-grace-seconds.html">How to Change gc_grace_seconds for a Table</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/gossip.html">Gossip in ScyllaDB</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/increase-permission-cache.html">Increase Permission Cache to Avoid Non-paged Queries</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/lwt-differences.html">How does ScyllaDB LWT Differ from Apache Cassandra ?</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/map-cpu.html">Map CPUs to ScyllaDB Shards</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/memory-usage.html">ScyllaDB Memory Usage</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/ntp.html">NTP Configuration for ScyllaDB</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/perftune-modes-sync.html">Updating the Mode in perftune.yaml After a ScyllaDB Upgrade</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/posix.html">POSIX networking for ScyllaDB</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/quiz-administrators.html">ScyllaDB consistency quiz for administrators</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/raid-device.html">Recreate RAID devices</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/rf-increase.html">How to Safely Increase the Replication Factor</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/scylla-and-spark-integration.html">ScyllaDB and Spark integration</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/scylla-limits-systemd.html">Increase ScyllaDB resource limits over systemd</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/seed-nodes.html">ScyllaDB Seed Nodes</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/set-up-swap.html">How to Set up a Swap Space</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/snapshots.html">ScyllaDB Snapshots</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/static-columns.html">ScyllaDB payload sent duplicated static columns</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/stop-local-repair.html">Stopping a local repair</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/system-limits.html">System Limits</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/tombstones-flush.html">How to flush old tombstones from a table</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/ttl-facts.html">Time to Live (TTL) and Compaction</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/unresponsive-nodes.html">ScyllaDB Nodes are Unresponsive</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/update-pk.html">Update a Primary Key</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/use-perf.html">Using the perf utility with ScyllaDB</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../kb/yaml-address.html">Configure ScyllaDB Networking with Multiple NIC/IP Combinations</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1 has-children"><a class="reference internal" href="../reference/index.html">Reference</a><input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"/><label for="toctree-checkbox-33"><i class="icon-chevron-right"></i></label><div class="break"></div><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/aws-images.html">AWS Images</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/azure-images.html">Azure Images</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/gcp-images.html">GCP Images</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/configuration-parameters.html">Configuration Parameters</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/glossary.html">Glossary</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/limits.html">Limits</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/api-reference.html">API Reference (BETA)</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/metrics.html">Metrics (BETA)</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../faq.html">ScyllaDB FAQ</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../contribute.html">Contribute to ScyllaDB</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</section>
|
||
|
||
<footer class="footer">
|
||
<div class="footer-group">
|
||
<div class="footer-top">
|
||
<a class="footer-logo" href="https://www.scylladb.com"></a>
|
||
<div class="footer-links">
|
||
<a class="footer-links__link" href="https://docs.scylladb.com/" target="_blank">Docs</a>
|
||
<a class="footer-links__link" href="https://docs.scylladb.com/stable/get-started/develop-with-scylladb/tutorials-example-projects.html" target="_blank">Tutorials</a>
|
||
<a class="footer-links__link" href="https://university.scylladb.com/" target="_blank">University</a>
|
||
<a class="footer-links__link" href="https://www.scylladb.com/company/contact-us/"
|
||
target="_blank">Contact Us</a>
|
||
<a class="footer-links__link" href="https://www.scylladb.com/company/" target="_blank">About Us</a>
|
||
</div>
|
||
<div class="footer-actions">
|
||
<a class="footer-actions__link" href="http://slack.scylladb.com/" target="_blank">
|
||
<span data-tooltip tabindex="1" title="User Slack channel" data-position="bottom">
|
||
<i class="icon-slack"></i>
|
||
</span>
|
||
</a>
|
||
<a class="footer-actions__link" href="https://forum.scylladb.com/" target="_blank">
|
||
<span data-tooltip tabindex="1" title="Community forum" data-position="bottom">
|
||
<i class="icon-docs-community"></i>
|
||
</span>
|
||
</a>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<div class="footer-copyright">
|
||
|
||
|
||
© 2026, ScyllaDB. All rights reserved.
|
||
|
||
| <a class="footer-copyright__link" href="https://www.scylladb.com/tos/" target="_blank">Terms of Service</a>
|
||
| <a class="footer-copyright__link" href="https://www.scylladb.com/privacy/" target="_blank">Privacy Policy</a>
|
||
| ScyllaDB, and ScyllaDB Cloud, are registered trademarks of ScyllaDB, Inc.
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<div class="footer-bottom">
|
||
|
||
<div class="footer-bottom__last-updated">
|
||
|
||
Last updated on 19 Apr 2026.
|
||
|
||
</div>
|
||
|
||
<div class="footer-bottom__version">
|
||
Powered by
|
||
<a class="footer-bottom__link" href="http://sphinx-doc.org/">Sphinx 9.1.0</a> &
|
||
<a class="footer-bottom__link" href="https://sphinx-theme.scylladb.com/">ScyllaDB Theme 1.9.2</a>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</footer>
|
||
|
||
<noscript>
|
||
<iframe src="https://www.googletagmanager.com/ns.html?id=GTM-T8P2JP" height="0" width="0"
|
||
style="display: none; visibility: hidden"></iframe>
|
||
</noscript>
|
||
</body>
|
||
|
||
</html> |