[QUEUED scylla next] doc: add index.rst for the cql folder and add it to toctree

0 views
Skip to first unread message

Commit Bot

<bot@cloudius-systems.com>
unread,
Jul 20, 2022, 10:28:40 AM7/20/22
to scylladb-dev@googlegroups.com, Anna Stuchlik
From: Anna Stuchlik <anna.s...@scylladb.com>
Committer: Anna Stuchlik <anna.s...@scylladb.com>
Branch: next

doc: add index.rst for the cql folder and add it to toctree

---
diff --git a/docs/cql/index.rst b/docs/cql/index.rst
--- a/docs/cql/index.rst
+++ b/docs/cql/index.rst
@@ -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>`
diff --git a/docs/index.rst b/docs/index.rst
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -174,6 +174,7 @@
getting-started/index
operating-scylla/index
using-scylla/index
+ cql/index
architecture/index
troubleshooting/index
kb/index

Commit Bot

<bot@cloudius-systems.com>
unread,
Jul 21, 2022, 4:24:05 AM7/21/22
to scylladb-dev@googlegroups.com, Anna Stuchlik
From: Anna Stuchlik <anna.s...@scylladb.com>
Committer: Anna Stuchlik <anna.s...@scylladb.com>
Branch: master
Reply all
Reply to author
Forward
0 new messages