Skip to main content

Django model integration for MoSQL.

Project description

https://travis-ci.org/uranusjr/django-mosql.png?branch=master

Django MoSQL

Do what Django’s ORM can’t, without the danger of raw.

Why?

Short version

Because I want to use raw SQL, but am too lazy to worry about security issues.

Long version

Django’s ORM is cool. And powerful. But ORMs are destined to be leaky, and can’t do everything you wish to. That’s why Django provides raw and extra so that you can roll your own SQL commands if you need to. But with great power comes great responsibility. You lose all the SQL security measures Django provides when you use those methods, and it can be a serious problem unless you are ultra careful.

Enters MoSQL. MoSQL, in a nutshell, is a tool that generates SQL commands automatically from Python function calls. And it takes care of the injection prevention for you. A perfect match with Django’s raw!

All this project does is introduce a Django model manager subclass, and provide an interface to use MoSQL’s function calls instead of writing SQL strings yourself. With some syntax sugar, of course.

How do I use this thing?

(Examples in this section are inspired by this blog post by Baron Schwartz.)

Let’s say you have the following model:

class Fruit(models.Model):
    kind = models.CharField(max_length=10)
    variety = models.CharField(max_length=10)
    price = models.FloatField()

Then you only need to provide a MoManager as one of its model managers. Add djangomosql to your INSTALLED_APPS, and modify the code like this:

from djangomosql.models import MoManager

class Fruit(models.Model):
    kind = models.CharField(max_length=10)
    variety = models.CharField(max_length=10)
    price = models.FloatField()

    objects = MoManager()

And you’ll be able to generate queries like this:

from djangomosql.functions import Min

Fruit.objects.select((Min('price'), 'minprice')).group_by('kind').order_by('-kind')

Which is roughly equivalent to

SELECT fruit.*, MIN(price) as minprice FROM fruit GROUP BY kind ORDER BY kind DESC

Of course, this won’t be of much use if we can only do things Django’s ORM can. With Django MoSQL, you can achieve many funky things, like:

m = Fruit.objects
inner = m.select((Min('price'), 'minprice')).group_by('kind')
p = m.select().as_('f').order_by('f.kind').join(
    inner, 'x', on={'f.kind': 'x.kind', 'f.price': 'x.minprice'}
)

Which can be translated into (again, roughly):

SELECT f.* FROM fruit AS f INNER JOIN (
    SELECT *, MIN(price) as minprice FROM fruit GROUP BY kind
) AS x ON f.kind = x.kind AND f.price = x.minprice

And best of all, you get all the escaping and ORM mapping for free!

LICENSE

BSD 3-cluse license. See the content of file LICENSE.

Developing

To run tests, run python manage.py test inside the test project. You will need django-nose as well as the dependencies.

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

django-mosql-0.5.1.tar.gz (10.3 kB view details)

Uploaded Source

Built Distribution

django_mosql-0.5.1-py3-none-any.whl (13.6 kB view details)

Uploaded Python 3

File details

Details for the file django-mosql-0.5.1.tar.gz.

File metadata

File hashes

Hashes for django-mosql-0.5.1.tar.gz
Algorithm Hash digest
SHA256 bbc17276a46ce281b155bf65474b2476f53746e59426b0fb2ecddf8b5b84d58b
MD5 04f4f7afaee73b9861c0b1947cd8e393
BLAKE2b-256 4e588821f071c94e934e9b58303210f0f4f03251f7207d24eb1e00a9803bee6d

See more details on using hashes here.

File details

Details for the file django_mosql-0.5.1-py3-none-any.whl.

File metadata

File hashes

Hashes for django_mosql-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e1b292268312350641a77c06ea63205e6856e2f07a7b17bbd4e0ade518dcf73c
MD5 ccd773f3927a245ac58a326aa82883a8
BLAKE2b-256 a0194c69f85a714ad62460988a0d26d889527ba9f12fb4c8223298580cdb1220

See more details on using hashes here.

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