bahman/scylla
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Merge 'doc: create a new CQL reference section to aggregate CQL information - V2' from Anna Stuchlik

Browse Source 
This PR is V2 of https://github.com/scylladb/scylla/pull/11065.

The scope of updates:
- Created a _/cql/_ folder.
- Moved all the CQL-related pages from _/getting-started/_ to _/cql/_ .
- Moved the _cql-extensions.md_ file from _/dev/_ to  _/cql/_ .
- Removed the outdated files and references.
- Updated the links to the CQL-related pages.

Closes #11083

* github.com:scylladb/scylla:
  doc: update the links following the content reorganization
  doc: remove the outdated cql pages and delete them from the indexes
  doc: add index.rst for the cql folder and add it to toctree
  doc: move cql-extensions.md from the dev docs to the cql folder
  doc: move the CQL pages from getting-started to cql
  doc: add redirections for the CQL pages
This commit is contained in:
Avi Kivity
2022-07-20 17:28:24 +03:00
parent 6fd479b151 4f2b12becc
commit 89a935625d
45 changed files with 124 additions and 126 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/_utils/redirects.yaml
View File

@@ -1,6 +1,23 @@
### a dictionary of redirections
#old path: new path
### moving the CQL reference files to the new cql folder
/stable/getting-started/ddl.html: /stable/cql/ddl.html
/stable/getting-started/dml.html: /stable/cql/dml.html
/stable/getting-started/time-to-live.html: /stable/cql/time-to-live.html
/stable/getting-started/types.html: /stable/cql/types.html
/stable/getting-started/appendices.html: /stable/cql/appendices.html
/stable/getting-started/definitions.html: /stable/cql/definitions.html
/stable/getting-started/mv.html: /stable/cql/mv.html
/stable/getting-started/functions.html: /cql/functions.html
/stable/getting-started/json.html: /stable/cql/json.html
/stable/getting-started/secondary-indexes.html: /stable/cql/secondary-indexes.html
/stable/getting-started/consistency.html: /stable/cql/consistency.html
/stable/getting-started/compaction.html: /stable/cql/compaction.html
/stable/getting-started/reserved-keywords.html: /stable/cql/reserved-keywords.html
/stable/getting-started/non-reserved-keywords.html: /stable/cql/non-reserved-keywords.html
### scylladb/scylla dev docs migration
# stable branch

4
docs/architecture/anti-entropy/read-repair.rst
View File

@@ -68,9 +68,9 @@ Another read repair mechanism is **probabilistic** read repair, which works as f
5. If a query’s consistency level is more than 1, and a data mismatch is found before consistency level is reached, then the read repair will run in the foreground. **All replica nodes are updated before the data is returned to the client.** However, if data mismatch is found *after* a query’s consistency level is achieved, the update happens in the background, as mentioned above.
The probability of this kind of read repair occurring on a read request is based on the :code:`read_repair_chance`. This :doc:`setting </getting-started/ddl/>`, provided when a table is created, can apply across data centers. The setting specifies the probability that extra nodes (in addition to those required by the consistency level) are queried for the purpose of read repairs.
The probability of this kind of read repair occurring on a read request is based on the :code:`read_repair_chance`. This :doc:`setting </cql/ddl/>`, provided when a table is created, can apply across data centers. The setting specifies the probability that extra nodes (in addition to those required by the consistency level) are queried for the purpose of read repairs.
A similar :doc:`setting </getting-started/ddl/>`, :code:`dclocal_read_repair_chance`, applies only to nodes within the local data center. You can use this setting when conserving traffic between data centers is important.
A similar :doc:`setting </cql/ddl/>`, :code:`dclocal_read_repair_chance`, applies only to nodes within the local data center. You can use this setting when conserving traffic between data centers is important.
* :doc:`Scylla Anti-Entropy </architecture/anti-entropy/index/>`

4
docs/architecture/architecture-fault-tolerance.rst
View File

@@ -19,7 +19,7 @@ During a :term:`read operation<Read Operation>`, the client sends a request to t
The :term:`Consistency Level (CL)<Consistency Level (CL)>` determines how many replicas in a cluster must acknowledge read or :term:`write operations<Write Operation>` before it is considered successful.
For the CQL Shell (:doc:`CQLsh </getting-started/cqlsh>`), the consistency level defaults to ONE for read and write operations.
For the CQL Shell (:doc:`CQLsh </cql/cqlsh>`), the consistency level defaults to ONE for read and write operations.
.. note::
@@ -74,5 +74,5 @@ Additional Resources
--------------------
* :doc:`Consistency Level Console Demo </architecture/console-CL-full-demo>`
* :doc:`Consistency Levels </getting-started/consistency/>`
* :doc:`Consistency Levels </cql/consistency/>`
* From Scylla Univeristy: take the `Consistency Level lesson <https://university.scylladb.com/courses/scylla-essentials-overview/lessons/architecture/topic/consistency-level-cl/>`_

