mirrors/scylladb
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: remove duplicated content

Browse Source 
This commit removes the Non-Reserved CQL Keywords and Reserved CQL Keywords pages-keyword
as that content is already covered on the Appendices page.
Redirections are added to avoid 404s for the removed pages.

In addition, the Appendices page title is extended with "Reserved CQL Keywords and Types"
to help users understand what those appendices are about.

Fixes https://github.com/scylladb/scylladb/issues/24319

Closes scylladb/scylladb#24320
This commit is contained in:
Anna Stuchlik
2025-05-29 15:05:25 +02:00
committed by Botond Dénes
parent ee6d7c6ad9
commit b7683d0eba
7 changed files with 10 additions and 155 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/_utils/redirects.yaml
View File

@@ -6,6 +6,11 @@
/master/upgrade/upgrade-guides/upgrade-guide-from-2024.x-to-2025.1/upgrade-guide-from-2024.x-to-2025.1.html: https://docs.scylladb.com/manual/stable/upgrade/index.html
/master/upgrade/upgrade-guides/upgrade-guide-from-6.2-to-2025.1/index.html: https://docs.scylladb.com/manual/stable/upgrade/index.html
# Remove duplicate pages
/stable/cql/non-reserved-keywords.html: /stable/cql/appendices.html
/stable/cql/reserved-keywords.html: /stable/cql/appendices.html
# Remove reduntant pages
/stable/getting-started/tutorials: https://docs.scylladb.com/stable/get-started/develop-with-scylladb/tutorials-example-projects.html

4
docs/cql/appendices.rst
View File

@@ -18,8 +18,8 @@
.. highlight:: cql
Appendices
----------
Reserved CQL Keywords and Types (Appendices)
------------------------------------------------
.. _appendix-A:

2
docs/cql/ddl.rst
View File

@@ -88,7 +88,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 </cql/reserved-keywords>`, enclose them in single or double-quotes.
In all cases, for creating keyspaces and tables, if you are using :ref:`reserved keywords <appendix-A>`, enclose them in single or double-quotes.
CREATE KEYSPACE
^^^^^^^^^^^^^^^

6
docs/cql/index.rst
View File

@@ -20,8 +20,6 @@ CQL Reference
wasm
json
mv
non-reserved-keywords
reserved-keywords
describe-schema
service-levels
cql-extensions.md
@@ -39,7 +37,7 @@ 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:`Reserved CQL Keywords and Types (Appendices) </cql/appendices>`
* :doc:`Compaction </cql/compaction>`
* :doc:`Consistency Levels </cql/consistency>`
* :doc:`Consistency Levels Calculator</cql/consistency-calculator>`
@@ -52,8 +50,6 @@ It allows you to create keyspaces and tables, insert and query tables, and more.
* :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
--------------------------------------------------------------

80
docs/cql/non-reserved-keywords.rst
View File

@@ -1,80 +0,0 @@
Non-Reserved CQL Keywords
=========================
CQL distinguishes between reserved and non-reserved keywords.
Non-reserved keywords only have meaning in their particular area of context and can be used as an identifier. The following keywords are non-reserved:
* AGGREGATE
* ALL
* AS
* ASCII
* BIGINT
* BLOB
* BOOLEAN
* CALLED
* CLUSTERING
* COMPACT
* CONTAINS
* COUNT
* COUNTER
* CUSTOM
* DATE
* DECIMAL
* DISTINCT
* DOUBLE
* EXISTS
* FILTERING
* FINALFUNC
* FLOAT
* FROZEN
* FUNCTION
* FUNCTIONS
* HASHED
* INET
* INITCOND
* INPUT
* INT
* JSON
* KEY
* KEYS
* KEYSPACES
* LANGUAGE
* LIST
* LOGIN
* MAP
* NOLOGIN
* NOSUPERUSER
* OPTIONS
* PASSWORD
* PASSWORDS
* PERMISSION
* PERMISSIONS
* RETURNS
* ROLE
* ROLES
* SFUNC
* SMALLINT
* STATIC
* STORAGE
* STYPE
* SUPERUSER
* TEXT
* TIME
* TIMESTAMP
* TIMEUUID
* TINYINT
* TRIGGER
* TTL
* TUPLE
* TYPE
* USER
* USERS
* UUID
* VALUES
* VARCHAR
* VARINT
* VECTOR
* WRITETIME
.. include:: /rst_include/apache-copyrights.rst

66
docs/cql/reserved-keywords.rst
View File

@@ -1,66 +0,0 @@
Reserved CQL Keywords
=====================
CQL distinguishes between reserved and non-reserved keywords.
Reserved keywords cannot be used as identifiers. They are truly reserved for the language (but one can enclose a reserved keyword by single or double-quotes to use it as an identifier). The following keywords are reserved:
* ADD
* ALLOW
* ALTER
* AND
* APPLY
* ASC
* AUTHORIZE
* BATCH
* BEGIN
* BY
* COLUMNFAMILY
* CREATE
* DELETE
* DESC
* DESCRIBE
* DROP
* ENTRIES
* EXECUTE
* FROM
* FULL
* GRANT
* IF
* IN
* INDEX
* INFINITY
* INSERT
* INTO
* KEYSPACE
* LIMIT
* MODIFY
* NAN
* NORECURSIVE
* NOT
* NULL
* OF
* ON
* OR
* ORDER
* PRIMARY
* RENAME
* REPLACE
* REVOKE
* SCHEMA
* SELECT
* SET
* TABLE
* TO
* TOKEN
* TRUNCATE
* UNLOGGED
* UPDATE
* USE
* USING
* VIEW
* WHERE
* WITH
.. include:: /rst_include/apache-copyrights.rst

2
docs/features/workload-prioritization.rst
View File

@@ -60,7 +60,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 </cql/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 :ref:`reserved keywords <appendix-A>`, enclose them in either single or double quotes (for example ``'primary'``).
**Syntax**