Go to file
Manuel Francisco Naranjo 8ab2e8bb22 Improving API
Renaming View as DbView, in __init__ import all public API
2015-07-28 08:34:06 -03:00
dbview Improving API 2015-07-28 08:34:06 -03:00
.gitignore Initial commit 2015-07-27 15:50:27 -03:00
LICENSE Initial commit 2015-07-27 15:50:27 -03:00
MANIFEST.in Adding MANIFEST.in 2015-07-27 17:00:00 -03:00
README.md Updating docs 2015-07-27 16:59:55 -03:00
setup.py Updating docs 2015-07-27 16:32:49 -03:00

README.md

django-database-view

A simple pluggable application that allows to work with database views.

So far only MySQL is supported as backend, but more could be added if necessary.

Quick start

  1. Add "dbview" to your INSTALLED_APPS settings like this:

    INSTALLED_APPS = (
        ...
        'dbview',
    )
    
  2. In your models.py create classes which extend dbview.models.View like this:

    
    from django.db import models
    from dbview.models import View
    
    class ModelA(models.Model):
        fielda = models.CharField()
        fieldc = models.IntegerField()
    
    class MyView(View):
        fieldA = models.OneToOneField(ModelA, primary_key=True,
            db_column='fielda__id')
        fieldB = models.IntegerField(blank=True, null=True, db_column='fieldb')
    
        @classmethod
        def view(klass):
            '''
            This method returns the SQL string that creates the view, in this
            example fieldB is the result of annotating another column
            '''
            qs = modelA.objects.all().\
                 annotate(fieldb=models.Sum('fieldc')) .\
                 annotate(fielda__id=models.F('pk')) .\
                 order_by('fielda__id') .\
                 values('fielda__id', 'fieldb')
            return str(qs.query)
    
  3. Then create a migration point for your view generation, edit that migration and modify it, add: from dbview.helpers import CreateView and replace the line the call to migrations.CreateModel with CreateView.

  4. Migrate your database and start using your database views.