dj-database-url's Introduction

DJ-Database-URL

This simple Django utility allows you to utilize the 12factor inspired DATABASE_URL environment variable to configure your Django application.

Supported databases

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

Installation is simple:

$ pip install dj-database-url

Configure your database in settings.py from DATABASE_URL (default is optional):

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

Parse an arbitrary Database URL:

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

Engine	Django Backend	URL
PostgreSQL	`django.db.backends.postgresql_psycopg2`	`postgres://USER:PASSWORD@HOST:PORT/NAME` [1]
PostGIS	`django.contrib.gis.db.backends.postgis`	`postgis://USER:PASSWORD@HOST:PORT/NAME`
MySQL	`django.db.backends.mysql`	`mysql://USER:PASSWORD@HOST:PORT/NAME`
MySQL (GIS)	`django.contrib.gis.db.backends.mysql`	`mysqlgis://USER:PASSWORD@HOST:PORT/NAME`
SQLite	`django.db.backends.sqlite3`	`sqlite:///PATH` [2]

[1]	With PostgreSQL, you can also use unix domain socket paths with percent encoding: `postgres://%2Fvar%2Flib%2Fpostgresql/dbname`.

[2]	SQLite connects to file based databases. The same URL format is used, omitting the hostname, and using the "file" portion as the filename of the database. This has the effect of four slashes being present for an absolute file path: `sqlite:////full/path/to/your/database/file.sqlite`.

Recommend Projects