sqldelight-check-api/dev.s7a.sqldelight.check.api

Package-level declarations

Types

class DatabaseContext(val name: String, val dialect: SqlDialect)

Lightweight SQLDelight database context visible to rules and reporters.

class Diagnostic(val ruleId: QualifiedRuleId, val severity: Severity, val message: String, val file: SourceFile?, val range: SourceRange?, val database: DatabaseContext?, val fixes: List<Fix> = emptyList())

Diagnostic resolved by the engine and passed to reporters.

DialectId

class DialectId(val id: String)

SQL dialect identifier used by rules and reports without depending on artifact names.

Fix

class Fix(val title: String, val safety: FixSafety, val edits: List<TextEdit>)

A fix proposed by a rule diagnostic.

FixSafety

enum FixSafety : Enum<FixSafety>

Safety classification for a write operation proposed by a rule or formatter.

InternalSqldelightCheckApi

@RequiresOptIn(message = "This API is public for sqldelight-check internals and may change without source compatibility.", level = RequiresOptIn.Level.ERROR)

annotation class InternalSqldelightCheckApi

Marks API that is public only for sqldelight-check module boundaries.

LogLevel

enum LogLevel : Enum<LogLevel>

Controls how much execution detail sqldelight-check should emit.

QualifiedRuleId

class QualifiedRuleId(val ruleSetId: RuleSetId, val ruleId: RuleId)

Identifies a rule after combining a rule set ID and a rule-local ID.

RuleDiagnostic

class RuleDiagnostic(val severity: Severity, val message: String, val file: SourceFile?, val range: SourceRange?, val database: DatabaseContext?, val fixes: List<Fix> = emptyList())

Diagnostic emitted by a rule before the engine attaches the containing rule set.

RuleId

@JvmInline

value class RuleId(val value: String)

Identifies a rule within its containing rule set.

RuleSetId

@JvmInline

value class RuleSetId(val value: String)

Identifies a rule set such as standard or a third-party provider ID.

Severity

enum Severity : Enum<Severity>

Severity assigned to a diagnostic after rule defaults and user configuration are resolved.

SourceFile

class SourceFile(val path: String, val content: String)

Source file known to sqldelight-check.

SourceFileKind

enum SourceFileKind : Enum<SourceFileKind>

SQLDelight source file kind inferred from the file extension.

SourcePosition

class SourcePosition(val line: Int, val column: Int)

One-based source position for diagnostics and edits.

SourceRange

class SourceRange(val start: SourcePosition, val end: SourcePosition)

Source range in a file.

SqlDialect

class SqlDialect(val ids: Set<DialectId> = setOf(DialectId.Unknown), val sourcePatterns: SqlDialectSourcePatterns = SqlDialectSourcePatterns.SourceScannerDefault)

Rule-relevant SQL dialect metadata for a SQLDelight database.

SqlDialectCoordinate

class SqlDialectCoordinate(val group: String, val module: String, val version: String?)

Gradle module coordinate for a SQLDelight dialect artifact.

SqlDialectProvider

fun interface SqlDialectProvider

Resolves rule-relevant dialect metadata for a SQLDelight dialect artifact.

SqlDialectSourceBlockPatterns

class SqlDialectSourceBlockPatterns(statementSeparatorTerms: Set<String> = defaultSqlDialectStatementSeparatorTerms, val parenthesisDepthTerms: Set<SqlDialectSourceParenthesisDepthTerms> = defaultSqlDialectParenthesisDepthTerms, val clauseStartRoles: Set<SqlDialectSourcePatternRole> = defaultSqlDialectClauseStartRoles, val pairedBlocks: Set<SqlDialectSourcePairedBlockPattern> = defaultSqlDialectPairedBlocks, val parenthesizedBlocks: Set<SqlDialectSourceParenthesizedBlockPattern> = defaultSqlDialectParenthesizedBlocks)

Dialect-specific patterns used to derive conservative SQL source blocks.

SqlDialectSourcePairedBlockPattern

class SqlDialectSourcePairedBlockPattern(val startExpression: SqlDialectSourcePatternExpression, val endExpression: SqlDialectSourcePatternExpression, val kind: SqlSourceBlockKind)

