confluentinc/ksql

Make `key` are reserved key word

Open

#6,896 opened on Jan 25, 2021

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Java (5,739 stars) (1,048 forks)batch import
enhancementfix-it-weekgood first issuestreaming-engine

Description

Atm, key is not a reserved key word in ksqlDB. Thus users could use it as a name for streams/tables/columns etc. We should add key as a reserved key word though to make sure we can use it if we evolve the language further.

Contributor guide

Tech stack
javasqlkafka
Domain
backenddatabase
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic knowledge of ksqlDB SQL syntaxUnderstanding of parser generators (e.g., ANTLR)Java development experience
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Look into the ksqlDB grammar file, likely a .g4 file in the parser module (e.g., src/main/antlr4/io/confluent/ksql/parser/), to see how other reserved keywords are defined. Add 'key' to the list of reserved keywords. Ensure that existing queries using 'key' as an identifier are properly handled or deprecated. The issue has no comments or PRs, so the implementation is open.