Hopiu/dj-database-url
1
0
Fork 0
mirror of https://github.com/jazzband/dj-database-url.git synced 2026-03-16 22:20:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Add URL schema examples to README

Browse source 
Also reordered some of the sections for a more logical flow
This commit is contained in:
Stephen Eisenhauer 2014-04-18 01:35:07 -05:00
parent c9c933f1bd
commit 4a972d8067
1 changed files with 30 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
README.rst
View file

@ -8,6 +8,17 @@ This simple Django utility allows you to utilize the
`12factor <http://www.12factor.net/backing-services>`_ inspired
``DATABASE_URL`` environment variable to configure your Django application.
Supported databases
-------------------
Support currently exists for PostgreSQL, PostGIS, MySQL, MySQL (GIS) and SQLite.
Installation
------------
Installation is simple::
$ pip install dj-database-url
Usage
-----
@ -21,19 +32,24 @@ Parse an arbitrary Database URL::
DATABASES = {'default': dj_database_url.parse('postgres://...')}
Supported databases
-------------------
URL schema
----------
Support currently exists for PostgreSQL, PostGIS, MySQL, MySQL (GIS) and SQLite.
+-------------+--------------------------------------------+---------------------------------------------+
| Engine | Django Backend | URL |
+=============+============================================+=============================================+
| PostgreSQL | ``django.db.backends.postgresql_psycopg2`` | ``postgres://USER:PASSWORD@HOST:PORT/NAME`` |
+-------------+--------------------------------------------+---------------------------------------------+
| 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`` [1]_ |
+-------------+--------------------------------------------+---------------------------------------------+
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``.
Installation
------------
Installation is simple too::
$ pip install dj-database-url
.. [1] 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``.