Registry / database / sql-autocomplete-parsers

sql-autocomplete-parsers

library1.22.0jsnpmunverified

Provides autocompletion and error highlighting for various SQL dialects such as ClickHouse, PostgreSQL, MySQL, and others. Current stable version is 1.22.0, with active development. It uses Jison grammar files to generate parsers and ships TypeScript types. Key differentiators: multi-dialect support, extensible architecture, and custom parser extensions for autocomplete logic. Released under Apache-2.0.

database

npm install sql-autocomplete-parsers

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · SQL-AUTOCOMPLETE-P

sql-autocomplete-parsers

databasejavascriptv1.22.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

AutocompleteParser

✓ import { AutocompleteParser } from 'sql-autocomplete-parsers'

✗ const AutocompleteParser = require('sql-autocomplete-parsers').AutocompleteParser

Default export is not available; named export only.

parse

✓ import { parse } from 'sql-autocomplete-parsers'

Parses SQL and returns autocomplete suggestions and errors.

AutocompleteResult

✓ import type { AutocompleteResult } from 'sql-autocomplete-parsers'

TypeScript type for the result object.

Initialize parser for ClickHouse dialect and get autocomplete suggestions for a partial SQL query.

import { AutocompleteParser, parse } from 'sql-autocomplete-parsers'; async function main() { const parser = new AutocompleteParser({ dialect: 'clickhouse' }); await parser.init(); const result = parse(parser, 'SELECT * FROM ', 14); console.log(result.suggestions); } main().catch(console.error);

Debug

Known issues

breakingParser generation must be run with 'npm run generate' before using the library

fix

Run 'npm run generate' in your project if you need to build parsers

affects: >=1.0

gotchaDefault export does not exist; only named exports are available

fix

Use import { ... } from 'sql-autocomplete-parsers'

affects: >=1.0

Errors

Common errors & fixes

Error: Cannot find module './generated/clickhouseAutocompleteParser'

Parser generation not run before import

fix

Run 'npm run generate' to generate parser files

TypeError: AutocompleteParser is not a constructor

Using default import instead of named import

fix

Use 'import { AutocompleteParser } from 'sql-autocomplete-parsers''

Error: Dialect 'mysql' not supported

Unsupported dialect name

fix

Use one of supported dialects: 'clickhouse', 'postgres', etc.

Upgrade

Version history

1.22.0latest on npm

Audit

Dependencies

jisonrequiredGrammar compiler used to generate parsers

Agent activity

18 hits · last 30 days

node