4
docs/architecture/compaction/compaction-strategies.rst
View File

@@ -11,7 +11,7 @@ Scylla implements the following compaction strategies in order to reduce :term:`
* `Time-window compaction strategy (TWCS)`_ - designed for time series data; replaced Date-tiered compaction.
* `Date-tiered compaction strategy (DTCS)`_ - designed for time series data.
This document covers how to choose a compaction strategy and presents the benefits and disadvantages of each one. If you want more information on compaction in general or on any of these strategies, refer to the :doc:`Compaction Overview </kb/compaction>`. If you want an explanation of the CQL commands used to create a compaction strategy, refer to :doc:`Compaction CQL Reference </getting-started/compaction>` .
This document covers how to choose a compaction strategy and presents the benefits and disadvantages of each one. If you want more information on compaction in general or on any of these strategies, refer to the :doc:`Compaction Overview </kb/compaction>`. If you want an explanation of the CQL commands used to create a compaction strategy, refer to :doc:`Compaction CQL Reference </cql/compaction>` .
Learn more in the `Compaction Strategies lesson <https://university.scylladb.com/courses/scylla-operations/lessons/compaction-strategies/>`_ on Scylla University
@@ -238,7 +238,7 @@ The comments below describe the type of amplification each compaction strategy
References
----------
* :doc:`Compaction Overview </kb/compaction>` - contains in depth information on all of the strategies
* :doc:`Compaction CQL Reference </getting-started/compaction>` - covers the CQL parameters used for implementing compaction
* :doc:`Compaction CQL Reference </cql/compaction>` - covers the CQL parameters used for implementing compaction
* Scylla Summit Tech Talk: `How to Ruin Performance by Choosing the Wrong Compaction Strategy <https://www.scylladb.com/tech-talk/ruin-performance-choosing-wrong-compaction-strategy-scylla-summit-2017/>`_

2
docs/architecture/raft.rst
View File

@@ -88,7 +88,7 @@ You can verify that Raft is enabled on your cluster in one of the following ways
Safe Schema Changes with Raft
-------------------------------
In ScyllaDB, schema is based on :doc:`Data Definition Language (DDL) <../getting-started/ddl>`. In earlier ScyllaDB versions, schema changes were tracked via the gossip protocol, which might lead to schema conflicts if the updates are happening concurrently.
In ScyllaDB, schema is based on :doc:`Data Definition Language (DDL) </cql/ddl>`. In earlier ScyllaDB versions, schema changes were tracked via the gossip protocol, which might lead to schema conflicts if the updates are happening concurrently.
Implementing Raft eliminates schema conflicts and allows full automation of DDL changes under any conditions, as long as a quorum
of nodes in the cluster is available. The following examples illustrate how Raft provides the solution to problems with schema changes.

0
docs/getting-started/appendices.rst → docs/cql/appendices.rst
View File

2
docs/getting-started/compaction.rst → docs/cql/compaction.rst
View File

@@ -324,7 +324,7 @@ TWCS options
See Also
^^^^^^^^^
* :doc:`Apache Cassandra Query Language </getting-started/cql/>`
* :doc:`Apache Cassandra Query Language (CQL) Reference </cql/index>`
* :doc:`Compaction Strategies </architecture/compaction/compaction-strategies/>`

0
docs/getting-started/consistency-calculator.html → docs/cql/consistency-calculator.html
View File

0
docs/getting-started/consistency.rst → docs/cql/consistency.rst
View File

6
docs/dev/cql-extensions.md → docs/cql/cql-extensions.md
View File

