dj-database-url 1.0.0

Supported Databases

Support currently exists for PostgreSQL, PostGIS, MySQL, MySQL (GIS), Oracle, Oracle (GIS), Redshift, CockroachDB, and SQLite.

Installation

Installation is simple:

$ pip install dj-database-url

Usage

1. If DATABASES is already defined:

• Configure your database in settings.py from DATABASE_URL:

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

• Provide a default:

  DATABASES['default'] = dj_database_url.config(default='postgres://...')

• Parse an arbitrary Database URL:

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

2. If DATABASES is not defined:

• Configure your database in settings.py from DATABASE_URL:

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

• Provide a default:

  DATABASES = {'default': dj_database_url.config(default='postgres://...')}

• Parse an arbitrary Database URL:

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

The conn_max_age attribute is the lifetime of a database connection in seconds and is available in Django 1.6+. If you do not set a value, it will default to 0 which is Django’s historical behavior of using a new database connection on each request. Use None for unlimited persistent connections.

Strings passed to dj_database_url must be valid URLs; in particular, special characters must be url-encoded. The following url will raise a ValueError:

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

and should instead be passed as:

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

URL schema

Contributing

We welcome contributions to this project. Projects can take two forms:

1. Raising issues or helping others through the github issue tracker.

2. Contributing code.