Skip to main content

Generate application artifacts from documented SQL code

Project description

PyPI version CircleCI Maintainability Test Coverage


Generates application artifacts from documented SQL code.

Use Cases

Use cases for this library include but are not limited to:

  • Automatic generation of human-friendly documentation of SQL excerpts.
  • Automatic generation of application-level bindings (Learn more).
  • Instrumentation of test code to extend coverage analysis to SQL excerpts.

Getting Started

pip install voxsql

Basic Concepts

voxsql works on annotated SQL files. Annotations are provided as Javadoc-like comments, and only properly framed SQL segments are considered by the library when parsing files. Below is an example:

 * Adds a contact to the database.
 * @dialect postgresql
 * @name add_contact
 * @param contact_name: string - the target contact's name
 * @retmode record
 * @retval name: string
    insert into contacts (name)
    values (%(contact_name)s)
    returning name

Save the snippet above to sample.sql to run the examples below.

CLI Usage

To digest the SQL file above using the CLI:

voxsql sample.sql

For more information run voxsql --help.

Direct Library Usage

Below is an example on how you can manipulate the file above using the Python library directly:

from voxsql import parse
frames = parse(open('sample.sql').read())
assert frames[0] == 'add_contact'
assert frames[0].body.source.startswith('insert into contacts')

Design Goals and Inspiration

voxsql strives to promote SQL as a first-class language within application-centric projects.

As opposed to ORMs, voxsql does not try to encapsulate SQL within higher-level application-level abstractions, nor does it try to rewrite or adapt provided SQL for greater portability. The premise here is that directly writing and maintaing SQL code has some interesting advantages, such as a lower barrier to the usage of more advanced SQL features, easier inspection of queries, and the possibility to reduce application footprint and complexity. It is a fair statement to assume voxsql promotes simplicity at the cost of flexibility.

Some of the typically recognized drawbacks of a SQL-heavy design, like the lack of query composability, the difficulty to promote code reuse, and the lack of cross-engine portability are not voxsql's focus, and for that reason, it is considered unsuitable for projects that really need to support an unpredictably complex persistence layer, which might not be as representative of current reality as common sense assumes to be the case these days.

Here are a few projects that promote SQL for application development in slightly different ways:

  • HugSQL: DSL-based SQL-bindings generation for Clojure
  • Yesql: DSL-based SQL-bindings generation for Clojure
  • anosql: inspired by Yesql, for Python.

Listed below are references to material that positively influenced ideas contained in voxsql:


This is how you run tests locally:

make test.start.d


  • Automate exception handling by means of a new @error tag.
  • Raise spec mismatch during execution
  • Add support to @retmode columns
  • Add support to @retmode column
  • Add support to mandatory/optional parameter annotation
  • Solve design question about passing default column values as parameters
  • Solve design question about skipping reseting columns to avoid select-before-update issue
  • Add support to @dialect sqlite
  • Add support to @dialect mysql
  • Add support to @dialect xyz:version
  • Add sphinx docs
  • Add cli command for lanching the interpreter with bindings preloaded.

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

voxsql-0.1.3.tar.gz (7.1 kB view hashes)

Uploaded source

Built Distribution

voxsql-0.1.3-py3-none-any.whl (9.1 kB view hashes)

Uploaded py3

Supported by

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