@@ -1,4 +1,4 @@
# Scylla CQL extensions
# ScyllaDB CQL Extensions
Scylla extends the CQL language to provide a few extra features. This document
lists those extensions.
@@ -219,5 +219,5 @@ If the driver doesn't support it, `Config_error` will be sent instead.
For more details, see:
- Detailed [`design notes`](./per-partition-rate-limit.md)
- Description of the [rate limit exceeded](./protocol-extensions.md#rate-limit-error) error
- Detailed [design notes](https://github.com/scylladb/scylla/blob/master/docs/dev/per-partition-rate-limit.md)
- Description of the [rate limit exceeded](https://github.com/scylladb/scylla/blob/master/docs/dev/protocol-extensions.md#rate-limit-error) error

2
docs/getting-started/cqlsh.rst → docs/cql/cqlsh.rst
View File

@@ -530,7 +530,7 @@ See also:
CQLSH `lesson <https://university.scylladb.com/courses/data-modeling/lessons/basic-data-modeling-2/topic/cql-cqlsh-and-basic-cql-syntax/>`_ on Scylla University
:doc:`Apache Cassandra Query Language </getting-started/cql/>`
* :doc:`Apache Cassandra Query Language (CQL) Reference </cql/index>`
:doc:`Back </getting-started/index/>`

6
docs/getting-started/ddl.rst → docs/cql/ddl.rst
View File

@@ -85,7 +85,7 @@ We also define the notion of statement options for use in the following section:
.. _create-keyspace-statement:
In all cases, for creating keyspaces and tables, if you are using :doc:`Reserved Keywords </getting-started/reserved-keywords>`, enclose them in single or double-quotes.
In all cases, for creating keyspaces and tables, if you are using :doc:`Reserved Keywords </cql/reserved-keywords>`, enclose them in single or double-quotes.
CREATE KEYSPACE
^^^^^^^^^^^^^^^
@@ -949,7 +949,7 @@ Dropping a table results in the immediate removal of the table, including all da
If the table does not exist, the statement will return an error unless ``IF EXISTS`` is used, in which case the
operation is a no-op.
.. note:: Dropping a table that has materialized views is disallowed and will return an error. To do so, the materialized views that depend on the table must first be explicitly dropped. Refer to :doc:`Materialized Views </getting-started/mv>` for details.
.. note:: Dropping a table that has materialized views is disallowed and will return an error. To do so, the materialized views that depend on the table must first be explicitly dropped. Refer to :doc:`Materialized Views </cql/mv>` for details.
.. _truncate-statement:
@@ -969,7 +969,7 @@ Truncating a table permanently removes all existing data from the table, but wit
.. caution:: Do not run any operation on a table that is being truncated. Truncate operation is an administrative operation, and running any other operation on the same table in parallel may cause the truncating table's data to end up in an undefined state.
:doc:`Apache Cassandra Query Language </getting-started/cql/>`
* :doc:`Apache Cassandra Query Language (CQL) Reference </cql/index>`
.. include:: /rst_include/apache-copyrights.rst

4
docs/getting-started/definitions.rst → docs/cql/definitions.rst
View File

@@ -175,8 +175,8 @@ Statements
CQL consists of statements that can be divided into the following categories:
- :doc:`Data Definition </getting-started/ddl/>` statements - to define and change how the data is stored (keyspaces and tables).
- :doc:`Data Manipulation </getting-started/dml/>` statements - for selecting, inserting and deleting data.
- :doc:`Data Definition </cql/ddl/>` statements - to define and change how the data is stored (keyspaces and tables).
- :doc:`Data Manipulation </cql/dml/>` statements - for selecting, inserting and deleting data.
- :ref:`cql-permissions` statements.
- cql-triggers statements.

6
docs/getting-started/dml.rst → docs/cql/dml.rst
View File

@@ -143,7 +143,7 @@ You can read more about the ``TIMESTAMP`` retrieved by ``WRITETIME`` in the :ref
- ``TTL`` retrieves the remaining time to live (in *seconds*) for the value of the column, if it set to expire, or ``null`` otherwise.
You can read more about TTL in the :doc:`documentation </getting-started/time-to-live>` and also in `this Scylla University lesson <https://university.scylladb.com/courses/data-modeling/lessons/advanced-data-modeling/topic/expiring-data-with-ttl-time-to-live/>`.
You can read more about TTL in the :doc:`documentation </cql/time-to-live>` and also in `this Scylla University lesson <https://university.scylladb.com/courses/data-modeling/lessons/advanced-data-modeling/topic/expiring-data-with-ttl-time-to-live/>`.
.. _where-clause:
@@ -771,7 +771,7 @@ parameters:
the columns themselves. This means that any subsequent update of the column will also reset the TTL (to whatever TTL
is specified in that update). By default, values never expire. A TTL of 0 is equivalent to no TTL. If the table has a
default_time_to_live, a TTL of 0 will remove the TTL for the inserted or updated values. A TTL of ``null`` is equivalent
to inserting with a TTL of 0. You can read more about TTL in the :doc:`documentation </getting-started/time-to-live>` and also in `this Scylla University lesson <https://university.scylladb.com/courses/data-modeling/lessons/advanced-data-modeling/topic/expiring-data-with-ttl-time-to-live/>`.
to inserting with a TTL of 0. You can read more about TTL in the :doc:`documentation </cql/time-to-live>` and also in `this Scylla University lesson <https://university.scylladb.com/courses/data-modeling/lessons/advanced-data-modeling/topic/expiring-data-with-ttl-time-to-live/>`.
- ``TIMEOUT``: specifies a timeout duration for the specific request.
Please refer to the :ref:`SELECT <using-timeout>` section for more information.
@@ -952,7 +952,7 @@ Use the ``COUNTER`` option for batched counter updates. Unlike other
updates in Scylla, counter updates are not idempotent.
:doc:`Apache Cassandra Query Language </getting-started/cql/>`
:doc:`Apache Cassandra Query Language (CQL) Reference </cql/index>`
.. include:: /rst_include/apache-copyrights.rst

0
docs/getting-started/functions.rst → docs/cql/functions.rst
View File

58
docs/cql/index.rst Normal file
View File

@@ -0,0 +1,58 @@
CQL Reference
===============
.. toctree::
:maxdepth: 2
:hidden:
cqlsh
appendices
compaction
consistency
ddl
dml
types
definitions
secondary-indexes
time-to-live
functions
json
mv
non-reserved-keywords
reserved-keywords
cql-extensions.md
cqlsh - The CQL Shell
-----------------------
``cqlsh`` is a command line shell for interacting with ScyllaDB through CQL.
* :doc:`CQLSh: the CQL shell </cql/cqlsh>`
CQL - Apache Cassandra Query Language
----------------------------------------
The Apache Cassandra Query Language (CQL) is the primary language for communicating with the ScyllaDB database.
It allows you to create keyspaces and tables, insert and query tables, and more.
* :doc:`Appendices </cql/appendices>`
* :doc:`Compaction </cql/compaction>`
* :doc:`Consistency Levels </cql/consistency>`
* :doc:`Data Definition </cql/ddl>`
* :doc:`Data Manipulation </cql/dml>`
* :doc:`Data Types </cql/types>`
* :doc:`Definitions </cql/definitions>`
* :doc:`Global Secondary Indexes </cql/secondary-indexes>`
* :doc:`Expiring Data with Time to Live (TTL) </cql/time-to-live>`
* :doc:`Functions </cql/functions>`
* :doc:`JSON Support </cql/json>`
* :doc:`Materialized Views </cql/mv>`
* :doc:`Non-Reserved CQL Keywords </cql/non-reserved-keywords>`
* :doc:`Reserved CQL Keywords </cql/reserved-keywords>`
ScyllaDB CQL Extensions - CQL Extensions Provided by ScyllaDB
--------------------------------------------------------------
ScyllaDB provides additional features that extend the Apache CQL.
* :doc:`ScyllaDB CQL Extensions </cql/cql-extensions>`

2
docs/getting-started/json.rst → docs/cql/json.rst
View File

@@ -119,6 +119,6 @@ The ``toJson()`` function may be used similarly to ``SELECT JSON``, but for a si
in the selection clause of a ``SELECT`` statement.
:doc:`Apache Cassandra Query Language </getting-started/cql/>`
* :doc:`Apache Cassandra Query Language (CQL) Reference </cql/index>`
.. include:: /rst_include/apache-copyrights.rst

2
docs/getting-started/mv.rst → docs/cql/mv.rst
View File

@@ -179,6 +179,6 @@ If the materialized view does not exist, the statement will return an error unle
the operation is a no-op.
:doc:`Apache Cassandra Query Language </getting-started/cql/>`
* :doc:`Apache Cassandra Query Language (CQL) Reference </cql/index>`
.. include:: /rst_include/apache-copyrights.rst

0
docs/getting-started/non-reserved-keywords.rst → docs/cql/non-reserved-keywords.rst
View File

0
docs/getting-started/reserved-keywords.rst → docs/cql/reserved-keywords.rst
View File

0
docs/getting-started/secondary-indexes.rst → docs/cql/secondary-indexes.rst
View File

2
docs/getting-started/time-to-live.rst → docs/cql/time-to-live.rst
View File

@@ -102,7 +102,7 @@ Additional Information
To learn more about TTL, and see a hands-on example, check out `this lesson <https://university.scylladb.com/courses/data-modeling/lessons/advanced-data-modeling/topic/expiring-data-with-ttl-time-to-live/>`_ on Scylla University.
* :doc:`Apache Cassandra Query Language </getting-started/cql/>`
* :doc:`Apache Cassandra Query Language (CQL) Reference </cql/index>`
* :doc:`KB Article:How to Change gc_grace_seconds for a Table </kb/gc-grace-seconds/>`
* :doc:`KB Article:Time to Live (TTL) and Compaction </kb/ttl-facts/>`
* :ref:`CQL Reference: Table Options <create-table-general-options>`

0
docs/getting-started/types.rst → docs/cql/types.rst
View File

2
docs/faq.rst
View File

@@ -409,7 +409,7 @@ Should I use RAID for replications, such as RAID1, RAID4 or higher?
You can, but it is not recommended. Scylla :doc:`clustering architecture </architecture/ringarchitecture/index/>` already provides data replication across nodes and DCs.
Adding another layer of replication in each node is redundant, slows down I/O operation and reduces available storage.
Want a higher level of replication?
Increase the Replication Factor (RF) of :doc:`relevant Keyspaces </getting-started/ddl/>`.
Increase the Replication Factor (RF) of :doc:`relevant Keyspaces </cql/ddl/>`.
Can I use JBOD and not use RAID0?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

28
docs/getting-started/cql.rst
View File

@@ -1,28 +0,0 @@
Cassandra Query Language (CQL)
==============================
.. toctree::
:hidden:
CQLSh the CQL shell <cqlsh>
Data Definition </getting-started/ddl>
Data Manipulation </getting-started/dml>
Expiring Data with Time to Live </getting-started/time-to-live>
Security </operating-scylla/security/index>
Data Types </getting-started/types>
Appendices </getting-started/appendices>
Definitions </getting-started/definitions>
Materialized Views </getting-started/mv>
Functions </getting-started/functions>
JSON </getting-started/json>
Secondary Indexes </getting-started/secondary-indexes>
Compaction </getting-started/compaction>
Consistency Levels </getting-started/consistency>
Reserved Keywords </getting-started/reserved-keywords>
Non-reserved Keywords </getting-started/non-reserved-keywords>
.. include:: /rst_include/cql-index.rst
.. include:: /rst_include/apache-copyrights.rst
.. Operators </getting-started/operators>

6
docs/getting-started/index.rst
View File

@@ -8,8 +8,6 @@ Getting Started
install-scylla/index
configure
requirements
cql
cqlsh
Scylla Drivers </using-scylla/drivers/index>
Migrate to Scylla </using-scylla/migrate-scylla>
Integration Solutions </using-scylla/integrations/index>
@@ -42,8 +40,8 @@ Getting Started
* :doc:`Scylla Drivers</using-scylla/drivers/index>`
* `Get Started Lesson on Scylla University <https://university.scylladb.com/courses/scylla-essentials-overview/lessons/quick-wins-install-and-run-scylla/>`_
* :doc:`Apache Cassandra Query Language (CQL) Reference </getting-started/cql/>`
* :doc:`CQLSh: the CQL shell</getting-started/cqlsh/>`
* :doc:`CQL Reference </cql/index>`
* :doc:`cqlsh - the CQL shell </cql/cqlsh/>`
.. panel-box::
:title: Use Scylla with Third-party Solutions

4
docs/glossary.rst
View File

@@ -32,10 +32,10 @@ Glossary
Determines which of the SSTables will be compacted, and when. See :doc:`Compaction Strategies</architecture/compaction/compaction-strategies/>`.
Consistency Level (CL)
A dynamic value which dictates the number of replicas (in a cluster) that must acknowledge a read or write operation. This value is set by the client on a per operation basis. For the CQL Shell, the consistency level defaults to ONE for read and write operations. See :doc:`Consistency Levels </getting-started/consistency>`.
A dynamic value which dictates the number of replicas (in a cluster) that must acknowledge a read or write operation. This value is set by the client on a per operation basis. For the CQL Shell, the consistency level defaults to ONE for read and write operations. See :doc:`Consistency Levels </cql/consistency>`.
Quorum
Quorum is a *global* consistency level setting across the entire cluster including all data centers. See :doc:`Consistency Levels </getting-started/consistency>`.
Quorum is a *global* consistency level setting across the entire cluster including all data centers. See :doc:`Consistency Levels </cql/consistency>`.
Date-tiered compaction strategy (DTCS)
:abbr:`DTCS (Date-tiered compaction strategy)` is designed for time series data, but should not be used. Use :term:`Time-Window Compaction Strategy`. See :doc:`Compaction Strategies</architecture/compaction/compaction-strategies/>`.

1
docs/index.rst
View File

@@ -174,6 +174,7 @@
getting-started/index
operating-scylla/index
using-scylla/index
cql/index
architecture/index
troubleshooting/index
kb/index

6
docs/kb/compaction.rst
View File

@@ -2,7 +2,7 @@ Compaction
==========
This document gives a high level overview of Compaction, focusing on what compaction is, and how it works. There is a different document that covers the :doc:`CQL syntax </getting-started/compaction>` for setting a compaction strategy. There is also another document, :doc:`Compaction Strategy Matrix </architecture/compaction/compaction-strategies>`, that covers how to decide which strategy works best.
This document gives a high level overview of Compaction, focusing on what compaction is, and how it works. There is a different document that covers the :doc:`CQL syntax </cql/compaction>` for setting a compaction strategy. There is also another document, :doc:`Compaction Strategy Matrix </architecture/compaction/compaction-strategies>`, that covers how to decide which strategy works best.
How Scylla Writes Data
----------------------
@@ -50,7 +50,7 @@ A compaction strategy is what determines which of the SSTables will be compacted
How to Set a Compaction Strategy
................................
Compaction strategies are set as part of the ``CREATE`` or ``ALTER`` statement when creating or altering tables. Refer to the :doc:`CQL syntax </getting-started/compaction>` for details.
Compaction strategies are set as part of the ``CREATE`` or ``ALTER`` statement when creating or altering tables. Refer to the :doc:`CQL syntax </cql/compaction>` for details.
.. caution:: Changing the parameters for compaction strategies or changing from one strategy to another (using the ``ALTER`` statement) can create issues. See `Changing Compaction Strategies or Properties`_ for more information.
@@ -238,7 +238,7 @@ Use the table in :ref:`Which strategy is best <which-strategy-is-best>` to deter
References
----------
* :doc:`CQL Reference for Compaction </getting-started/compaction>`
* :doc:`CQL Reference for Compaction </cql/compaction>`
* :doc:`How to Choose a Compaction Strategy </architecture/compaction/compaction-strategies>`.

2
docs/kb/snapshots.rst
View File

@@ -29,7 +29,7 @@ How Snapshots Work
Scylla, like Cassandra, requires `Unix-like storage <https://en.wikipedia.org/wiki/Unix_filesystem?>`_ (such is also a file system supported by Linux). As mentioned above, snapshots are hard links to SSTables on disk. It is important to understand that SSTables are immutable and as such are not re-written in the same file. When data in database changes and data is written to disk, it is written as a new file. The new files are consolidated following compaction, which merges table’s data into one or more SSTable files (depending on the compaction strategy).
If snapshots (hard links) were created to existing SSTables on disk they are preserved even if table data is eventually stored in one or more of the new SSTables. The :doc:`compaction process </getting-started/compaction>` removes files in the data directory, but the snapshot hard links **will still** be pointing to the **old files**. Only after all of the pointers are removed, the actual file is removed. If even one pointer exists, the file will remain. Therefore, even as the database is moving on, once the snapshot hard links are created, the content of the data files can be copied off to another storage and serve as the foundation for a table, keyspace, or entire database restore (on that node, as this backup and restore process is node specific).
If snapshots (hard links) were created to existing SSTables on disk they are preserved even if table data is eventually stored in one or more of the new SSTables. The :doc:`compaction process </cql/compaction>` removes files in the data directory, but the snapshot hard links **will still** be pointing to the **old files**. Only after all of the pointers are removed, the actual file is removed. If even one pointer exists, the file will remain. Therefore, even as the database is moving on, once the snapshot hard links are created, the content of the data files can be copied off to another storage and serve as the foundation for a table, keyspace, or entire database restore (on that node, as this backup and restore process is node specific).
Apart from *planned backup* procedure described above, and as a safeguard from *accidental* loss of data, the Scylla database includes an optional creation of an automatic snapshot every time a table is dropped or truncated. As dropping a keyspace involves dropping tables within that keyspace, these actions will invoke auto snapshots as well. This option is enabled out of the box and is controlled by the auto_snapshot flag in the ``/etc/scylla/scylla.yaml`` configuration file. Note that a keyspace cannot be truncated. It can only be dropped. A table, on the other hand, can be either truncated or dropped. The data in a table can also be deleted, which is different from being truncated.

2
docs/kb/ttl-facts.rst
View File

@@ -87,5 +87,5 @@ Additional Information
----------------------
* :doc:`How to Change gc_grace_seconds for a Table </kb/gc-grace-seconds/>`
* :doc:`Expiring Data with Time to Live (TTL) </getting-started/time-to-live/>`
* :doc:`Expiring Data with Time to Live (TTL) </cql/time-to-live/>`
* :ref:`CQL Reference: Table Options <create-table-general-options>`

2
docs/operating-scylla/_common/tools_index.rst
View File

@@ -1,5 +1,5 @@
* :doc:`Nodetool Reference</operating-scylla/nodetool>` - Scylla commands for managing Scylla node or cluster using the command-line nodetool utility.
* :doc:`CQLSh - the CQL shell</getting-started/cqlsh>`.
* :doc:`CQLSh - the CQL shell</cql/cqlsh>`.
* :doc:`REST - Scylla REST/HTTP Admin API</operating-scylla/rest>`.
* :doc:`Tracing </using-scylla/tracing>` - a ScyllaDB tool for debugging and analyzing internal flows in the server.
* :doc:`SSTableloader </operating-scylla/admin-tools/sstableloader>` - Bulk load the sstables found in the directory to a Scylla cluster

2
docs/operating-scylla/admin-tools/index.rst
View File

@@ -6,7 +6,7 @@ Admin Tools
:hidden:
Nodetool Reference </operating-scylla/nodetool>
CQLSh </getting-started/cqlsh>
CQLSh </cql/cqlsh>
REST </operating-scylla/rest>
Tracing </using-scylla/tracing>
scylla-sstable

2
docs/operating-scylla/nodetool-commands/compact.rst
View File

@@ -59,6 +59,6 @@ See Also
:doc:`Compaction Overview </kb/compaction>`
:doc:`CQL compaction Reference </getting-started/compaction>`
:doc:`CQL compaction Reference </cql/compaction>`
:doc:`How to choose a Compaction Strategy </architecture/compaction/compaction-strategies>`

2
docs/operating-scylla/nodetool-commands/refresh.rst
View File

@@ -5,7 +5,7 @@ Nodetool refresh
Add the files to the upload directory, by default it is located under ``/var/lib/scylla/data/keyspace_name/table_name-UUID/upload``
:doc:`Materialized Views (MV)</getting-started/mv/>` and :doc:`Secondary Indexes (SI)</getting-started/secondary-indexes/>` of the upload table, and if they exist, they are automatically updated. Uploading MV or SI SSTables is not required and will fail.
:doc:`Materialized Views (MV)</cql/mv/>` and :doc:`Secondary Indexes (SI)</cql/secondary-indexes/>` of the upload table, and if they exist, they are automatically updated. Uploading MV or SI SSTables is not required and will fail.
.. note:: Scylla node will ignore the partitions in the sstables which are not assigned to this node. For example, if sstable are copied from a different node.

2
docs/operating-scylla/security/authorization.rst
View File

@@ -519,7 +519,7 @@ Show any permissions granted to ``carlos``, limited to ``SELECT`` permissions on
Related Topics
```````````````
* :doc:`Apache Cassandra Query Language </getting-started/cql/>`
* :doc:`Apache Cassandra Query Language (CQL) Reference </cql/index>`
* :doc:`Role Based Access Control (RBAC) </operating-scylla/security/rbac-usecase>`

2
docs/operating-scylla/security/rbac-usecase.rst
View File

@@ -212,5 +212,5 @@ Additional References
---------------------
* :doc:`Authorization</operating-scylla/security/authorization/>`
* :doc:`CQLSh the CQL shell</getting-started/cqlsh>`
* :doc:`CQLSh the CQL shell</cql/cqlsh>`
* :doc:`Workload Prioritization </using-scylla/workload-prioritization/>` - to attach a service level to a role

2
docs/rst_include/apache-cql-return-index.rst
View File

@@ -1 +1 @@
:doc:`Apache Cassandra Query Language </getting-started/cql/>`
:doc:`Apache Cassandra Query Language </cql/index>`

38
docs/rst_include/cql-index.rst
View File

@@ -1,38 +0,0 @@
.. raw:: html
<div class="panel callout radius animated">
<div class="row">
<div class="medium-3 columns">
<h5 id="getting-started"></h5>
</div>
<div class="medium-9 columns">
* :doc:`CQLSh the CQL shell</getting-started/cqlsh>`
* :doc:`Data Definition</getting-started/ddl>`
* :doc:`Data Manipulation</getting-started/dml>`
* :doc:`Expiring Data with Time to Live</getting-started/time-to-live>`
* :doc:`Security </operating-scylla/security/index>`
* :doc:`Data Types</getting-started/types>`
* :doc:`Appendices</getting-started/appendices>`
* :doc:`Definitions</getting-started/definitions>`
* :doc:`Materialized Views</getting-started/mv>`
* :doc:`Functions</getting-started/functions>`
* :doc:`JSON </getting-started/json>`
* :doc:`Secondary Indexes</getting-started/secondary-indexes>`
* :doc:`Consistency Levels </getting-started/consistency>`
* :doc:`Compaction </getting-started/compaction>`
* :doc:`Reserved Keywords </getting-started/reserved-keywords>`
* :doc:`Non-reserved Keywords </getting-started/non-reserved-keywords>`
.. raw:: html
</div>
</div>
</div>
.. * :doc:`Operators</getting-started/operators>`

2
docs/troubleshooting/copy-from-failed.rst
View File

@@ -34,5 +34,5 @@ Additional References
.. include:: /troubleshooting/_common/ts-return.rst
:doc:`CQL Reference </getting-started/cql>`
:doc:`CQL Reference </cql/index>`

8
docs/using-scylla/cql.rst
View File

@@ -1,8 +0,0 @@
Apache Cassandra Query Language (CQL)
=====================================
.. include:: /rst_include/cql-index.rst
.. include:: /rst_include/apache-copyrights.rst

8
docs/using-scylla/index.rst
View File

@@ -6,8 +6,6 @@ Scylla for Developers
:hidden:
learn
CQLSh </getting-started/cqlsh>
cql
Scylla Alternator <alternator/index>
Scylla Features <features>
Scylla Drivers <drivers/index>
@@ -20,8 +18,8 @@ Scylla for Developers
* :doc:`Scylla Drivers </using-scylla/drivers/index>` - Scylla and third-party drivers for CQL and DynamoDB
* :doc:`Scylla Alternator </using-scylla/alternator/index>` - The Open Source DynamoDB-compatible API
* :doc:`Apache Cassandra Query Language (CQL) </getting-started/cql/>` - CQL Reference Guide
* :doc:`CQL Reference </cql/index>` - Reference for the Apache Cassandra Query Language (CQL) and its ScyllaDB extensions
.. panel-box::
:title: Scylla Tools and Resources
@@ -29,7 +27,7 @@ Scylla for Developers
:class: my-panel
* :doc:`Scylla Tools </operating-scylla/admin-tools/index>` - Tools for testing and integrating with Scylla
* :doc:`CQLSh </getting-started/cqlsh>` - Reference for the CQL Shell
* :doc:`cqlsh </cql/cqlsh>` - A command line shell for interacting with ScyllaDB through CQL
.. panel-box::

2
docs/using-scylla/local-secondary-indexes.rst
View File

@@ -114,7 +114,7 @@ More information
................
* :doc:`Global Secondary Indexes </using-scylla/secondary-indexes/>`
* :doc:`CQL Reference </getting-started/secondary-indexes/>` - CQL Reference for Secondary Indexes
* :doc:`CQL Reference </cql/secondary-indexes/>` - CQL Reference for Secondary Indexes
The following courses are available from Scylla University:

4
docs/using-scylla/secondary-indexes.rst
View File

@@ -45,7 +45,7 @@ In the example above:
Example
.......
The following is an example and does not contain all of the options available. To see all of the options available, refer to the :doc:`CQL Reference </getting-started/secondary-indexes>`.
The following is an example and does not contain all of the options available. To see all of the options available, refer to the :doc:`CQL Reference </cql/secondary-indexes>`.
Given the following schema:
@@ -134,7 +134,7 @@ More information
................
* :doc:`Local Secondary Indexes </using-scylla/local-secondary-indexes/>`
* :doc:`CQL Reference </getting-started/secondary-indexes/>` - CQL Reference for Secondary Indexes
* :doc:`CQL Reference </cql/secondary-indexes/>` - CQL Reference for Secondary Indexes
The following courses are available from Scylla University:

2
docs/using-scylla/workload-prioritization.rst
View File

@@ -64,7 +64,7 @@ These commands set, list, and edit the level of service.
Create a Service Level
----------------------
When you create a service level, you allocate a percentage of resources to the service level. Remember to use the correct naming convention to name your service level. If you decide to use :doc:`Reserved Keywords </getting-started/reserved-keywords>`, enclose them in either single or double quotes (for example ``'primary'``).
When you create a service level, you allocate a percentage of resources to the service level. Remember to use the correct naming convention to name your service level. If you decide to use :doc:`Reserved Keywords </cql/reserved-keywords>`, enclose them in either single or double quotes (for example ``'primary'``).
**Syntax**