lang-sql/com.monkopedia.kodemirror.lang.sql

Package-level declarations

Types

class CompletionLevel(idQuote: String, idCaseInsensitive: Boolean)

A tree node used to build the schema-completion hierarchy.

data class DialectSpec(val backslashEscapes: Boolean = false, val hashComments: Boolean = false, val spaceAfterDashes: Boolean = false, val slashComments: Boolean = false, val doubleQuotedStrings: Boolean = false, val doubleDollarQuotedStrings: Boolean = false, val unquotedBitLiterals: Boolean = false, val treatBitsAsBytes: Boolean = false, val charSetCasts: Boolean = false, val plsqlQuotingMechanism: Boolean = false, val operatorChars: String = "*+-%<>!=&|~^/", val specialVar: String = "?", val identifierQuotes: String = "", val caseInsensitiveIdentifiers: Boolean = false, val words: Map<String, Int> = emptyMap())

Spec for an SQL dialect tokenizer configuration.

SqlCompletionConfig

data class SqlCompletionConfig(val dialect: SQLDialect? = null, val schema: SqlSchema? = null, val tables: List<Any>? = null, val schemas: List<Any>? = null, val defaultTable: String? = null, val defaultSchema: String? = null, val upperCaseKeywords: Boolean = false, val keywordCompletion: (String, String) -> Completion? = null)

Configuration for schemaCompletionSource.

SQLDialect

class SQLDialect(dialect: DialectSpec, val language: LRLanguage, val spec: SqlDialectDef)

Represents an SQL dialect with its associated language and tokenizer configuration.

SqlDialectDef

data class SqlDialectDef(val backslashEscapes: Boolean? = null, val hashComments: Boolean? = null, val spaceAfterDashes: Boolean? = null, val slashComments: Boolean? = null, val doubleQuotedStrings: Boolean? = null, val doubleDollarQuotedStrings: Boolean? = null, val unquotedBitLiterals: Boolean? = null, val treatBitsAsBytes: Boolean? = null, val charSetCasts: Boolean? = null, val plsqlQuotingMechanism: Boolean? = null, val operatorChars: String? = null, val specialVar: String? = null, val identifierQuotes: String? = null, val caseInsensitiveIdentifiers: Boolean? = null, val keywords: String? = null, val types: String? = null, val builtin: String? = null)

Definition for an SQL dialect. All fields are optional; missing fields fall back to the default values defined in defaults.

SqlSchema

typealias SqlSchema = Map<String, Any>

A schema definition for SQL autocompletion. Keys are schema/table names, values are either lists of column names (strings or Completion) or nested schema maps.

Properties

Cassandra

val Cassandra: SQLDialect

Dialect for Cassandra's SQL-ish query language.

MariaSQL

val MariaSQL: SQLDialect

Variant of MySQL for MariaDB.

MSSQL

val MSSQL: SQLDialect

SQL dialect for Microsoft SQL Server.

MySQL

val MySQL: SQLDialect

MySQL dialect.

PLSQL

val PLSQL: SQLDialect

PL/SQL dialect.

PostgreSQL

val PostgreSQL: SQLDialect

Dialect for PostgreSQL.

sqlHighlighting

val sqlHighlighting: NodePropSource<Rule>

SQLite

val SQLite: SQLDialect

SQLite dialect.

StandardSQL

val StandardSQL: SQLDialect

The standard SQL dialect.

tokens

val tokens: ExternalTokenizer

The default tokens tokenizer (uses defaults dialect).

Functions

buildKeywords

fun buildKeywords(keywords: String, types: String, builtin: String? = null): Map<String, Int>

Build a keywords lookup map for a dialect.

completeFromSchema

fun completeFromSchema(schema: SqlSchema, tables: List<Any>? = null, schemas: List<Any>? = null, defaultTableName: String? = null, defaultSchemaName: String? = null, dialect: SQLDialect? = null): CompletionSource

Create a completion source from a schema definition.

keywordCompletionSource

fun keywordCompletionSource(dialect: SQLDialect, upperCase: Boolean = false, build: (String, String) -> Completion? = null): CompletionSource

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

schemaCompletionSource

fun schemaCompletionSource(config: SqlCompletionConfig): CompletionSource

Returns a completion source that provides schema-based completion for the given config.

sql

fun sql(config: SqlCompletionConfig = SqlCompletionConfig()): LanguageSupport

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

tokensFor

fun tokensFor(d: DialectSpec): ExternalTokenizer

Create an ExternalTokenizer for the given DialectSpec.