Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sripathikrishnan/jinjasql
Template Language for SQL with Automatic Bind Parameter Extraction
https://github.com/sripathikrishnan/jinjasql
python sql template-language
Last synced: about 2 months ago
JSON representation
Template Language for SQL with Automatic Bind Parameter Extraction
- Host: GitHub
- URL: https://github.com/sripathikrishnan/jinjasql
- Owner: sripathikrishnan
- License: mit
- Created: 2016-10-24T08:36:50.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-04-10T05:05:19.000Z (5 months ago)
- Last Synced: 2024-07-10T09:54:24.833Z (2 months ago)
- Topics: python, sql, template-language
- Language: Python
- Homepage:
- Size: 74.2 KB
- Stars: 806
- Watchers: 24
- Forks: 88
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES
- License: LICENSE
Awesome Lists containing this project
README
# Generate SQL Queries using a Jinja Template, without worrying about SQL Injection #
[](https://github.com/sripathikrishnan/jinjasql/actions)
JinjaSQL is a template language for SQL statements and scripts.
Since it's based in [Jinja2](http://jinja.pocoo.org/),
you have all the power it offers - conditional statements, macros,
looping constructs, blocks, inheritance, and many more.
JinjaSQL automatically binds parameters that are inserted into the template.
After JinjaSQL evaluates the template, you get:
1. A Query with %s placeholders for the parameters
2. A List of values corresponding to the placeholders that need to be bound to the query
JinjaSQL doesn't actually execute the query - it only prepares the
query and the bind parameters. You can execute the query using any
database engine / driver you are working with.
For example, if you have a template like this -
```sql
select username, sum(spend)
from transactions
where start_date > {{request.start_date}}
and end_date < {{request.end_date}}
{% if request.organization %}
and organization = {{request.organization}}
{% endif %}
```
then, depending on the parameters you provide, you get a query
```sql
select username, sum(spend)
from transaction
where start_date > %s
and end_date < %s
and organization = %s
```
with bind parameters = ['2016-10-10', '2016-10-20', 1321]
If `request.organization` was empty/falsy, the corresponding and clause
would be absent from the query, and the list of bind parameters
would not have the organization id.
## When to use JinjaSQL ##
JinjaSQL is *not* meant to replace your ORM. ORMs like those provided
by SQLAlchemy or Django are great for a variety of use cases, and should
be the default in most cases. But there are a few use cases where
you really need the power of SQL.
Use JinjaSQL for -
1. Reporting, business intelligence or dashboard like use cases
1. When you need aggregation/group by
1. Use cases that require data from multiple tables
1. Migration scripts & bulk updates that would benefit from macros
In all other use cases, you should reach to your ORM
instead of writing SQL/JinjaSQL.
While JinjaSQL can handle insert/update statements, you are better off
using your ORM to handle such statements. JinjaSQL is mostly meant
for dynamic select statements that an ORM cannot handle as well.
## Basic Usage ##
First, import the `JinjaSql` class and create an object. `JinjaSql` is thread-safe, so you can safely create one object at startup and use it everywhere.
```python
from jinjasql import JinjaSql
j = JinjaSql()
```
Next, create your template query. You can use the full power of Jinja templates over here - macros, includes, imports, if/else conditions, loops, filters and so on. You can load the template from a file or from database or wherever else Jinja supports.
```python
template = """
SELECT project, timesheet, hours
FROM timesheet
WHERE user_id = {{ user_id }}
{% if project_id %}
AND project_id = {{ project_id }}
{% endif %}
"""
```
Create a context object. This object is a regular dictionary, and can contain nested dictionaries, lists or objects. The template query is evaluated against this context object.
```python
data = {
"project_id": 123,
"user_id": u"sripathi"
}
```
Finally, call the `prepare_query` method with the template and the context. You get back two things:
1. `query` is the generated SQL query. Variables are replaced by %s
1. `bind_params` is an array of parameters corresponding to the %s
```python
query, bind_params = j.prepare_query(template, data)
```
This is the query that is generated:
```python
expected_query = """
SELECT project, timesheet, hours
FROM timesheet
WHERE user_id = %s
AND project_id = %s
"""
```
And these are the bind parameters:
```python
self.assertEquals(bind_params, [u'sripathi', 123])
self.assertEquals(query.strip(), expected_query.strip())
```
You can now use the query and bind parameters to execute the query. For example, in django, you would do something like this:
```python
from django.db import connection
with connection.cursor() as cursor:
cursor.execute(query, bind_params)
for row in cursor.fetchall():
# do something with the results
pass
```
## Multiple Param Styles ##
Per [PEP-249](https://www.python.org/dev/peps/pep-0249/), bind parameters can be specified in multiple ways.
You can pass the optional constructor argument `param_style` to control
the style of query parameter.
1. **format** : `... where name = %s`. This is the default
1. **qmark** : `where name = ?`
1. **numeric** : `where name = :1 and last_name = :2`
1. **named** : `where name = :name and last_name = :last_name`
1. **pyformat** : `where name = %(name)s and last_name = %(last_name)s`
1. **asyncpg** : `where name = $1 and last_name = $2`. This is not part of PEP-249 standard, but is used by [asyncpg library for postgres](https://magicstack.github.io/asyncpg/current/usage.html)
Here's how it works -
```python
j = JinjaSql(param_style='named')
query, bind_params = j.prepare_query(template, data)
```
If param_style is `named` or `pyformat`, `bind_parameters` will be a python dictionary. For all other param styles, it will be a list.
In case of `named` and `pyformat`, remember the following:
1. `prepare_query` returns a dictionary instead of a list
1. The returned dictionary is flat, and only contains keys that are actually used in the query
1. The keys in the dictionary and in the query are guaranteed to have unique names. Even if you bind the same parameter twice, the key will be renamed
## Handling In Clauses ##
If you bind a list or tuple in query, JinjaSQL will raise
a `MissingInClauseException`. JinjaSQL needs manual intervention - you have to apply the `|inclause` filter.
```sql
select 'x' from dual
where project_id in {{ project_ids | inclause }}
```
Notice that you don't need to enclose in parantheses.
JinjaSQL will automatically create the appropriate number of bind expressions.
## SQL Safe Strings ##
Sometimes, you want to insert dynamic table names/column names. By default, JinjaSQL will convert them to bind parameters. This won't work, because table and column names are usually not allowed in bind
parameters.
In such cases, you can use the `|sqlsafe` filter.
```sql
select {{column_names | sqlsafe}} from dual
```
If you use `sqlsafe`, it is your responsibility to ensure there is no sql injection.
## Installing jinjasql ##
Pre-Requisites :
1. python 2.7.x, 3.4.x or 3.5.x
2. jinja2 >= version 2.5
To install from PyPI (recommended) :
pip install jinjasql
To install from source :
git clone https://github.com/sripathikrishnan/jinjasql
cd jinjasql
sudo python setup.py install
## How does JinjaSQL work? ##
### The bind filter ###
At it's core, JinjaSQL provides a filter called `bind`. This filter gobbles up whatever value is provided, and always emits the placeholder string %s. The actual value is then stored in a thread local list of bind parameters.
```python
jinja.prepare_query("select * from user where id = {{userid | bind}}",
{userid: 143})
```
When this code is evaluated, the output query is `select * from user where id = %s`.
### Pre-processing the Query Template ###
Manually applying the `bind` filter to every parameter is error-prone. Sooner than later, a developer will miss the filter, and it will lead to SQL Injection.
JinjaSQL automatically applies the bind filter to ALL variables. The query template is transformed before it is evaluated.
```sql
select * from user where id = {{userid}}
```
becomes
```sql
select * from user where id = {{userid | bind}}
```
Jinja lets extensions to [rewrite the token stream](http://jinja.pocoo.org/docs/dev/extensions/#jinja2.ext.Extension.filter_stream). JinjaSQL looks for `variable_begin` and `variable_end` tokens in the stream, and rewrites the stream to include the `bind` filter as the last filter.
### Autoescape and JinjaSQL ###
Jinja has an autoescape feature. If turned on, it automatically HTML escapes variables. It does this by wrapping strings using the `Markup` class.
JinjaSQL builds on this functionality. JinjaSQL requires autoescape to be turned on. As a result, strings that are injected are wrapped using the Markup class. JinjaSQL uses this wrapper class as well to prevent double-binding of parameters.
## License
jinjasql is licensed under the MIT License. See [LICENSE](https://github.com/sripathikrishnan/jinjasql/blob/master/LICENSE)
## Developer Notes
JinjaSQL runs tests against a variety of databases and database drivers. It uses the testcontainers project to launch databases in docker containers.
To setup your development environment and run the tests on an ubuntu machine:
```bash
sudo apt-get install gcc g++ python3-dev unixodbc unixodbc-dev
pip install -r requirements.txt
python run_tests
```