Upating docs
parent
23a405a6af
commit
c96c6c03bb
65
README.md
65
README.md
|
|
@ -8,50 +8,49 @@ So far only MySQL is supported as backend, but more could be added if necessary.
|
||||||
|
|
||||||
1. Add "dbview" to your INSTALLED_APPS settings like this:
|
1. Add "dbview" to your INSTALLED_APPS settings like this:
|
||||||
|
|
||||||
```python
|
```python
|
||||||
INSTALLED_APPS = (
|
INSTALLED_APPS = (
|
||||||
...
|
...
|
||||||
'dbview',
|
'dbview',
|
||||||
)
|
)
|
||||||
|
```
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
2. In your models.py create classes which extend dbview.models.DbView
|
2. In your models.py create classes which extend dbview.models.DbView
|
||||||
like this:
|
like this:
|
||||||
|
|
||||||
|
|
||||||
```python
|
```python
|
||||||
|
|
||||||
from django.db import models
|
from django.db import models
|
||||||
from dbview.models import DbView
|
from dbview.models import DbView
|
||||||
|
|
||||||
class ModelA(models.Model):
|
class ModelA(models.Model):
|
||||||
fielda = models.CharField()
|
fielda = models.CharField()
|
||||||
fieldc = models.IntegerField()
|
fieldc = models.IntegerField()
|
||||||
|
|
||||||
|
class MyView(DbView):
|
||||||
|
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)
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
class MyView(DbView):
|
|
||||||
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
|
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
|
and modify it, add: `from dbview.helpers import CreateView` and replace the line
|
||||||
the call to `migrations.CreateModel` with `CreateView`.
|
the call to `migrations.CreateModel` with `CreateView`.
|
||||||
|
|
||||||
|
|
||||||
4. Migrate your database and start using your database views.
|
4. Migrate your database and start using your database views.
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue