[1.2.X] Fixed #14054 -- Added documentation for the connection_created event. Thanks to Rob Hudson for the report and patch.

freakboy3742 · freakboy3742 · commit 5295d678b940 · 2010-08-30T13:25:47.000Z
Backport of r13673 from trunk. git-svn-id: http://code.djangoproject.com/svn/django/branches/releases/1.2.X@13675 bcc190cf-cafb-0310-a4f2-bffc1f526a37
diff --git a/docs/ref/signals.txt b/docs/ref/signals.txt
@@ -436,3 +436,39 @@ Arguments sent with this signal:
     context
         The :class:`~django.template.Context` with which the template was
         rendered.
+
+Database Wrappers
+=================
+
+.. module:: django.db.backends
+   :synopsis: Core signals sent by the database wrapper.
+
+Signals sent by the database wrapper when a database connection is
+initiated.
+
+connection_created
+------------------
+
+.. data:: django.db.backends.signals.connection_created
+   :module:
+
+.. versionadded:: 1.1
+
+.. versionchanged:: 1.2
+   The connection argument was added
+
+Sent when the database wrapper makes the initial connection to the
+database.  This is particularly useful if you'd like to send any post
+connection commands to the SQL backend.
+
+Arguments sent with this signal:
+
+    sender
+        The database wrapper class -- i.e.
+        :class: `django.db.backends.postgresql_psycopg2.DatabaseWrapper` or
+        :class: `django.db.backends.mysql.DatabaseWrapper`, etc.
+
+    connection
+        The database connection that was opened. This can be used in a
+        multiple-database configuration to differentiate connection signals
+        from different databases.
