Browse Source

Add documentation for SQLAlchemy tablename configuration options.

Ryan Petrello 12 years ago
parent
commit
3de77a7c6b
1 changed files with 17 additions and 0 deletions
  1. 17 0
      docs/configuration.rst

+ 17 - 0
docs/configuration.rst

@@ -286,6 +286,21 @@ going stale through inactivity.  For example, intermittent errors like
 `(OperationalError) (2006, 'MySQL server has gone away')` can be fixed by enabling
 short lived sessions.  This option only affects the database backend.
 
+Specifying Table Names
+~~~~~~~~~~~~~~~~~~~~~~
+
+.. setting:: CELERY_RESULT_DB_TASK_TABLENAME
+
+.. setting:: CELERY_RESULT_DB_TASKSET_TABLENAME
+
+When SQLAlchemy is configured as the result backend, Celery automatically
+creates two tables to store result metadata for tasks.  These settings allow
+you to customize the table names::
+
+    # use custom table names
+    CELERY_RESULT_DB_TASK_TABLENAME = "myapp_taskmeta"
+    CELERY_RESULT_DB_TASKSET_TABLENAME = "myapp_tasksetmeta"
+
 .. _`Supported Databases`:
     http://www.sqlalchemy.org/docs/core/engines.html#supported-databases
 
@@ -299,6 +314,8 @@ Example configuration
 
     CELERY_RESULT_BACKEND = "database"
     CELERY_RESULT_DBURI = "mysql://user:password@host/dbname"
+    CELERY_RESULT_DB_TASK_TABLENAME = "myapp_taskmeta"
+    CELERY_RESULT_DB_TASKSET_TABLENAME = "myapp_tasksetmeta"
 
 .. _conf-amqp-result-backend: