Skip to content

ROADMAP.md

Latest commit

 

History

History
67 lines (48 loc) · 2.4 KB

ROADMAP.md

File metadata and controls

67 lines (48 loc) · 2.4 KB

excel-dbapi Roadmap

Current line: 0.4.x series (SQL Spec v1.0 — feature freeze) SQL support reference: docs/SQL_SPEC.md

Completed

Core DB-API and Engines

  • PEP 249-compliant ExcelConnection and ExcelCursor
  • Parameter binding with qmark placeholders (?)
  • Openpyxl engine (default) and optional pandas engine
  • Autocommit and snapshot-based rollback semantics
  • Formula injection defense for write operations

SQL Parser and Execution (Implemented)

  • SELECT with projection, expressions, aliases, WHERE, ORDER BY, LIMIT, OFFSET
  • DISTINCT (single-table queries)
  • JOIN support: INNER, LEFT, RIGHT, FULL OUTER, CROSS (including chained JOINs)
  • Aggregation: COUNT, SUM, AVG, MIN, MAX, COUNT(DISTINCT ...)
  • GROUP BY and HAVING
  • Subqueries in WHERE ... [NOT] IN (SELECT ...) (single-column, non-correlated)
  • Compound queries: UNION, UNION ALL, INTERSECT, EXCEPT
  • Expressions: arithmetic (+ - * /) and CASE ... WHEN ... THEN ... ELSE ... END
  • DML: INSERT (single, multi-row, INSERT ... SELECT), UPDATE, DELETE
  • UPSERT: INSERT ... ON CONFLICT ... DO NOTHING / DO UPDATE
  • DDL: CREATE TABLE, DROP TABLE, ALTER TABLE ADD/DROP/RENAME COLUMN

Quality and Delivery

  • Strict mypy configuration and CI validation
  • Broad parser/executor regression coverage
  • Trusted Publisher (OIDC) release flow for PyPI

Stability Focus (Current Priority)

  • SQL syntax freeze: no new SQL syntax additions until v0.5.0
  • Internal architecture improvements (exception hierarchy, parser/validator separation)
  • Test consolidation and coverage hardening
  • Documentation reconciliation with implemented behavior

Future

  • Async-friendly API surface (design investigation)
  • Additional backend options (e.g., Polars-based engine)
  • Performance tuning for large-sheet scans and join-heavy queries
  • Documentation and example expansion around advanced SQL patterns

Explicitly Out of Scope

  • Full ACID transaction guarantees on .xlsx
  • Multi-writer concurrency on the same workbook path
  • Stored procedures, triggers, and foreign key enforcement
  • Full SQL dialect parity with SQLite/PostgreSQL

Documentation Authority