[CASSANDRA-17918] DESCRIBE output does not quote column names using reserved keywords

• Type: Bug
• Status: Resolved
• Priority: Normal
• Resolution: Fixed
• Fix Version/s: 4.0.10, 4.1.2, 5.0
• Component/s: Legacy/CQL
• Bug Category: Correctness - API / Semantic Implementation
• Severity: Normal
• Complexity: Low Hanging Fruit
• Discovered By: Unit Test
• Platform: All
• Since Version: 4.0.0

Source Control Link

https://github.com/apache/cassandra/commit/75194201f1f06d120f246f6fad025ca5f672943d

Test and Documentation Plan

Submitting fixes for the different branches

• Assignee: Stefan Miklosovic
• Reporter: Yifan Cai

Authors

Stefan Miklosovic

Reviewers

Benjamin Lerer, Yifan Cai

• Created: 22/Sep/22 19:55
• Updated: 11/May/23 16:07
• Resolved: 11/May/23 14:16

Description

The DESCRIBE output of the column names that using reserved keywords are not quoted for UDTs. The following test reproduces. Reading the code, it looks like that the such columns names are not quoted in materialized view, UDF and user defined aggregation. 
The impact of the bug is that schema described cannot be imported due to the usage of reserved keywords as column names. 
 

    @Test
    public void testUsingReservedInCreateType() throws Throwable
    {
        String type = createType(KEYSPACE_PER_TEST, "CREATE TYPE %s (\"token\" text, \"desc\" text);");               assertRowsNet(executeDescribeNet(KEYSPACE_PER_TEST, "DESCRIBE TYPE " + type),
                row(KEYSPACE_PER_TEST, "type", type, "CREATE TYPE " + KEYSPACE_PER_TEST + "." + type + " (\n" +
                        "    \"token\" text,\n" +
                        "    \"desc\" text\n" +
                        ");"));
    } 

Additional information for newcomers:

• Unit tests for DESCRIBE statements are in DescribeStatementTest
• The statement implementation is in DescribeStatement and fetch the create statement from the different schema element using  SchemaElement.toCqlString

Issue Links

• links to: GitHub Pull Request #2308
• links to: GitHub Pull Request #2315
• links to: GitHub Pull Request #2316