@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://github.com/codemirror/dev/issues) | [**FORUM**](https://discuss.codemirror.net/c/next/) | [**CHANGELOG**](https://github.com/codemirror/lang-sql/blob/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://github.com/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 <dl> <dt id="user-content-sql"> <code><a href="#user-content-sql">sql</a>(<a id="user-content-sql^config" href="#user-content-sql^config">config</a>⁠?: <a href="#user-content-sqlconfig">SQLConfig</a> = {}) → <a href="https://codemirror.net/docs/ref#language.LanguageSupport">LanguageSupport</a></code></dt> <dd>SQL language support for the given SQL dialect, with keyword completion, and, if provided, schema-based completion as extra extensions. </dd> <dt id="user-content-sqlconfig"> <h4> <code>interface</code> <a href="#user-content-sqlconfig">SQLConfig</a></h4> </dt> <dd>Options used to configure an SQL extension. <dl><dt id="user-content-sqlconfig.dialect"> <code><a href="#user-content-sqlconfig.dialect">dialect</a>⁠?: <a href="#user-content-sqldialect">SQLDialect</a></code></dt> <dd>The <a href="#user-content-sqldialect">dialect</a> to use. Defaults to <a href="#user-content-standardsql"><code>StandardSQL</code></a>. </dd><dt id="user-content-sqlconfig.schema"> <code><a href="#user-content-sqlconfig.schema">schema</a>⁠?: <a href="#user-content-sqlnamespace">SQLNamespace</a></code></dt> <dd>You can use this to define the schemas, tables, and their fields for autocompletion. </dd><dt id="user-content-sqlconfig.defaulttable"> <code><a href="#user-content-sqlconfig.defaulttable">defaultTable</a>⁠?: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></dt> <dd>When given, columns from the named table can be completed directly at the top level. </dd><dt id="user-content-sqlconfig.defaultschema"> <code><a href="#user-content-sqlconfig.defaultschema">defaultSchema</a>⁠?: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></dt> <dd>When given, tables prefixed with this schema name can be completed directly at the top level. </dd><dt id="user-content-sqlconfig.uppercasekeywords"> <code><a href="#user-content-sqlconfig.uppercasekeywords">upperCaseKeywords</a>⁠?: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></dt> <dd>When set to true, keyword completions will be upper-case. </dd><dt id="user-content-sqlconfig.keywordcompletion"> <code><a href="#user-content-sqlconfig.keywordcompletion">keywordCompletion</a>⁠?: fn(<a id="user-content-sqlconfig.keywordcompletion^label" href="#user-content-sqlconfig.keywordcompletion^label">label</a>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, <a id="user-content-sqlconfig.keywordcompletion^type" href="#user-content-sqlconfig.keywordcompletion^type">type</a>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>) → <a href="https://codemirror.net/docs/ref#autocomplete.Completion">Completion</a></code></dt> <dd>Can be used to customize the completions generated for keywords. </dd></dl> </dd> <dt id="user-content-sqlnamespace"> <code> type <a href="#user-content-sqlnamespace">SQLNamespace</a> = <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a><<a href="#user-content-sqlnamespace">SQLNamespace</a>> | {self: <a href="https://codemirror.net/docs/ref#autocomplete.Completion">Completion</a>, children: <a href="#user-content-sqlnamespace">SQLNamespace</a>} | readonly (<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a> | <a href="https://codemirror.net/docs/ref#autocomplete.Completion">Completion</a>)[]</code> </dt> <dd>The type used to describe a level of the schema for <a href="#user-content-sqlconfig.schema">completion</a>. Can be an array of options (columns), an object mapping table or schema names to deeper levels, or a <code>{self, children}</code> object that assigns a completion option to use for its parent property, when the default option (its name as label and type <code>"type"</code>) isn't suitable. </dd> <dt id="user-content-sqldialect"> <h4> <code>class</code> <a href="#user-content-sqldialect">SQLDialect</a></h4> </dt> <dd>Represents an SQL dialect. <dl><dt id="user-content-sqldialect.language"> <code><a href="#user-content-sqldialect.language">language</a>: <a href="https://codemirror.net/docs/ref#language.LRLanguage">LRLanguage</a></code></dt> <dd>The language for this dialect. </dd><dt id="user-content-sqldialect.spec"> <code><a href="#user-content-sqldialect.spec">spec</a>: <a href="#user-content-sqldialectspec">SQLDialectSpec</a></code></dt> <dd>The spec used to define this dialect. </dd><dt id="user-content-sqldialect.extension"> <code><a href="#user-content-sqldialect.extension">extension</a>: <a href="https://codemirror.net/docs/ref#state.Extension">Extension</a></code></dt> <dd>Returns the language for this dialect as an extension. </dd><dt id="user-content-sqldialect^define"> <code>static <a href="#user-content-sqldialect^define">define</a>(<a id="user-content-sqldialect^define^spec" href="#user-content-sqldialect^define^spec">spec</a>: <a href="#user-content-sqldialectspec">SQLDialectSpec</a>) → <a href="#user-content-sqldialect">SQLDialect</a></code></dt> <dd>Define a new dialect. </dd></dl> </dd> <dt id="user-content-sqldialectspec"> <h4> <code>type</code> <a href="#user-content-sqldialectspec">SQLDialectSpec</a></h4> </dt> <dd>Configuration for an <a href="#user-content-sqldialect">SQL Dialect</a>. <dl><dt id="user-content-sqldialectspec.keywords"> <code><a href="#user-content-sqldialectspec.keywords">keywords</a>⁠?: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></dt> <dd>A space-separated list of keywords for the dialect. </dd><dt id="user-content-sqldialectspec.builtin"> <code><a href="#user-content-sqldialectspec.builtin">builtin</a>⁠?: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></dt> <dd>A space-separated string of built-in identifiers for the dialect. </dd><dt id="user-content-sqldialectspec.types"> <code><a href="#user-content-sqldialectspec.types">types</a>⁠?: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></dt> <dd>A space-separated string of type names for the dialect. </dd><dt id="user-content-sqldialectspec.backslashescapes"> <code><a href="#user-content-sqldialectspec.backslashescapes">backslashEscapes</a>⁠?: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></dt> <dd>Controls whether regular strings allow backslash escapes. </dd><dt id="user-content-sqldialectspec.hashcomments"> <code><a href="#user-content-sqldialectspec.hashcomments">hashComments</a>⁠?: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></dt> <dd>Controls whether # creates a line comment. </dd><dt id="user-content-sqldialectspec.slashcomments"> <code><a href="#user-content-sqldialectspec.slashcomments">slashComments</a>⁠?: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></dt> <dd>Controls whether <code>//</code> creates a line comment. </dd><dt id="user-content-sqldialectspec.spaceafterdashes"> <code><a href="#user-content-sqldialectspec.spaceafterdashes">spaceAfterDashes</a>⁠?: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></dt> <dd>When enabled <code>--</code> comments are only recognized when there's a space after the dashes. </dd><dt id="user-content-sqldialectspec.doubledollarquotedstrings"> <code><a href="#user-content-sqldialectspec.doubledollarquotedstrings">doubleDollarQuotedStrings</a>⁠?: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></dt> <dd>When enabled, things quoted with "$" are treated as strings, rather than identifiers. </dd><dt id="user-content-sqldialectspec.doublequotedstrings"> <code><a href="#user-content-sqldialectspec.doublequotedstrings">doubleQuotedStrings</a>⁠?: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></dt> <dd>When enabled, things quoted with double quotes are treated as strings, rather than identifiers. </dd><dt id="user-content-sqldialectspec.charsetcasts"> <code><a href="#user-content-sqldialectspec.charsetcasts">charSetCasts</a>⁠?: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></dt> <dd>Enables strings like <code>_utf8'str'</code> or <code>N'str'</code>. </dd><dt id="user-content-sqldialectspec.plsqlquotingmechanism"> <code><a href="#user-content-sqldialectspec.plsqlquotingmechanism">plsqlQuotingMechanism</a>⁠?: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></dt> <dd>Enables string quoting syntax like <code>q'[str]'</code>, as used in PL/SQL. </dd><dt id="user-content-sqldialectspec.operatorchars"> <code><a href="#user-content-sqldialectspec.operatorchars">operatorChars</a>⁠?: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></dt> <dd>The set of characters that make up operators. Defaults to <code>"*+\-%<>!=&|~^/"</code>. </dd><dt id="user-content-sqldialectspec.specialvar"> <code><a href="#user-content-sqldialectspec.specialvar">specialVar</a>⁠?: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></dt> <dd>The set of characters that start a special variable name. Defaults to <code>"?"</code>. </dd><dt id="user-content-sqldialectspec.identifierquotes"> <code><a href="#user-content-sqldialectspec.identifierquotes">identifierQuotes</a>⁠?: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></dt> <dd>The characters that can be used to quote identifiers. Defaults to <code>"\""</code>. </dd><dt id="user-content-sqldialectspec.caseinsensitiveidentifiers"> <code><a href="#user-content-sqldialectspec.caseinsensitiveidentifiers">caseInsensitiveIdentifiers</a>⁠?: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></dt> <dd>Controls whether identifiers are case-insensitive. Identifiers with upper-case letters are quoted when set to false (which is the default). </dd><dt id="user-content-sqldialectspec.unquotedbitliterals"> <code><a href="#user-content-sqldialectspec.unquotedbitliterals">unquotedBitLiterals</a>⁠?: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></dt> <dd>Controls whether bit values can be defined as 0b1010. Defaults to false. </dd><dt id="user-content-sqldialectspec.treatbitsasbytes"> <code><a href="#user-content-sqldialectspec.treatbitsasbytes">treatBitsAsBytes</a>⁠?: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></dt> <dd>Controls whether bit values can contain other characters than 0 and 1. Defaults to false. </dd></dl> </dd> <dt id="user-content-standardsql"> <code><a href="#user-content-standardsql">StandardSQL</a>: <a href="#user-content-sqldialect">SQLDialect</a></code></dt> <dd>The standard SQL dialect. </dd> <dt id="user-content-postgresql"> <code><a href="#user-content-postgresql">PostgreSQL</a>: <a href="#user-content-sqldialect">SQLDialect</a></code></dt> <dd>Dialect for <a href="https://www.postgresql.org">PostgreSQL</a>. </dd> <dt id="user-content-mysql"> <code><a href="#user-content-mysql">MySQL</a>: <a href="#user-content-sqldialect">SQLDialect</a></code></dt> <dd><a href="https://dev.mysql.com/">MySQL</a> dialect. </dd> <dt id="user-content-mariasql"> <code><a href="#user-content-mariasql">MariaSQL</a>: <a href="#user-content-sqldialect">SQLDialect</a></code></dt> <dd>Variant of <a href="#user-content-mysql"><code>MySQL</code></a> for <a href="https://mariadb.org/">MariaDB</a>. </dd> <dt id="user-content-mssql"> <code><a href="#user-content-mssql">MSSQL</a>: <a href="#user-content-sqldialect">SQLDialect</a></code></dt> <dd>SQL dialect for Microsoft <a href="https://www.microsoft.com/en-us/sql-server">SQL Server</a>. </dd> <dt id="user-content-sqlite"> <code><a href="#user-content-sqlite">SQLite</a>: <a href="#user-content-sqldialect">SQLDialect</a></code></dt> <dd><a href="https://sqlite.org/">SQLite</a> dialect. </dd> <dt id="user-content-cassandra"> <code><a href="#user-content-cassandra">Cassandra</a>: <a href="#user-content-sqldialect">SQLDialect</a></code></dt> <dd>Dialect for <a href="https://cassandra.apache.org/">Cassandra</a>'s SQL-ish query language. </dd> <dt id="user-content-plsql"> <code><a href="#user-content-plsql">PLSQL</a>: <a href="#user-content-sqldialect">SQLDialect</a></code></dt> <dd><a href="https://en.wikipedia.org/wiki/PL/SQL">PL/SQL</a> dialect. </dd> <dt id="user-content-keywordcompletionsource"> <code><a href="#user-content-keywordcompletionsource">keywordCompletionSource</a>(<a id="user-content-keywordcompletionsource^dialect" href="#user-content-keywordcompletionsource^dialect">dialect</a>: <a href="#user-content-sqldialect">SQLDialect</a>, <a id="user-content-keywordcompletionsource^uppercase" href="#user-content-keywordcompletionsource^uppercase">upperCase</a>⁠?: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a> = false, <a id="user-content-keywordcompletionsource^build" href="#user-content-keywordcompletionsource^build">build</a>⁠?: fn(<a id="user-content-keywordcompletionsource^build^label" href="#user-content-keywordcompletionsource^build^label">label</a>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, <a id="user-content-keywordcompletionsource^build^type" href="#user-content-keywordcompletionsource^build^type">type</a>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>) → <a href="https://codemirror.net/docs/ref#autocomplete.Completion">Completion</a>) → <a href="https://codemirror.net/docs/ref#autocomplete.CompletionSource">CompletionSource</a></code></dt> <dd>Returns a completion source that provides keyword completion for the given SQL dialect. </dd> <dt id="user-content-schemacompletionsource"> <code><a href="#user-content-schemacompletionsource">schemaCompletionSource</a>(<a id="user-content-schemacompletionsource^config" href="#user-content-schemacompletionsource^config">config</a>: <a href="#user-content-sqlconfig">SQLConfig</a>) → <a href="https://codemirror.net/docs/ref#autocomplete.CompletionSource">CompletionSource</a></code></dt> <dd>Returns a completion sources that provides schema-based completion for the given configuration. </dd> </dl>