diff --git a/README.rst b/README.rst index 6fd2504..d3c47c6 100644 --- a/README.rst +++ b/README.rst @@ -60,7 +60,7 @@ URL schema +-------------+-----------------------------------------------+--------------------------------------------------+ | Engine | Django Backend | URL | +=============+===============================================+==================================================+ -| PostgreSQL | ``django.db.backends.postgresql`` | ``postgres://USER:PASSWORD@HOST:PORT/NAME`` [1]_ | +| 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`` | +-------------+-----------------------------------------------+--------------------------------------------------+ @@ -70,25 +70,27 @@ URL schema +-------------+-----------------------------------------------+--------------------------------------------------+ | MySQL (GIS) | ``django.contrib.gis.db.backends.mysql`` | ``mysqlgis://USER:PASSWORD@HOST:PORT/NAME`` | +-------------+-----------------------------------------------+--------------------------------------------------+ -| SQLite | ``django.db.backends.sqlite3`` | ``sqlite:///PATH`` [2]_ | +| SQLite | ``django.db.backends.sqlite3`` | ``sqlite:///PATH`` [3]_ | +-------------+-----------------------------------------------+--------------------------------------------------+ -| SpatiaLite | ``django.contrib.gis.db.backends.spatialite`` | ``spatialite:///PATH`` [2]_ | +| SpatiaLite | ``django.contrib.gis.db.backends.spatialite`` | ``spatialite:///PATH`` [3]_ | +-------------+-----------------------------------------------+--------------------------------------------------+ -| Oracle | ``django.db.backends.oracle`` | ``oracle://USER:PASSWORD@HOST:PORT/NAME`` [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`` | +-------------+-----------------------------------------------+--------------------------------------------------+ -.. [1] With PostgreSQL, you can also use unix domain socket paths with +.. [1] The django.db.backends.postgresql backend is named django.db.backends.postgresql_psycopg2 in older releases. For + backwards compatibility, the old name still works in newer versions. (The new name does not work in older versions). +.. [2] 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 +.. [3] 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``. -.. [3] Note that when connecting to Oracle the URL isn't in the form you may know +.. [4] Note that when connecting to Oracle the URL isn't in the form you may know from using other Oracle tools (like SQLPlus) i.e. user and password are separated by ``:`` not by ``/``. Also you can omit ``HOST`` and ``PORT`` and provide a full DSN string or TNS name in ``NAME`` part.