CONTRIBUTING.md

Contributing to QuestDB

The codebase of this project (@questdb/sql-grammar) is trivial, just arrays of strings:

• keywords like select or from
• functions like count or format
• constants like true and false

They represent keywords, functions and constants implemented and supported by QuestDB SQL grammar.

Therefore, it is highly likely that your desired contribution is actually meant for the core QuestDB project. In such case, please refer to the QuestDB contributing guide

Alternatively, you may be interested in the usage of this project:

• QuestDB Web Console uses this project to augment the syntax highlight and intellisense (autocomplete) of the SQL editor
• grafana-datasource project.

Releasing a new version

This project is published to npmjs.com as @questdb/sql-grammar package. To publish a new version:

• update the version property in package.json
• submit a PR with the change
• once the PR is reviewed, approved and merged to master branch, a github action will check if the version in package.json is newer than the latest published version and if so, it will publish the new version to npmjs.com

Support

If you have any questions, please join our Slack Channel and ask away!