Skip to main content

Handle database views. Allow to create migrations for database views. View migrations using django code. They can be reversed. Changes in model view definition are detected automatically. Support almost all options as regular makemigrations command

Project description

django-db-views

License
PyPi
Django Versions 2.2 to 5.1+
Python Versions 3.9 to 3.13

How to install?

  • pip install django-db-views

What we offer

  • Database views
  • Materialized views
  • views schema migrations
  • indexing for materialized views (future)
  • database table function (future)

How to use?

  • add django_db_views to INSTALLED_APPS
  • use makeviewmigrations command to create migrations for view models

How to create view in your database?

  • To create your view use DBView class, remember to set view definition attribute.

     from django.db import models
     from django_db_views.db_view import DBView
     
     
     class VirtualCard(models.Model):
         ...
     
     
     class Balance(DBView):
    
         virtual_card = models.ForeignKey(
             VirtualCard,  # VirtualCard is a regular Django model. 
             on_delete=models.DO_NOTHING, related_name='virtual_cards'
         )
         total_discount = models.DecimalField(max_digits=12, decimal_places=2)
         total_returns = models.DecimalField(max_digits=12, decimal_places=2)
         balance = models.DecimalField(max_digits=12, decimal_places=2)
         
         view_definition = """
             SELECT
                 row_number() over () as id,  # Django requires column called id
                 virtual_card.id as virtual_card_id,
                 sum(...) as total_discount,
             ...
         """
     
         class Meta:
             managed = False  # Managed must be set to False!
             db_table = 'virtual_card_balance'
    
  • The view definition can be: str/dict or a callable which returns str/dict.

    Callable view definition examples:

     from django_db_views.db_view import DBViewl
    
     class ExampleView(DBView):
         @staticmethod
         def view_definition():
             #  Note for MySQL users:
             #    In the case of MySQL you might have to use: 
             #    connection.cursor().mogrify(*queryset.query.sql_with_params()).decode() instead of str method to get valid sql statement from Query.
             return str(SomeModel.objects.all().query)  
    
         # OR
         view_definition = lambda: str(SomeModel.objects.all().query)
         class Meta:
             managed = False 
             db_table = 'example_view'
    

    using callable allow you to write view definition using ORM.

  • Ensure that you include managed = False in the DBView model's Meta class to prevent Django creating it's own migration.

How view migrations work?

  • DBView working as regular django model. You can use it in any query.
  • It's using Django code, view-migrations looks like regular migrations.
  • It relies on db_table names.
  • makeviewmigrations command finds previous migration for view.
    • if there is no such migration then script create a new migration
    • if previous migration exists but no change in view_definition is detected nothing is done
    • if previous migration exists, then script will use previous view_definition for backward operation, and creates new migration.
    • when run it will check if the current default engine definined in django.settings is the same engine the view was defined with

Multidatabase support

Yoy can define view_definition as a dict for multiple engine types.

If you do not pass in an engine and have a str or callable the engine will be defaulted to the default database defined in django.

It respects --database flag in the migrate command, So you are able to define a specific view definitions for specific databases using the engine key. If the key do not match your current database, view migration will be skipped.

Also, feature becomes useful if you use a different engine for local / dev / staging / production.

Example dict view definition:

view_definition = {
    "django.db.backends.sqlite3": """
        SELECT
            row_number() over () as id,
            q.id as question_id,
            count(*) as total_choices
        FROM question q
        JOIN choice c on c.question_id = q.id
        GROUP BY q.id
    """,
    "django.db.backends.postgresql": """
        SELECT
            row_number() over () as id,
            q.id as question_id,
            count(*) as total_choices
        FROM question q
        JOIN choice c on c.question_id = q.id
        GROUP BY q.id
    """,
}

Materialized Views

Just inherit from DBMaterializedView instead of regular DBView

Materialzied View provide an extra class method to refresh view called refresh

Notes

Please use the newest version. version 0.1.0 has backward incompatibility which is solved in version 0.1.1 and higher.

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_db_views-0.1.11.tar.gz (10.9 kB view details)

Uploaded Source

Built Distribution

django_db_views-0.1.11-py2.py3-none-any.whl (16.9 kB view details)

Uploaded Python 2Python 3

File details

Details for the file django_db_views-0.1.11.tar.gz.

File metadata

  • Download URL: django_db_views-0.1.11.tar.gz
  • Upload date:
  • Size: 10.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.0

File hashes

Hashes for django_db_views-0.1.11.tar.gz
Algorithm Hash digest
SHA256 2dbaa9750437b01bb3160664d376ffcd82a4f311c940f99e2314ec739d79e266
MD5 60f8b565403b59d3ec4a7d4db4297a2a
BLAKE2b-256 0c43f08aaf347c677f9329d080a35dd2e56dcff444d7efecf938c0372daeb86a

See more details on using hashes here.

File details

Details for the file django_db_views-0.1.11-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_db_views-0.1.11-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 8d4fa06075edd1587f1ceaefe22b6fbc54c3ff79f6ba57622cffa6b090e3d193
MD5 2b3a2863dcd78ba438677809582dd33b
BLAKE2b-256 23e35b5d1d357ebac04b73ea86ea95fdbe9780eb5086f95437201391ec1c0cbf

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page