# @codemirror/lang-sql > SQL language support for the CodeMirror code editor Latest version **6.10.0** (published 2025-09-16) · MIT license · 0 weekly downloads ## Install ```sh npm install @codemirror/lang-sql pnpm add @codemirror/lang-sql yarn add @codemirror/lang-sql bun add @codemirror/lang-sql ``` ## Health **Score 50/100 (C)** — status: stable. Positive: has types; esm support; no vulnerabilities; high quality score. Warnings: low downloads. Negative: stale. ## Facts | | | |---|---| | Version | 6.10.0 | | Published | 2025-09-16 | | First published | 2020-12-29 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Dependencies | 6 | | Unpacked size | 142.7 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 101 | | Author | Marijn Haverbeke | | Maintainers | adrianheine, marijn | | Keywords | editor, code | ## Links - npm: https://www.npmjs.com/package/@codemirror/lang-sql - Repository: https://github.com/codemirror/lang-sql - Homepage: https://github.com/codemirror/lang-sql#readme - Issues: https://github.com/codemirror/lang-sql/issues - npm.io page: https://npm.io/package/@codemirror/lang-sql ## Dependencies (6) - [@lezer/lr](https://npm.io/package/@lezer/lr.md) ^1.0.0 - [@lezer/common](https://npm.io/package/@lezer/common.md) ^1.2.0 - [@lezer/highlight](https://npm.io/package/@lezer/highlight.md) ^1.0.0 - [@codemirror/state](https://npm.io/package/@codemirror/state.md) ^6.0.0 - [@codemirror/language](https://npm.io/package/@codemirror/language.md) ^6.0.0 - [@codemirror/autocomplete](https://npm.io/package/@codemirror/autocomplete.md) ^6.0.0 ## Alternatives - [flatbuffers](https://npm.io/package/flatbuffers.md) — 6.0M weekly downloads - [jwt-simple](https://npm.io/package/jwt-simple.md) — 259.5K weekly downloads - [@exodus/patch-broken-hermes-typed-arrays](https://npm.io/package/@exodus/patch-broken-hermes-typed-arrays.md) — 28.5K weekly downloads - [@native-to-anchor/buffer-layout](https://npm.io/package/@native-to-anchor/buffer-layout.md) — 12.2K weekly downloads - [binary-parser-encoder](https://npm.io/package/binary-parser-encoder.md) — 5.3K weekly downloads ## Recent versions - 6.10.0 (latest) — 2025-09-16 - 6.9.1 — 2025-07-28 - 6.9.0 — 2025-05-30 - 6.8.0 — 2024-10-01 - 6.7.1 — 2024-08-21 - 6.7.0 — 2024-06-24 - 6.6.5 — 2024-06-17 - 6.6.4 — 2024-05-04 - 6.6.3 — 2024-04-08 - 6.6.2 — 2024-03-23 - 6.6.1 — 2024-03-04 - 6.6.0 — 2024-02-29 - 6.5.5 — 2023-12-28 - 6.5.4 — 2023-08-10 - 6.5.3 — 2023-08-05 - … 25 more at https://npm.io/package/@codemirror/lang-sql/versions ## README **This repository has moved to https://code.haverbeke.berlin/codemirror/lang-sql** # @codemirror/lang-sql [![NPM version](https://img.shields.io/npm/v/@codemirror/lang-sql.svg)](https://www.npmjs.org/package/@codemirror/lang-sql) [ [**WEBSITE**](https://codemirror.net/) | [**ISSUES**](https://code.haverbeke.berlin/codemirror/dev/issues) | [**FORUM**](https://discuss.codemirror.net/) | [**CHANGELOG**](https://code.haverbeke.berlin/codemirror/lang-sql/src/branch/main/CHANGELOG.md) ] This package implements SQL language support for the [CodeMirror](https://codemirror.net/) code editor. The [project page](https://codemirror.net/) has more information, a number of [examples](https://codemirror.net/examples/) and the [documentation](https://codemirror.net/docs/). This code is released under an [MIT license](https://code.haverbeke.berlin/codemirror/lang-sql/tree/main/LICENSE). We aim to be an inclusive, welcoming community. To make that explicit, we have a [code of conduct](http://contributor-covenant.org/version/1/1/0/) that applies to communication around the project. ## Usage ```javascript import {EditorView, basicSetup} from "codemirror" import {sql} from "@codemirror/lang-sql" const view = new EditorView({ parent: document.body, doc: `select * from users where age > 20`, extensions: [basicSetup, sql()] }) ``` Use `sql({dialect: PostgreSQL})` or similar to select a specific SQL dialect. ## API Reference
sql(config⁠?: SQLConfig = {}) → LanguageSupport

