OpenParable
Skip to content
← Back to skills

Update Keyword Engine Lists

Testing & Quality
update-keyword-engine-lists

Update Keyword Engine Lists is an Agent Skill for testing & quality published in the ClickHouse/clickhouse-java repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Update ALLOWED_KEYWORD_ALIASES in ClickHouseSqlUtils.java and ENGINE_TO_TABLE_TYPE in DatabaseMetaDataImpl.java from failing test output. Use when StatementSQLTest.testAllowedKeywordAliasesMatchSystemKeywords or DatabaseMetaDataTest.testAllTableEnginesFromSystemTableEnginesAreMapped fails.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/ClickHouse/clickhouse-java/blob/HEAD/.cursor/skills/update-keyword-engine-lists/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/update-keyword-engine-lists, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Update keyword and engine lists from test failures

Files

Keywords: jdbc-v2/src/main/java/com/clickhouse/jdbc/internal/parser/javacc/ClickHouseSqlUtils.java — initAllowedKeywordAliases(), append after the last // Appended comment block.

Engines: jdbc-v2/src/main/java/com/clickhouse/jdbc/metadata/DatabaseMetaDataImpl.java — ENGINE_TO_TABLE_TYPE static block, insert a new group before // Special.

Steps

  1. Parse the failing test message to extract the list of missing items.

  2. For keywords (StatementSQLTest failure — e.g. ["CURSOR", "DETERMINISTIC", ...]): Append a new dated comment + entries at the end of buildKeywordSet(...), after the last existing // Appended block:

    // Appended MM/DD/YYYY
    "KEYWORD1", "KEYWORD2", ...
    

    The previous entry must have a trailing comma. Keep alphabetical order within the new block.

  3. For engines (DatabaseMetaDataTest failure — e.g. [Paimon, PaimonAzure, ...]): Add a new named group before // Special in the static block:

    // <GroupName> (appended MM/DD/YYYY)
    map.put("Engine1", TableType.REMOTE_TABLE.getTypeName());
    

    Choose TableType by analogy:

    • External storage (S3/Azure/HDFS variants, lake formats) → REMOTE_TABLE
    • MergeTree family or local engines → TABLE

Output

After editing, output this git commit command:

git commit -m "jdbc-v2: update <keywords|engines|keywords and engines> in JDBC"