Django 多数据库配置与路由指南

Cora
Cora
发布时间:2026-10-12 | 1人浏览过
原创

本文详解如何在 Django 项目中配置多个数据库连接,通过 DATABASE_ROUTERS 和 DATABASE_APPS_MAPPING 实现不同 APP 对指定数据库的读写路由。涵盖 settings 配置、路由类编写、模型 app_label 指定及 migrate 命令使用,确保数据表准确创建至目标数据库。

在 Django 项目中,一个工程包含多个 APP 应用是常见场景。若需让不同的 APP 连接不同的数据库,则必须建立并配置多个数据库连接。

1. 修改项目的 settings 配置

在 settings.py 文件中配置需要连接的多个数据库连接串。

DATABASES = {
  'default': {
    'ENGINE': 'django.db.backends.sqlite3',
    'NAME': os.path.join(BASE_DIR, 'sqlite3'),
  },
  'db01': {
    'ENGINE': 'django.db.backends.sqlite3',
    'NAME': os.path.join(BASE_DIR, 'db_01'),
  },
  'db02': {
    'ENGINE': 'django.db.backends.sqlite3',
    'NAME': os.path.join(BASE_DIR, 'db_02'),
  },
}

假设当前项目使用 3 个数据库:一个 default 默认库,以及 db01 和 db02。

2. 设置数据库的路由规则方法

在 settings.py 中配置 DATABASE_ROUTERS 以指定路由处理类。

DATABASE_ROUTERS = ['Prject.database_router.DatabaseAppsRouter']

Project:指代建立的 Django 项目名称(project_name)。

database_router:定义路由规则的 Python 文件名,该文件名可根据需要自定义。

DatabaseAppsRouter:路由规则对应的类名称,该类需在 database_router.py 文件中定义。

3. 设置 APP 对应的数据库路由表

需明确每个 APP 连接的数据库,并在 settings.py 中进行如下配置:

DATABASE_APPS_MAPPING = {
  # example:
  # 'app_name':'database_name',
  'app02': 'db02',
  'app01': 'db01',
  'admin': 'db01',
  'auth': 'db01',
  'contenttypes': 'db01',
  'sessions': 'db01',
}

上述配置中的 app01 和 app02 为项目中的 APP 名称,分别映射到 db01 和 db02 数据库。

为使 Django 自带的表(如 admin, auth, contenttypes, sessions)也创建到指定的数据库中,需将其映射到设定库;若不指定,这些表将自动创建到默认(default)数据库中。

4. 创建数据库路由规则

在项目工程根路径下(与 settings.py 同级)创建 database_router.py 文件。

from django.conf import settings
DATABASE_MAPPING = settings.DATABASE_APPS_MAPPING
class DatabaseAppsRouter(object):
  """
  A router to control all database operations on models for different
  databases.
  In case an app is not set in settings.DATABASE_APPS_MAPPING, the router
  will fallback to the `default` database.
  Settings example:
  DATABASE_APPS_MAPPING = {'app1': 'db1', 'app2': 'db2'}
  """
  def db_for_read(self, model, **hints):
    """"Point all read operations to the specific database."""
    if model._meta.app_label in DATABASE_MAPPING:
      return DATABASE_MAPPING[model._meta.app_label]
    return None
  def db_for_write(self, model, **hints):
    """Point all write operations to the specific database."""
    if model._meta.app_label in DATABASE_MAPPING:
      return DATABASE_MAPPING[model._meta.app_label]
    return None
  def allow_relation(self, obj1, obj2, **hints):
    """Allow any relation between apps that use the same database."""
    db_obj1 = DATABASE_MAPPING.get(obj1._meta.app_label)
    db_obj2 = DATABASE_MAPPING.get(obj2._meta.app_label)
    if db_obj1 and db_obj2:
      if db_obj1 == db_obj2:
        return True
      else:
        return False
    return None
  def allow_syncdb(self, db, model):
    """Make sure that apps only appear in the related database."""
    if db in DATABASE_MAPPING.values():
      return DATABASE_MAPPING.get(model._meta.app_label) == db
    elif model._meta.app_label in DATABASE_MAPPING:
      return False
    return None
  def allow_migrate(self, db, app_label, model=None, **hints):
    """
    Make sure the auth app only appears in the 'auth_db'
    database.
    """
    if db in DATABASE_MAPPING.values():
      return DATABASE_MAPPING.get(app_label) == db
    elif app_label in DATABASE_MAPPING:
      return False
    return None

5. Models 创建样例

在各 APP 中创建数据表模型时,必须指定表的 app_label 名称;若不指定,表将创建到 default 配置的数据库中。

具体示例如下:

在 app01 下创建 models:

class Users(models.Model):
  name = models.CharField(max_length=50)
  passwd = models.CharField(max_length=100)
  def __str__(self):
    return "app01 %s " % self.name
  class Meta:
    app_label = "app01"

在 app02 下创建 models:

class Users(models.Model):
  username = models.CharField(max_length=100)
  password = models.CharField(max_length=50)
  age = models.IntegerField()
  def __str__(self):
    return "app02 %s" % self.username
  class Meta:
    app_label = "app02"
class Book(models.Model):
  user = models.ForeignKey("Users", on_delete=models.CASCADE)
  bookname = models.CharField(max_length=100)
  def __str__(self):
    return "%s: %s" % (self.user.username, self.bookname)
  class Meta:
    app_label = "app02"

在 app03 创建 models 时未指定 app_label,因此将创建到 default 数据库中。

class Users(models.Model):  
  username = models.CharField(max_length=100)

6. 生成数据表

使用 Django 的 migrate 命令创建生成表时,需添加 --database 参数;若不添加,未指定 app_label 的 APP 中的表将创建到 default 指定的数据库中。

将 app01 下 models 中的表创建到 db01 的数据库“db_01”中:

./ manage.py migrate --database=db01    

将 app02 下 models 中的表创建到 db02 的数据库“db_02”中:

./ manage.py migrate --database=db02

将 app03 下 models 中的表创建到 default 的数据库“sqlite3”中:

./ manage.py migrate

完成上述创建后,其余所有的创建、查询、删除等操作即可按普通方式执行,无需再使用类似 的方式操作。

models.User.objects.using(dbname).all() 

以上操作即可完成配置。

以上这篇 Django 多数据库配置教程就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持本站。

本站声明

本文内容仅供参考,不代表本站观点。转载或引用请注明出处。如发现内容问题,请通过联系我们页面反馈。

Python 相关产品和应用

全部下载

专题列表