IF Commons GitHub

Lang Sql

A small, fast, portable multi-dialect SQL language library: a lexer, a closed syntax tree and a parser for thirty dialects, comments as first-class nodes, and extensions for queries, unist, documentation and PL/pgSQL.

FactValue
Version0.1.4
Conformance levelL1
Distributedgithub, npm
LicensePolyForm-Noncommercial-1.0.0, source-available: free for noncommercial use, commercial use needs a license from the owner (see Licensing in Start here)
Import it as@intellectual-frontiers/lang-sql

Areas

Imports

Core

Imported by

AnyFS Query, AnyFS SQL, Data, Documentation generator, Estate Query, Evidence Capture, GRC, Machine Probe, Mizan, Planning Query, Quality, Repoctl, Telemetry

Specifications

Folders

FolderWhat it isMay import
spec-kit/The library's own specifications, numbered from 0001.nothing: Markdown and TSV
src/The SQL language core (0001-sql-lang): a small, fast, portable front end for SQL in many dialects, published as @intellectual-frontiers/lang-sql. The lexical layer (0001-sql-lang): lex turns text into tokens and comments with exact positions, a dialect (defineDialect) says how it is written, and every comment is kept with its kind, marker, span and place for the features that read them. The syntax tree and the parser (0002-sql-ast-parser): a closed union of nodes whose child fields are typed by sort, parse and parseStrict for the common ground of SQL (queries, data changes, tables, views, indexes) with a dialect's Grammar adding its operators, cast and like-words, a statement that cannot be read kept as an unparsed node while the others are read, each comment attached to its node (commentsOf), and the walks children, walk, findAll and fold. Rewriting, queries and unist (0003-sql-ast-tools): rewriteScript and its kin rewrite a tree from the leaves up by rules for sorts, so a rule cannot return a node of another sort and a rewrite that changes nothing returns its input; the extension extensions/query gives the table of parents, lazy typed selections (select(root).find("table")) and the named analyses tableUses (with the scope of common table expressions), functionsCalled and readOnlyProblem; the extension extensions/unist projects a parse, its comments among the children, to a unist tree that unist-util-visit and unist-util-select read as they read Markdown. The dialects are thirty (athena, bigquery, clickhouse, databricks, doris, dremio, drill, druid, duckdb, dune, exasol, fabric, hive, materialize, mysql, oracle, postgres, presto, redshift, risingwave, singlestore, snowflake, solr, spark, spark2, sqlite, starrocks, teradata, trino, tsql: 0005-sql-dialects); DAX, PRQL and Tableau, which sqlglot reads as dialects, are not SQL (a formula language, a pipeline language and a calculation language) and are not among them. The core is the files of the folder; the dialects are dialects/<name>/ and the extensions will be extensions/<name>/, which may import the core and nothing else here. Quoting, placeholders and a registry of dialects with a catalog of functions (0007-sql-emit): quoteIdent, identifier, quoteString, placeholder and createRegistry, so that a library that builds statements for a dialect, or adds a dialect of its own, writes no quote and no parameter by hand.@intellectual-frontiers/core, by package name, and nothing else
src/aide/The helpers (0010-aide): what gives meaning to the tree or runs it, as pure modules exported as ./aide/<name>: profile (restrict a parse to a subset of the language), catalog (tables and functions, bind, typeOf, check), normalize (simplify, conjuncts), plan (plan, explain, split between a backend and the process), exec (compile to closures with the logic of SQL, run a plan over rows) text (transpile, the sql template, renderDiagnostic), relational (createEngine: a read-only SQL engine over the relations of a Provider: every join and LATERAL, grouping sets, subqueries and quantified comparisons, set operations, window functions, recursive and ordinary common table expressions, dates, times and intervals, the string functions, TABLESAMPLE and SIMILAR TO) and introspect (SQL over the tree: relations, rules as queries, 0008-sql-introspect) and guard (guard, refusal: a text is one statement that only reads, judged by its tree; 0012-sql-guard).the core of src/, by relative path; @intellectual-frontiers/core, by package name
acceptance/Two utilities that are useful in themselves and are the acceptance of the language, of introspection and of aide, and their demos (0011-acceptance): sqlfs searches a file system with SQL in this process and sqlfind compiles the same language to a find command; shared/ holds their dialect, profile and catalog, the fixture tree and the walks; aat.ts, scenarios.ts and demos/ are the automated and user acceptance. Not exported.src/ and aide/, by relative path; node: modules
suite/The tests, the golden files and the corpora of open-source SQL suites with their provenance and licenses.src/, by package name; the test module of commons' runtime, by package name
tools/The trace check bun run verify runs, the benchmark, the golden files and the conformance report.src/, by relative path; the kernel, the runtime and the packer of commons, by package name

Quality

Quality: 170 tests: 170 passed, 0 failed, 0 skipped, 160 of 160 requirements proved, 0 open issues, 0 open tickets. The tests and issues of the library

Titles, headings, exports, tables, columns and requirements. Esc closes.