ppsql

ppsql is a preprocessor for SQL files. It expands variables, inlines included files and strips comments before the result is handed over to a database client.

Table of Contents

• Installation
• Usage
• Directives
• Python API
• Development
• License

Installation

pip install ppsql

Usage

ppsql -i path/to/main.sql -o path/to/out.sql

The module can also be executed directly:

python -m ppsql -i path/to/main.sql -o path/to/out.sql

Directives

Every directive is written on its own line and is removed from the output.

A variable is referenced as $name or, when the name touches other characters, as ${name}. Write \$name to keep a dollar sign as it is. Values are looked up in the scope of the file, then in the global scope, which is initialised from the environment and extended by --env and --credential files.

@set table = users

@include queries/columns.sql

select * from ${table};

$ ppsql -i main.sql -o out.sql && cat out.sql
select id, name from users;
select * from users;

Python API

from ppsql import Builder

sql = Builder(entry="main.sql", variables={"table": "users"}).build()

Development

The project is managed by hatch:

hatch run test          # run the test suite
hatch run test-cov      # run the test suite with coverage
hatch run lint:check    # check formatting and lint rules
hatch run lint:fix      # fix formatting and lint rules
hatch run types:check   # run mypy
hatch build             # build the sdist and the wheel

License

ppsql is distributed under the terms of the MIT license.