sqlspec 0.34.0__tar.gz → 0.35.0__tar.gz

sqlspec-0.35.0/.gitignore

@@ -0,0 +1,59 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# folders
+.auto_pytabs_cache/
+.hypothesis/
+.mypy_cache/
+.pytest_cache/
+.venv/
+*.egg-info/
+build/
+dist/
+results/
+site/
+target/
+.idea/
+.vscode/
+.cursor/
+.zed/
+.cache
+.coverage*
+# files
+**/*.so
+**/*.sqlite
+**/*.sqlite*
+*.iml
+.coverage
+.dmypy.json
+.python-version
+.ruff_cache
+/docs/_build/
+coverage.*
+setup.py
+tmp/
+*.log
+.tmp
+.tmp_mypyc
+TODO*
+.env
+tools/*.json
+benchmarks/
+.benchmark
+*.db
+*.db-journal
+*.db-wal
+*.db-shm
+*.duckdb
+.crush
+CRUSH.md
+CLAUDE.md
+AGENTS.md
+docs-build
+.envs/
+.claude/*
+specs/
+.pre-commit-cache
+.gh-cache

sqlspec-0.35.0/.pre-commit-config.yaml

@@ -0,0 +1,53 @@
+default_language_version:
+  python: "3"
+repos:
+  - repo: https://github.com/compilerla/conventional-pre-commit
+    rev: v4.3.0
+    hooks:
+      - id: conventional-pre-commit
+        stages: [commit-msg]
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: check-ast
+      - id: check-case-conflict
+      - id: check-toml
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: "v0.14.11"
+    hooks:
+      - id: ruff
+        args: ["--fix"]
+      - id: ruff-format
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.4.1
+    hooks:
+      - id: codespell
+        additional_dependencies:
+          - tomli
+  - repo: https://github.com/python-formate/flake8-dunder-all
+    rev: v0.5.0
+    hooks:
+      - id: ensure-dunder-all
+        exclude: "test*|tools"
+        args: ["--use-tuple"]
+  - repo: https://github.com/ariebovenberg/slotscheck
+    rev: v0.19.1
+    hooks:
+      - id: slotscheck
+        exclude: "docs|.github"
+  - repo: https://github.com/sphinx-contrib/sphinx-lint
+    rev: "v1.0.2"
+    hooks:
+      - id: sphinx-lint
+        args: ["--jobs", "1"]
+  - repo: local
+    hooks:
+      - id: pypi-readme
+        name: pypi-readme
+        language: python
+        entry: python tools/pypi_readme.py
+        types: [markdown]

sqlspec-0.35.0/CONTRIBUTING.rst

@@ -0,0 +1,78 @@
+Contribution guide
+==================
+
+Setting up the environment
+--------------------------
+
+1. Run ``make install-uv`` to install `uv <https://docs.astral.sh/uv/>`_ if not already installed
+1. Run ``make install`` to install all dependencies and pre-commit hooks
+
+
+Code contributions
+------------------
+
+Workflow
+++++++++
+
+1. `Fork <https://github.com/litestar-org/sqlspec/fork>`_ the `sqlspec repository <https://github.com/litestar-org/sqlspec>`_
+2. Clone your fork locally with git
+3. `Set up the environment <#setting-up-the-environment>`_
+4. Make your changes
+5. Run ``make lint`` to run linters and formatters. This step is optional and will be executed
+   automatically by git before you make a commit, but you may want to run it manually in order to apply fixes
+6. Commit your changes to git
+7. Push the changes to your fork
+8. Open a `pull request <https://docs.github.com/en/pull-requests>`_. Give the pull request a descriptive title
+   indicating what it changes. If it has a corresponding open issue, the issue number should be included in the title as
+   well. For example a pull request that fixes issue ``bug: Increased stack size making it impossible to find needle #100``
+   could be titled ``fix(#100): Make needles easier to find by applying fire to haystack``
+
+.. tip:: Pull requests and commits all need to follow the
+    `Conventional Commit format <https://www.conventionalcommits.org>`_
+
+Guidelines for writing code
+----------------------------
+
+- All code should be fully `typed <https://peps.python.org/pep-0484/>`_. This is enforced via
+  `mypy <https://mypy.readthedocs.io/en/stable/>`_.
+- All code should be tested. This is enforced via `pytest <https://docs.pytest.org/en/stable/>`_.
+- All code should be properly formatted. This is enforced via `black <https://black.readthedocs.io/en/stable/>`_ and `Ruff <https://beta.ruff.rs/docs/>`_.
+
+Logging
+++++++++
+
+- Logger names must follow the ``sqlspec.<module>`` hierarchy.
+- Always obtain loggers via ``sqlspec.utils.logging.get_logger`` to ensure filters are attached.
+- Use static event names in structured logs and include context fields instead of dynamic message strings.
+
+Writing and running tests
++++++++++++++++++++++++++
+
+.. todo:: Write this section
+
+Project documentation
+---------------------
+
+The documentation is located in the ``/docs`` directory and is `ReST <https://docutils.sourceforge.io/rst.html>`_ and
+`Sphinx <https://www.sphinx-doc.org/en/master/>`_. If you're unfamiliar with any of those,
+`ReStructuredText primer <https://www.sphinx-doc.org/en/master/lib/usage/restructuredtext/basics.html>`_ and
+`Sphinx quickstart <https://www.sphinx-doc.org/en/master/lib/usage/quickstart.html>`_ are recommended reads.
+
+Running the docs locally
+++++++++++++++++++++++++
+
+You can serve the documentation with ``make docs-serve``, or build them with ``make docs``.
+
+Creating a new release
+----------------------
+
+1. Increment the version in `pyproject.toml <https://github.com/litestar-org/sqlspec/blob/main/pyproject.toml>`_.
+    .. note:: The version should follow `semantic versioning <https://semver.org/>`_ and `PEP 440 <https://www.python.org/dev/peps/pep-0440/>`_.
+2. `Draft a new release <https://github.com/litestar-org/sqlspec/releases/new>`_ on GitHub
+
+   * Use ``vMAJOR.MINOR.PATCH`` (e.g. ``v1.2.3``) as both the tag and release title
+   * Fill in the release description. You can use the "Generate release notes" function to get a draft for this
+3. Commit your changes and push to ``main``
+4. Publish the release
+5. Go to `Actions <https://github.com/litestar-org/sqlspec/actions>`_ and approve the release workflow
+6. Check that the workflow runs successfully

sqlspec-0.35.0/PKG-INFO

@@ -0,0 +1,207 @@
+Metadata-Version: 2.4
+Name: sqlspec
+Version: 0.35.0
+Summary: SQL Experiments in Python
+Project-URL: Discord, https://discord.gg/litestar
+Project-URL: Issue, https://github.com/litestar-org/sqlspec/issues/
+Project-URL: Source, https://github.com/litestar-org/sqlspec
+Author-email: Cody Fincher <cody@litestar.dev>
+Maintainer-email: Litestar Developers <hello@litestar.dev>
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: <4.0,>=3.10
+Requires-Dist: mypy-extensions
+Requires-Dist: rich-click>=1.9.0
+Requires-Dist: sqlglot>=19.9.0
+Requires-Dist: typing-extensions
+Provides-Extra: adbc
+Requires-Dist: adbc-driver-manager; extra == 'adbc'
+Requires-Dist: pyarrow; extra == 'adbc'
+Provides-Extra: adk
+Requires-Dist: google-adk; extra == 'adk'
+Provides-Extra: aioodbc
+Requires-Dist: aioodbc; extra == 'aioodbc'
+Provides-Extra: aiosqlite
+Requires-Dist: aiosqlite; extra == 'aiosqlite'
+Provides-Extra: alloydb
+Requires-Dist: google-cloud-alloydb-connector; extra == 'alloydb'
+Provides-Extra: asyncmy
+Requires-Dist: asyncmy; extra == 'asyncmy'
+Provides-Extra: asyncpg
+Requires-Dist: asyncpg; extra == 'asyncpg'
+Provides-Extra: attrs
+Requires-Dist: attrs; extra == 'attrs'
+Requires-Dist: cattrs; extra == 'attrs'
+Provides-Extra: bigquery
+Requires-Dist: google-cloud-bigquery; extra == 'bigquery'
+Requires-Dist: google-cloud-storage; extra == 'bigquery'
+Provides-Extra: cli
+Requires-Dist: rich-click>=1.9.0; extra == 'cli'
+Requires-Dist: tomli>=2.0.0; (python_version < '3.11') and extra == 'cli'
+Provides-Extra: cloud-sql
+Requires-Dist: cloud-sql-python-connector; extra == 'cloud-sql'
+Provides-Extra: cockroachdb
+Requires-Dist: asyncpg; extra == 'cockroachdb'
+Requires-Dist: psycopg[binary,pool]; extra == 'cockroachdb'
+Provides-Extra: duckdb
+Requires-Dist: duckdb; extra == 'duckdb'
+Provides-Extra: fastapi
+Requires-Dist: fastapi; extra == 'fastapi'
+Provides-Extra: flask
+Requires-Dist: flask; extra == 'flask'
+Provides-Extra: fsspec
+Requires-Dist: fsspec; extra == 'fsspec'
+Provides-Extra: litestar
+Requires-Dist: litestar; extra == 'litestar'
+Provides-Extra: msgspec
+Requires-Dist: msgspec; extra == 'msgspec'
+Provides-Extra: mypyc
+Provides-Extra: mysql-connector
+Requires-Dist: mysql-connector-python; extra == 'mysql-connector'
+Provides-Extra: nanoid
+Requires-Dist: fastnanoid>=0.4.1; extra == 'nanoid'
+Provides-Extra: obstore
+Requires-Dist: obstore; extra == 'obstore'
+Provides-Extra: opentelemetry
+Requires-Dist: opentelemetry-instrumentation; extra == 'opentelemetry'
+Provides-Extra: oracledb
+Requires-Dist: oracledb; extra == 'oracledb'
+Provides-Extra: orjson
+Requires-Dist: orjson; extra == 'orjson'
+Provides-Extra: pandas
+Requires-Dist: pandas; extra == 'pandas'
+Requires-Dist: pyarrow; extra == 'pandas'
+Provides-Extra: performance
+Requires-Dist: msgspec; extra == 'performance'
+Requires-Dist: sqlglot[rs]; extra == 'performance'
+Provides-Extra: polars
+Requires-Dist: polars; extra == 'polars'
+Requires-Dist: pyarrow; extra == 'polars'
+Provides-Extra: prometheus
+Requires-Dist: prometheus-client; extra == 'prometheus'
+Provides-Extra: psqlpy
+Requires-Dist: psqlpy; extra == 'psqlpy'
+Provides-Extra: psycopg
+Requires-Dist: psycopg[binary,pool]; extra == 'psycopg'
+Provides-Extra: pydantic
+Requires-Dist: pydantic; extra == 'pydantic'
+Requires-Dist: pydantic-extra-types; extra == 'pydantic'
+Provides-Extra: pymssql
+Requires-Dist: pymssql; extra == 'pymssql'
+Provides-Extra: pymysql
+Requires-Dist: pymysql; extra == 'pymysql'
+Provides-Extra: spanner
+Requires-Dist: google-cloud-spanner; extra == 'spanner'
+Provides-Extra: uuid
+Requires-Dist: uuid-utils; extra == 'uuid'
+Description-Content-Type: text/markdown
+
+# SQLSpec
+
+**Type-safe SQL execution layer for Python.**
+
+SQLSpec handles database connectivity and result mapping so you can focus on SQL. Write raw queries when you need precision, use the builder API when you need composability, or load SQL from files when you need organization. Every statement passes through a [sqlglot](https://github.com/tobymao/sqlglot)-powered AST pipeline for validation, dialect conversion, and optimization before execution. Export results as Python objects, Arrow tables, Polars or pandas DataFrames.
+
+It's not an ORM. It's the connectivity and processing layer between your application and your database that provides the right abstraction for each situation without dictating how you write SQL.
+
+## Status
+
+SQLSpec is currently in active development. The public API may change. Follow the [docs](https://sqlspec.dev/) and changelog for updates.
+
+## What You Get
+
+**Connection Management**
+
+- Connection pooling with configurable size, timeout, and lifecycle hooks
+- Sync and async support with a unified API surface
+- Adapters for PostgreSQL (psycopg, asyncpg, psqlpy), SQLite (sqlite3, aiosqlite), DuckDB, MySQL (asyncmy, mysql-connector, pymysql), Oracle, BigQuery, and ADBC-compatible databases
+
+**Query Execution**
+
+- Raw SQL strings with automatic parameter binding and dialect translation
+- SQL AST parsing via sqlglot for validation, optimization, and dialect conversion
+- Builder API for programmatic query construction without string concatenation
+- SQL file loading to keep queries organized alongside your code (named SQL queries)
+- Statement stacks for batching multiple operations with transaction control
+
+**Result Handling**
+
+- Type-safe result mapping to Pydantic, msgspec, attrs, or dataclasses
+- Apache Arrow export for zero-copy integration with pandas, Polars, and analytical tools
+- Result iteration, single-row fetch, or bulk retrieval based on your use case
+
+**Framework Integration**
+
+- Litestar plugin with dependency injection for connections, sessions, and pools
+- Starlette/FastAPI middleware for automatic transaction management
+- Flask extension with sync/async portal support
+
+**Production Features**
+
+- SQL validation and caching via sqlglot AST parsing
+- OpenTelemetry and Prometheus instrumentation hooks
+- Database event channels with native LISTEN/NOTIFY, Oracle AQ, and a portable queue fallback
+- Structured logging with correlation ID support
+- Migration CLI for schema versioning
+
+## Quick Start
+
+### Install
+
+```bash
+pip install "sqlspec"
+```
+
+### Run your first query
+
+```python
+from pydantic import BaseModel
+from sqlspec import SQLSpec
+from sqlspec.adapters.sqlite import SqliteConfig
+
+class Greeting(BaseModel):
+    message: str
+
+spec = SQLSpec()
+db = spec.add_config(SqliteConfig(connection_config={"database": ":memory:"}))
+
+with spec.provide_session(db) as session:
+    greeting = session.select_one(
+        "SELECT 'Hello, SQLSpec!' AS message",
+        schema_type=Greeting,
+    )
+    print(greeting.message)  # Output: Hello, SQLSpec!
+```
+
+That's it. Write SQL, define a schema, get typed objects back. Connection pooling, parameter binding, and result mapping are handled automatically.
+
+See the [Getting Started guide](https://sqlspec.dev/getting_started/) for installation variants, adapter selection, and advanced result mapping options.
+
+## Documentation
+
+- [Getting Started](https://sqlspec.dev/getting_started/)
+- [Usage Guides](https://sqlspec.dev/usage/)
+- [Examples Gallery](https://sqlspec.dev/examples/)
+- [API Reference](https://sqlspec.dev/reference/)
+- [CLI Reference](https://sqlspec.dev/usage/cli.html)
+
+## Reference Applications
+
+- **[PostgreSQL + Vertex AI Demo](https://github.com/cofin/postgres-vertexai-demo)** - Vector search with pgvector and real-time chat using Litestar and Google ADK. Shows connection pooling, migrations, type-safe result mapping, vector embeddings, and response caching.
+- **[Oracle + Vertex AI Demo](https://github.com/cofin/oracledb-vertexai-demo)** - Oracle 23ai vector search with semantic similarity using HNSW indexes. Demonstrates NumPy array conversion, large object (CLOB) handling, and real-time performance metrics.
+
+See the [usage docs](https://sqlspec.dev/usage/) for detailed guides on adapters, configuration patterns, and features like the [SQL file loader](https://sqlspec.dev/usage/loader.html).
+
+## Built With
+
+- **[sqlglot](https://github.com/tobymao/sqlglot)** - SQL parser, transpiler, and optimizer powering SQLSpec's AST pipeline
+
+## Contributing
+
+Contributions, issue reports, and adapter ideas are welcome. Review the
+[contributor guide](https://sqlspec.dev/contributing/) and follow the project
+coding standards before opening a pull request.
+
+## License
+
+SQLSpec is distributed under the MIT License.

sqlspec-0.35.0/README.md

@@ -0,0 +1,109 @@
+# SQLSpec
+
+**Type-safe SQL execution layer for Python.**
+
+SQLSpec handles database connectivity and result mapping so you can focus on SQL. Write raw queries when you need precision, use the builder API when you need composability, or load SQL from files when you need organization. Every statement passes through a [sqlglot](https://github.com/tobymao/sqlglot)-powered AST pipeline for validation, dialect conversion, and optimization before execution. Export results as Python objects, Arrow tables, Polars or pandas DataFrames.
+
+It's not an ORM. It's the connectivity and processing layer between your application and your database that provides the right abstraction for each situation without dictating how you write SQL.
+
+## Status
+
+SQLSpec is currently in active development. The public API may change. Follow the [docs](https://sqlspec.dev/) and changelog for updates.
+
+## What You Get
+
+**Connection Management**
+
+- Connection pooling with configurable size, timeout, and lifecycle hooks
+- Sync and async support with a unified API surface
+- Adapters for PostgreSQL (psycopg, asyncpg, psqlpy), SQLite (sqlite3, aiosqlite), DuckDB, MySQL (asyncmy, mysql-connector, pymysql), Oracle, BigQuery, and ADBC-compatible databases
+
+**Query Execution**
+
+- Raw SQL strings with automatic parameter binding and dialect translation
+- SQL AST parsing via sqlglot for validation, optimization, and dialect conversion
+- Builder API for programmatic query construction without string concatenation
+- SQL file loading to keep queries organized alongside your code (named SQL queries)
+- Statement stacks for batching multiple operations with transaction control
+
+**Result Handling**
+
+- Type-safe result mapping to Pydantic, msgspec, attrs, or dataclasses
+- Apache Arrow export for zero-copy integration with pandas, Polars, and analytical tools
+- Result iteration, single-row fetch, or bulk retrieval based on your use case
+
+**Framework Integration**
+
+- Litestar plugin with dependency injection for connections, sessions, and pools
+- Starlette/FastAPI middleware for automatic transaction management
+- Flask extension with sync/async portal support
+
+**Production Features**
+
+- SQL validation and caching via sqlglot AST parsing
+- OpenTelemetry and Prometheus instrumentation hooks
+- Database event channels with native LISTEN/NOTIFY, Oracle AQ, and a portable queue fallback
+- Structured logging with correlation ID support
+- Migration CLI for schema versioning
+
+## Quick Start
+
+### Install
+
+```bash
+pip install "sqlspec"
+```
+
+### Run your first query
+
+```python
+from pydantic import BaseModel
+from sqlspec import SQLSpec
+from sqlspec.adapters.sqlite import SqliteConfig
+
+class Greeting(BaseModel):
+    message: str
+
+spec = SQLSpec()
+db = spec.add_config(SqliteConfig(connection_config={"database": ":memory:"}))
+
+with spec.provide_session(db) as session:
+    greeting = session.select_one(
+        "SELECT 'Hello, SQLSpec!' AS message",
+        schema_type=Greeting,
+    )
+    print(greeting.message)  # Output: Hello, SQLSpec!
+```
+
+That's it. Write SQL, define a schema, get typed objects back. Connection pooling, parameter binding, and result mapping are handled automatically.
+
+See the [Getting Started guide](https://sqlspec.dev/getting_started/) for installation variants, adapter selection, and advanced result mapping options.
+
+## Documentation
+
+- [Getting Started](https://sqlspec.dev/getting_started/)
+- [Usage Guides](https://sqlspec.dev/usage/)
+- [Examples Gallery](https://sqlspec.dev/examples/)
+- [API Reference](https://sqlspec.dev/reference/)
+- [CLI Reference](https://sqlspec.dev/usage/cli.html)
+
+## Reference Applications
+
+- **[PostgreSQL + Vertex AI Demo](https://github.com/cofin/postgres-vertexai-demo)** - Vector search with pgvector and real-time chat using Litestar and Google ADK. Shows connection pooling, migrations, type-safe result mapping, vector embeddings, and response caching.
+- **[Oracle + Vertex AI Demo](https://github.com/cofin/oracledb-vertexai-demo)** - Oracle 23ai vector search with semantic similarity using HNSW indexes. Demonstrates NumPy array conversion, large object (CLOB) handling, and real-time performance metrics.
+
+See the [usage docs](https://sqlspec.dev/usage/) for detailed guides on adapters, configuration patterns, and features like the [SQL file loader](https://sqlspec.dev/usage/loader.html).
+
+## Built With
+
+- **[sqlglot](https://github.com/tobymao/sqlglot)** - SQL parser, transpiler, and optimizer powering SQLSpec's AST pipeline
+
+## Contributing
+
+Contributions, issue reports, and adapter ideas are welcome. Review the
+[contributor guide](https://sqlspec.dev/contributing/) and follow the project
+coding standards before opening a pull request.
+
+## License
+
+SQLSpec is distributed under the MIT License.