sql-formatter-org / sql-formatter-org/sql-formatter

db2i formatting does not work with JSON* functions

Open
#773 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug db2
Dominant language
TypeScript
Stars
2.9k
Forks
456
Avg merge
3d 4h
Merged PRs (30d)
3

Description

Describe the bug
JSON_OBJECT, JSON_ARRAY, JSON_ARRAGG, etc do not work with this plugin

Expected behavior
I expect these statements to be formatted

Actual behavior
The plugin returns a parse error

Usage
You can reproduce the issue on IBMi systems db2i:

SELECT JSON_OBJECT('key':'val') FROM SYSIBM.SYSDUMMY1;

To return complex JSON objects from DB2i, it's not uncommon to have a lot of JSON_OBJECTS and ARRAY, ARRAYAGG nested.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the supplied JSON_OBJECT query in the formatter using the DB2i dialect, then trace the parse error through the SQL parsing and formatting entry points. The work is done when JSON_OBJECT, JSON_ARRAY, JSON_ARRAYAGG, and nested uses are formatted without a parse error, with regression coverage for the reported statement.

Written by the indexing model from the issue text.

Assessment

Tech stack
sql, typescript
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.