django-db-multitenant 0.3.2

1. 安装

安装django-db-multitenant（或将它添加到您的setup.py中）。

$ pip install django-db-multitenant

2. 实现映射器

您必须实现一个db_multitenant.mapper的子类，它从请求中确定数据库名称和缓存前缀。

为了帮助您编写映射器，仓库中包含了映射器示例，这些示例从URL中提取主机名以确定租户名称（例如，在https://foo.example.com/bar/中，foo将是租户名称）

• MySQL映射器，它直接使用主机名的一部分作为数据库名称。

• PostgreSQL映射器，它使用主机名的一部分作为搜索路径（模式）。PostgreSQL允许复杂的设置，例如共享公共表（例如，公共账户），请参阅映射器中的注释以获取更多详细信息。

• Redis映射器，它使用主机名查找租户，如果未识别则抛出404。

请随意复制一个示例映射器到您的项目中，然后调整它以满足您的需求。

3. 更新settings.py

通过指定您的实现的全限定路径来设置多租户映射器（在此示例中，mapper是文件mapper.py的名称）

MULTITENANT_MAPPER_CLASS = 'myapp.mapper.TenantMapper'

将多租户中间件作为列表中的第一个中间件（在Django 1.10之前，您必须使用MIDDLEWARE_CLASSES设置）

MIDDLEWARE = [
    'db_multitenant.middleware.MultiTenantMiddleware',
    ....
]

更改您的数据库后端为多租户包装器

DATABASES = {
    'default': {
        'ENGINE': 'db_multitenant.db.backends.mysql',
        'NAME': 'devnull',
    }
}

注意：对于MySQL，NAME是无用的，但由于当前的限制，必须存在命名的数据库。它可以空且只读。

或者对于PostgreSQL

DATABASES = {
    'default': {
        'ENGINE': 'db_multitenant.db.backends.postgresql',
        'NAME': 'mydb',
    }
}

可选地，将多租户辅助函数KEY_FUNCTION添加到您的缓存定义中，这将导致缓存键以mapper.get_cache_prefix的值作为前缀

CACHES = {
  'default' : {
        'LOCATION': '127.0.0.1:11211',
        'BACKEND': 'django.core.cache.backends.memcached.MemcachedCache',
        'KEY_FUNCTION': 'db_multitenant.cache.helper.multitenant_key_func'
    }
}

4. 测试

如果您的应用程序的租户名称是从URL中提取的（如提供的映射器示例所示），您可以在/etc/hosts中添加一个主机，如foo.example.com，将其重定向到您的本地主机服务器。

您应该将 foo.example.com 添加到 Django 设置中的 ALLOWED_HOSTS 列表，并尝试通过浏览器使用 http://foo.example.com:8000 访问您的应用程序。

映射器的示例提供了有关创建租户区域的方法信息。

优点

• 兼容性：您的 Django 应用程序不需要对多租户有意识。数据库级别的工具（如 mysqldump 或 pgdump）只需正常工作。

• 隔离：一个租户一个数据库，这意味着租户数据不会相互混合（除非您与 PostgreSQL 共享表）。

• 简洁：您的应用程序模式不需要包含“租户”外键关系。

• 应该与 Django 1.6 连接持久性和连接池很好地工作。

局限性

• 非正统。Django 不期望这种动态数据库连接的篡改，可能存在意外的错误。

• 隔离有限。由于所有租户都使用相同的 DB 凭证，映射器（或应用程序中的任何其他地方）中的错误可能导致数据损坏。

• 仍然需要在 settings.DATABASE 中指定有效的数据库，以便在首次与 MySQL 建立连接时使用（这最终应该得到修复）。

• 开销：请求可能增加一个额外的查询（MySQL 的 USE <db_name> 语句或 PostgreSQL 的 SET search_path TO <tenant_name>）。