Skip to main content

SQL for everything. Read, write, delete across any API or database.

Project description

Sidol

GitHub

SQL for everything. Read, write, and delete across any API or database using plain SQL.

  • SELECT → executed through DuckDB (fast, in-memory, federated)
  • INSERT / UPDATE / DELETE → parsed by sqlglot, routed to connector write APIs
  • Built-in connectors: ServiceNow, CSV, SQLite
  • Extensible: implement BaseConnector to add any source

Connector Support

Connector SELECT INSERT UPDATE DELETE Filter Pushdown
ServiceNow
CSV
SQLite
Airtable

See ROADMAP.md for phased delivery (Phase 2 current focus).

import sidol

db = sidol.connect()
db.register("incidents", sidol.ServiceNowConnector(instance="myco", table="incident", ...))
db.register("local",     sidol.SQLiteConnector(path="./data.db"))

tbl = db.sql("SELECT number, state FROM incidents WHERE priority = 1")  # pyarrow.Table
db.sql("UPDATE incidents SET state = 'closed' WHERE number = 'INC001'")

Setup (with uv — recommended)

uv is a fast Python package manager. Install it once, then:

# Install uv (one-time)
# Windows:
winget install --id=astral-sh.uv -e
# macOS/Linux:
curl -LsSf https://astral.sh/uv/install.sh | sh

# Clone & install all dependencies in ~2 seconds
git clone https://github.com/mitayan0/sidol
cd sidol
uv sync

# Run tests
uv run pytest

# Run linter
uv run ruff check sidol/

# Type-check
uv run mypy sidol/

Setup (classic pip)

pip install -e .
pip install pytest pytest-asyncio respx mypy ruff
python -m pytest

Architecture

SQL string
  │
  ├─ SELECT ──→ DuckDB (in-memory) ──→ connector.fetch() per table ──→ DataFrame
  │
  └─ DML ─────→ sqlglot AST ──→ extract table/values/filters ──→ connector.insert/update/delete()

Three layers:

  1. SQL interfacesidol.connect(), db.sql(), db.register()
  2. Routersidol/router.py parses and dispatches
  3. Connectors — pluggable BaseConnector implementations

Writing a Connector

from sidol.connectors.base import BaseConnector
from sidol.types import Schema, Column, Capabilities, WriteResult

class MyConnector(BaseConnector):
    def schema(self) -> Schema:
        return Schema(tables={"mytable": [Column("id", "int", primary_key=True)]})

    def fetch(self, table, columns, filters, limit, offset):
        yield {"id": 1, "name": "hello"}

    def capabilities(self) -> Capabilities:
        return Capabilities(readable=True, insertable=True)

    def insert(self, table, rows) -> WriteResult:
        ...
        return WriteResult(affected_rows=len(rows))

Supported SQL Subset (v1)

Statement Support
SELECT ✅ Full (via DuckDB — JOINs, aggregates, CTEs)
INSERT INTO t (cols) VALUES (...) ✅ Literal values only
UPDATE t SET col=val WHERE ... ✅ Simple equality filters
DELETE FROM t WHERE ... ✅ Simple equality filters
CREATE TABLE ❌ Not supported in v1
Subqueries in DML ❌ Not supported in v1

License

MIT — see LICENSE

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sidol-0.1.3.tar.gz (65.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sidol-0.1.3-py3-none-any.whl (27.3 kB view details)

Uploaded Python 3

File details

Details for the file sidol-0.1.3.tar.gz.

File metadata

  • Download URL: sidol-0.1.3.tar.gz
  • Upload date:
  • Size: 65.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for sidol-0.1.3.tar.gz
Algorithm Hash digest
SHA256 701064aec7c52b08f3478f6829d65bef3b64abb98629bcc39dcdbd91e8c36fed
MD5 356669d91654fd6122886d96c946b7c9
BLAKE2b-256 8ab1e877de7f8cc804ecfeb2b15f511f8e9a299b65469bed78ae8fb2cfcdb4ce

See more details on using hashes here.

Provenance

The following attestation bundles were made for sidol-0.1.3.tar.gz:

Publisher: publish.yml on mitayan0/sidol

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sidol-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: sidol-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 27.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for sidol-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 63abbad091db47277963a685ed049063d965c1fed57e32742e7eda6d867af5ab
MD5 c04799ad71da69962033afa03f208223
BLAKE2b-256 330b451f3c07689d05d4d5414b6c16b07ffc3ef77600c480a654cdc1caa4b2a8

See more details on using hashes here.

Provenance

The following attestation bundles were made for sidol-0.1.3-py3-none-any.whl:

Publisher: publish.yml on mitayan0/sidol

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page