Briq
/
django-database-view
6
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Updating docs

master
Manuel Francisco Naranjo 2015-07-27 16:12:10 -03:00
parent 85fd2537ef
commit db5d40737f
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.rst
View File

@ -4,6 +4,8 @@ django-database-view
A simple pluggable application that allows to work with database views. 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 Quick start
----------- -----------
@ -14,17 +16,13 @@ Quick start
'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::
.. code-block:: python .. code-block:: python
:caption: models.py
:name: models.py
...
from dbview.models import DbView from dbview.models import DbView
...
class MyView(DbView): class MyView(DbView):
fieldA = models.OneToOneField(modelA, primary_key=True, db_column='fielda__id') fieldA = models.OneToOneField(modelA, primary_key=True, db_column='fielda__id')
fieldB = models.IntegerField(blank=True, null=True, db_column='fieldb') fieldB = models.IntegerField(blank=True, null=True, db_column='fieldb')
@ -42,5 +40,10 @@ like this::
values('fielda__id', 'fieldb') values('fielda__id', 'fieldb')
return str(qs.query) 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 to match: 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.