dj-database-url 2.2.0

支持的数据库

目前支持PostgreSQL、PostGIS、MySQL、MySQL (GIS)、Oracle、Oracle (GIS)、Redshift、CockroachDB、Timescale、Timescale (GIS)和SQLite。

安装

安装很简单

$ pip install dj-database-url

用法

1. 如果DATABASES已经定义

• 在settings.py中从DATABASE_URL配置数据库

  import dj_database_url
  
  DATABASES['default'] = dj_database_url.config(
      conn_max_age=600,
      conn_health_checks=True,
  )

• 提供默认值

  DATABASES['default'] = dj_database_url.config(
      default='postgres://...',
      conn_max_age=600,
      conn_health_checks=True,
  )

• 解析任意数据库URL

  DATABASES['default'] = dj_database_url.parse(
      'postgres://...',
      conn_max_age=600,
      conn_health_checks=True,
  )

2. 如果DATABASES未定义

• 在settings.py中从DATABASE_URL配置数据库

  import dj_database_url
  
  DATABASES = {
      'default': dj_database_url.config(
          conn_max_age=600,
          conn_health_checks=True,
      ),
  }

• 您可以提供一个默认值，如果DATABASE_URL设置未定义，则使用该默认值

  DATABASES = {
      'default': dj_database_url.config(
          default='postgres://...',
          conn_max_age=600,
          conn_health_checks=True,
      )
  }

• 解析任意数据库URL

  DATABASES = {
      'default': dj_database_url.parse(
          'postgres://...',
          conn_max_age=600,
          conn_health_checks=True,
      )
  }

conn_max_age 设置 CONN_MAX_AGE 配置，该配置告诉 Django 在请求之间持久化数据库连接，最多保持指定秒数。如果您不提供值，它将遵循 Django 的默认值 0。为了性能考虑，建议设置该值。

conn_health_checks 设置 CONN_HEALTH_CHECKS 配置（自 Django 4.1 以来新增），该配置告诉 Django 在每个请求开始时检查持久化的连接是否仍然有效。如果您不提供值，它将遵循 Django 的默认值 False。如果您设置了非零的 conn_max_age，则建议启用此功能。

传递给 dj_database_url 的字符串必须是有效的 URL；特别是，特殊字符必须进行 URL 编码。以下 URL 将引发一个 ValueError

postgres://user:p#ssword!@localhost/foobar

应该改为以下方式传递

postgres://user:p%23ssword!@localhost/foobar

TEST 配置可以使用 test_options 属性进行配置

DATABASES['default'] = dj_database_url.config(default='postgres://...', test_options={'NAME': 'mytestdatabase'})

URL 架构

贡献

我们欢迎对此项目的贡献。项目可以有两种形式

1. 提出问题或通过 github 问题跟踪器帮助他人。

2. 贡献代码。