From b7683d0eba34d4d72babdbbcf39a48a563ce204e Mon Sep 17 00:00:00 2001 From: Anna Stuchlik Date: Thu, 29 May 2025 15:05:25 +0200 Subject: [PATCH] doc: remove duplicated content 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 --- docs/_utils/redirects.yaml | 5 ++ docs/cql/appendices.rst | 4 +- docs/cql/ddl.rst | 2 +- docs/cql/index.rst | 6 +- docs/cql/non-reserved-keywords.rst | 80 ----------------------- docs/cql/reserved-keywords.rst | 66 ------------------- docs/features/workload-prioritization.rst | 2 +- 7 files changed, 10 insertions(+), 155 deletions(-) delete mode 100644 docs/cql/non-reserved-keywords.rst delete mode 100644 docs/cql/reserved-keywords.rst diff --git a/docs/_utils/redirects.yaml b/docs/_utils/redirects.yaml index 0d1f1a85e6..5f415f837f 100644 --- a/docs/_utils/redirects.yaml +++ b/docs/_utils/redirects.yaml @@ -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 diff --git a/docs/cql/appendices.rst b/docs/cql/appendices.rst index 19d6ae4019..54e8dbe711 100644 --- a/docs/cql/appendices.rst +++ b/docs/cql/appendices.rst @@ -18,8 +18,8 @@ .. highlight:: cql -Appendices ----------- +Reserved CQL Keywords and Types (Appendices) +------------------------------------------------ .. _appendix-A: diff --git a/docs/cql/ddl.rst b/docs/cql/ddl.rst index f576eba338..9631cddeb0 100644 --- a/docs/cql/ddl.rst +++ b/docs/cql/ddl.rst @@ -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 `, enclose them in single or double-quotes. +In all cases, for creating keyspaces and tables, if you are using :ref:`reserved keywords `, enclose them in single or double-quotes. CREATE KEYSPACE ^^^^^^^^^^^^^^^ diff --git a/docs/cql/index.rst b/docs/cql/index.rst index b414769b49..76751244fc 100644 --- a/docs/cql/index.rst +++ b/docs/cql/index.rst @@ -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 ` + * :doc:`Reserved CQL Keywords and Types (Appendices) ` * :doc:`Compaction ` * :doc:`Consistency Levels ` * :doc:`Consistency Levels Calculator` @@ -52,8 +50,6 @@ It allows you to create keyspaces and tables, insert and query tables, and more. * :doc:`Functions ` * :doc:`JSON Support ` * :doc:`Materialized Views ` - * :doc:`Non-Reserved CQL Keywords ` - * :doc:`Reserved CQL Keywords ` ScyllaDB CQL Extensions - CQL Extensions Provided by ScyllaDB -------------------------------------------------------------- diff --git a/docs/cql/non-reserved-keywords.rst b/docs/cql/non-reserved-keywords.rst deleted file mode 100644 index 760d7f6afd..0000000000 --- a/docs/cql/non-reserved-keywords.rst +++ /dev/null @@ -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 diff --git a/docs/cql/reserved-keywords.rst b/docs/cql/reserved-keywords.rst deleted file mode 100644 index 52676cf93a..0000000000 --- a/docs/cql/reserved-keywords.rst +++ /dev/null @@ -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 diff --git a/docs/features/workload-prioritization.rst b/docs/features/workload-prioritization.rst index 7032114380..ce45434788 100644 --- a/docs/features/workload-prioritization.rst +++ b/docs/features/workload-prioritization.rst @@ -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 `, 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 `, enclose them in either single or double quotes (for example ``'primary'``). **Syntax**