https://github.com/mavriq/django-dbrouter

Simple and usable database router for django
https://github.com/mavriq/django-dbrouter

database django

Last synced: 9 months ago
JSON representation

Simple and usable database router for django

• Host: GitHub
• URL: https://github.com/mavriq/django-dbrouter
• Owner: mavriq
• Created: 2018-08-30T15:00:35.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2022-04-06T12:31:00.000Z (about 4 years ago)
• Last Synced: 2025-08-26T08:20:25.455Z (10 months ago)
• Topics: database, django
• Language: Python
• Homepage:
• Size: 17.6 KB
• Stars: 7
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
[[_TOC_]]

# Description

Set of simple and usable database routers for django applitaions

## dbrouter.DbByAppRouter

`dbrouter.DbByAppRouter` allows you to specify django-applications or models, that will work with this database.

## dbrouter.RestrictMigrations

`dbrouter.RestrictMigrations` allows you to specify a database to which you can not apply migrations.

For example, with read-only access.

## dbrouter.parse_database_url

`dbrouter.parse_database_url` allows you to specify a database connection as one string

# Example

```python

from dbrouter import parse_database_url

# ...

INSTALLED_APPS = [

    ...

    'some_app',

    'other_app',

]

...

DATABASES = {

    'default': {

        'ENGINE': 'django.db.backends.sqlite3',

        'NAME': 'db.sqlite3',

    },

    # 'dbrouter.DbByAppRouter' usage example

    'external': {

        'NAME': 'some_other',

        .....

        'applications': [

            'some_app',                 #  all models on some_app

            'other_app.OnlyThisModel',  #  OnlyThisModel on other_app

        ],

    },

    # 'dbrouter.RestrictMigrations' usage example

    'some_read_only_external_database': {

        'NAME': 'some_read_only_external_database',

        .....

        'allow_migrate': False,

        # False - disable migrations

        # True - do not disable migrations

        # None - default

    },

    'some_db_added_by_url': parse_database_url(

        # DB in remoge PostgreSQL-server on some schema

        'psql://user:pass@remote.db.host/dbname?options=-c search_path=some_schema',

        applications=['some_new_app'],

        allow_migrate=False)

}

...

DATABASE_ROUTERS = [

    'dbrouter.DbByAppRouter',

    'dbrouter.RestrictMigrations',

    ...

]

```