A paired source block pattern such as CASE ... END.

SqlDialectSourceParenthesisDepthTerms

class SqlDialectSourceParenthesisDepthTerms(val openTerm: String, val closeTerm: String)

Terms that adjust source parenthesis nesting depth.

SqlDialectSourceParenthesizedBlockPattern

class SqlDialectSourceParenthesizedBlockPattern(val openTerm: String, val closeTerm: String, val defaultKind: SqlSourceBlockKind, val innerStartRoles: Set<SqlDialectSourcePatternRole> = emptySet(), val innerStartKind: SqlSourceBlockKind = defaultKind)

A source block pattern opened and closed by fixed terms.

SqlDialectSourcePattern

class SqlDialectSourcePattern(val expression: SqlDialectSourcePatternExpression, val roles: Set<SqlDialectSourcePatternRole>)

A dialect source pattern and the scanner roles it fulfills.

SqlDialectSourcePatternExpression

class SqlDialectSourcePatternExpression(val parts: List<SqlDialectSourcePatternPart>)

A dialect source pattern expression such as ORDER BY, LEFT [OUTER] JOIN, FETCH {FIRST|NEXT}, or FETCH {FIRST|NEXT} [ROW|ROWS].

SqlDialectSourcePatternPart

class SqlDialectSourcePatternPart(alternatives: Set<String>, val optional: Boolean = false)

One part in a dialect source pattern expression.

SqlDialectSourcePatternRole

interface SqlDialectSourcePatternRole

The source-scanner meaning attached to a dialect pattern.

SqlDialectSourcePatterns

class SqlDialectSourcePatterns(val patterns: Set<SqlDialectSourcePattern> = SourceScannerDefault.patterns, val blockPatterns: SqlDialectSourceBlockPatterns = SqlDialectSourceBlockPatterns.Default)

Dialect-specific source patterns used by conservative source-text scanners.

SqlDialectSourceTerm

interface SqlDialectSourceTerm

A SQL source term that source-text rules may need to recognize directly.

SqlSourceBlock

class SqlSourceBlock(val kind: SqlSourceBlockKind, val startTokenIndex: Int, val endTokenIndex: Int, val startOffset: Int, val endOffset: Int, val statementIndex: Int, val parentBlockIndex: Int?, val sourcePatternMatch: SqlSourcePatternMatch? = null)

A syntactic source block derived from dialect-aware source tokens.

SqlSourceBlockKind

interface SqlSourceBlockKind

The conservative syntactic meaning of a SQL source block.

SqlSourcePatternMatch

class SqlSourcePatternMatch(val pattern: SqlDialectSourcePattern, val length: Int)

A dialect source pattern match that starts at a source token.

SqlSourceStructure

class SqlSourceStructure(val tokens: List<SqlSourceTokenContext>, val blocks: List<SqlSourceBlock>)

Dialect-aware source structure for conservative SQL source scanners.

SqlSourceToken

class SqlSourceToken(val text: String, val startOffset: Int, val endOffset: Int)

A source token used by conservative SQL source scanners.

SqlSourceTokenContext

class SqlSourceTokenContext(val token: SqlSourceToken, val index: Int, val statementIndex: Int, val parenthesisDepth: Int, val caseDepth: Int, val patternMatches: Set<SqlSourcePatternMatch>)

A SQL source token with its surrounding source structure.

TextEdit

class TextEdit(val range: SourceRange, val replacement: String)

Text edit represented as a replacement over a source range.

Functions

skipSqlBracketQuoted

fun String.skipSqlBracketQuoted(start: Int): Int

Returns the offset immediately after a bracket-quoted SQL identifier.

skipSqlQuoted

fun String.skipSqlQuoted(start: Int, quote: Char): Int

Returns the offset immediately after a SQL quoted range that starts at start.

sourcePatterns

fun sourcePatterns(vararg expressions: String, roles: Set<SqlDialectSourcePatternRole>): Set<SqlDialectSourcePattern>

Parses source pattern expressions and attaches roles to each pattern.

withoutExpressions

fun Set<SqlDialectSourcePattern>.withoutExpressions(vararg expressions: String): Set<SqlDialectSourcePattern>

Removes patterns whose expression exactly matches one of expressions.