[ WEBSITE | ISSUES | FORUM | CHANGELOG ]
This package implements SQL language support for the CodeMirror code editor.
The project page has more information, a number of examples and the documentation.
This code is released under an MIT license.
We aim to be an inclusive, welcoming community. To make that explicit, we have a code of conduct that applies to communication around the project.
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.
sql(configâ ?: SQLConfig = {}) â LanguageSupport
SQL language support for the given SQL dialect, with keyword completion, and, if provided, schema-based completion as extra extensions.
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.
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.
static define(spec: SQLDialectSpec) â SQLDialect
Define a new dialect.
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.
Controls whether # creates a line comment.
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 "\""
.
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
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.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4