SQL language support for the given SQL dialect, with keyword completion, and, if provided, schema-based completion as extra extensions.

interface SQLConfig

Options used to configure an SQL extension.

dialect⁠?: SQLDialect

The dialect to use. Defaults to StandardSQL.

schema⁠?: SQLNamespace

You can use this to define the schemas, tables, and their fields for autocompletion.

defaultTable⁠?: string

When given, columns from the named table can be completed directly at the top level.

defaultSchema⁠?: string

When given, tables prefixed with this schema name can be completed directly at the top level.

upperCaseKeywords⁠?: boolean

When set to true, keyword completions will be upper-case.

keywordCompletion⁠?: fn(label: string, type: string) → Completion

Can be used to customize the completions generated for keywords.

type SQLNamespace = Object<SQLNamespace> | {self: Completion, children: SQLNamespace} | readonly (string | Completion)[]

The type used to describe a level of the schema for completion. Can be an array of options (columns), an object mapping table or schema names to deeper levels, or a {self, children} object that assigns a completion option to use for its parent property, when the default option (its name as label and type "type") isn't suitable.

class SQLDialect

Represents an SQL dialect.

language: LRLanguage

The language for this dialect.

spec: SQLDialectSpec

The spec used to define this dialect.

extension: Extension

Returns the language for this dialect as an extension.

configureLanguage(options: ParserConfig, name⁠?: string) → SQLDialect

Reconfigure the parser used by this dialect. Returns a new dialect object.

static define(spec: SQLDialectSpec) → SQLDialect

Define a new dialect.

type SQLDialectSpec

Configuration for an SQL Dialect.

keywords⁠?: string

A space-separated list of keywords for the dialect.

builtin⁠?: string

A space-separated string of built-in identifiers for the dialect.

types⁠?: string

A space-separated string of type names for the dialect.

backslashEscapes⁠?: boolean

Controls whether regular strings allow backslash escapes.

hashComments⁠?: boolean

Controls whether # creates a line comment.

slashComments⁠?: boolean

Controls whether // creates a line comment.

spaceAfterDashes⁠?: boolean

When enabled -- comments are only recognized when there's a space after the dashes.

doubleDollarQuotedStrings⁠?: boolean

When enabled, things quoted with "$" are treated as strings, rather than identifiers.

doubleQuotedStrings⁠?: boolean

When enabled, things quoted with double quotes are treated as strings, rather than identifiers.

charSetCasts⁠?: boolean

Enables strings like _utf8'str' or N'str'.

plsqlQuotingMechanism⁠?: boolean

Enables string quoting syntax like q'[str]', as used in PL/SQL.

operatorChars⁠?: string

The set of characters that make up operators. Defaults to "*+\-%<>!=&|~^/".

specialVar⁠?: string

The set of characters that start a special variable name. Defaults to "?".

identifierQuotes⁠?: string

The characters that can be used to quote identifiers. Defaults to "\"". Add [ for MSSQL-style bracket quoted identifiers.

caseInsensitiveIdentifiers⁠?: boolean

Controls whether identifiers are case-insensitive. Identifiers with upper-case letters are quoted when set to false (which is the default).

unquotedBitLiterals⁠?: boolean

Controls whether bit values can be defined as 0b1010. Defaults to false.

treatBitsAsBytes⁠?: boolean

Controls whether bit values can contain other characters than 0 and 1. Defaults to false.

StandardSQL: SQLDialect

The standard SQL dialect.

PostgreSQL: SQLDialect

Dialect for PostgreSQL.

MySQL: SQLDialect

MySQL dialect.

MariaSQL: SQLDialect

Variant of MySQL for MariaDB.

MSSQL: SQLDialect

SQL dialect for Microsoft SQL Server.

SQLite: SQLDialect

SQLite dialect.

Cassandra: SQLDialect

Dialect for Cassandra's SQL-ish query language.

PLSQL: SQLDialect

PL/SQL dialect.

keywordCompletionSource(dialect: SQLDialect, upperCase⁠?: boolean = false, build⁠?: fn(label: string, type: string) → Completion) → CompletionSource

Returns a completion source that provides keyword completion for the given SQL dialect.

schemaCompletionSource(config: SQLConfig) → CompletionSource

Returns a completion sources that provides schema-based completion for the given configuration.

--- _Source: https://npm.io/package/@codemirror/lang-sql · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._