Browse Source

Sqla broker doc now uses connection urls

Ask Solem 13 years ago
parent
commit
eb09305c0c
1 changed files with 11 additions and 12 deletions
  1. 11 12
      docs/getting-started/brokers/sqlalchemy.rst

+ 11 - 12
docs/getting-started/brokers/sqlalchemy.rst

@@ -14,33 +14,32 @@ Installation
 Configuration
 =============
 
-This transport uses only the :setting:`BROKER_HOST` setting, which have to be
-an SQLAlchemy database URI.
-
-#. Set your broker transport::
+Celery needs to know the location of your database, which should be the usual
+SQLAlchemy connection string, but with 'sqla+' prepended to it::
 
-    BROKER_TRANSPORT = "sqlalchemy"
+    BROKER_URL = "sqla+sqlite:///celerydb.sqlite"
 
-#. Configure the database URI::
+This transport uses only the :setting:`BROKER_URL` setting, which have to be
+an SQLAlchemy database URI.
 
-    BROKER_HOST = "sqlite:///celerydb.sqlite"
 
 Please see `SQLAlchemy: Supported Databases`_ for a table of supported databases.
-Some other `SQLAlchemy Connection String`_, examples:
+
+Here's a list of examples using a selection of other `SQLAlchemy Connection String`_'s:
 
 .. code-block:: python
 
     # sqlite (filename)
-    BROKER_HOST = "sqlite:///celerydb.sqlite"
+    BROKER_URL = "sqla+sqlite:///celerydb.sqlite"
 
     # mysql
-    BROKER_HOST = "mysql://scott:tiger@localhost/foo"
+    BROKER_URL = "sqla+mysql://scott:tiger@localhost/foo"
 
     # postgresql
-    BROKER_HOST = "postgresql://scott:tiger@localhost/mydatabase"
+    BROKER_URL = "sqla+postgresql://scott:tiger@localhost/mydatabase"
 
     # oracle
-    BROKER_HOST = "oracle://scott:tiger@127.0.0.1:1521/sidname"
+    BROKER_URL = "sqla+oracle://scott:tiger@127.0.0.1:1521/sidname"
 
 .. _`SQLAlchemy: Supported Databases`:
     http://www.sqlalchemy.org/docs/core/engines.html#supported-databases