Skip to main content

Use Database URLs in your Django Application.

Project description

Jazzband https://github.com/jazzband/dj-database-url/actions/workflows/test.yml/badge.svg https://codecov.io/gh/jazzband/dj-database-url/branch/master/graph/badge.svg?token=7srBUpszOa

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

The dj_database_url.config method returns a Django database connection dictionary, populated with all the data specified in your URL. There is also a conn_max_age argument to easily enable Django’s connection pool.

If you’d rather not use an environment variable, you can pass a URL in directly instead to dj_database_url.parse.

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)
  1. 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

Engine

Django Backend

URL

PostgreSQL

django.db.backends.postgresql [1]

postgres://USER:PASSWORD@HOST:PORT/NAME [2]

PostGIS

django.contrib.gis.db.backends.postgis

postgis://USER:PASSWORD@HOST:PORT/NAME

MSSQL

sql_server.pyodbc

mssql://USER:PASSWORD@HOST:PORT/NAME

MSSQL [5]

mssql

mssqlms://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 [3]

SpatiaLite

django.contrib.gis.db.backends.spatialite

spatialite:///PATH [3]

Oracle

django.db.backends.oracle

oracle://USER:PASSWORD@HOST:PORT/NAME [4]

Oracle (GIS)

django.contrib.gis.db.backends.oracle

oraclegis://USER:PASSWORD@HOST:PORT/NAME

Redshift

django_redshift_backend

redshift://USER:PASSWORD@HOST:PORT/NAME

CockroachDB

django_cockroachdb

cockroach://USER:PASSWORD@HOST:PORT/NAME

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.

Raising Issues or helping others:

When submitting an issue or helping other remember you are talking to humans who have feelings, jobs and lives of their own. Be nice, be kind, be polite. Remember english may not be someone first language, if you do not understand or something is not clear be polite and re-ask/ re-word.

Contributing code:

  • Before writing code be sure to check existing PR’s and issues in the tracker.

  • Write code to the pylint spec.

  • Large or wide sweeping changes will take longer, and may face more scrutiny than smaller confined changes.

  • Code should be pass black and flake8 validation.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dj-database-url-1.0.0.tar.gz (6.5 kB view hashes)

Uploaded source

Built Distribution

dj_database_url-1.0.0-py3-none-any.whl (6.6 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page