README.md

@questdb/sql-grammar

This repository contains an NPM package with list of keywords, functions and constants supported by QuestDB. It is used to build enrich frontend applications to support QuestDB's grammar.

Install

With npm:

npm install @questdb/sql-grammar

or with yarn:

yarn add @questdb/sql-grammar

Usage

Import the package and use the exported values:

import { dataTypes, functions, keywords, constants } from "@questdb/sql-grammar"

These values are useful when configuring some text editor to enable QuestDB syntax highlighting and autocomplete. For example, the QuestDB Web Console is using values exported by this project to augment the autocomplete and syntax highlight of the Monaco text editor.

Other QuestDB Resources

Complete references are available in the Documentation.

Get started

• Docker
• Binaries
• Homebrew

Develop

• Connect
• Insert data
• Query data
• Authenticate

Concepts

• SQL extensions
• Storage model
• Partitions
• Designated timestamp

Support

• Slack Channel

Roadmap

Our roadmap is here

Contribute

QuestDB is an open source project and contributions are always welcome!

Feel free to contribute to this project by forking the repository and submitting pull requests. Please make sure you have read our contributing guide.

If you would like to contribute to QuestDB code database, see core contributing guide