[SQL-CVS] r1043 - SQLObject/trunk/docs

[<sub...@co...>]

Author: phd
Date: 2005-09-26 14:50:42 +0000 (Mon, 26 Sep 2005)
New Revision: 1043

Modified:
   SQLObject/trunk/docs/SQLObject.txt
Log:
Added a section describing connection URIs.


Modified: SQLObject/trunk/docs/SQLObject.txt
===================================================================
--- SQLObject/trunk/docs/SQLObject.txt	2005-09-26 05:15:12 UTC (rev 1042)
+++ SQLObject/trunk/docs/SQLObject.txt	2005-09-26 14:50:42 UTC (rev 1043)
@@ -130,6 +130,34 @@
 Declaring the Class
 -------------------
 
+The connection URI must follow the standard URI syntax::
+
+    scheme://[user[:password]@]host[:port]/database[?parameters]
+
+Scheme is one of ``sqlite``, ``mysql``, ``postgres``, ``firebird``,
+``interbase``, ``maxdb``, ``sapdb``, ``sybase``.
+
+Examples::
+
+    mysql://user:passwd@host/database
+    mysql://host/database?debug=1
+    postgres://user@host/database?debug=&cache=
+    postgres://host:5432/database
+    sqlite:///full/path/to/database
+    sqlite:/C|/full/path/to/database
+    sqlite:/:memory:
+
+Note that there is a special syntax to specify full path on w32 systems
+(useable for sqlite and firebird); also sqlite can manipulate special
+in-memory databases.
+
+Parameters are: ``debug`` (default: False), ``debugOutput`` (default: False),
+``cache`` (default: True), ``autoCommit`` (default: True),
+``debugThreading`` (default: False).
+
+If you want to pass True value in a connection URI - pass any non-empty
+string; an empty string for False.
+
 Lets first set up a connection::
 
     >>> db_filename = os.path.abspath('data.db')
@@ -139,6 +167,7 @@
     >>> connection = connectionForURI(connection_string)
     >>> sqlhub.processConnection = connection
 
+
 The ``sqlhub.processConnection`` assignment means that all classes
 will, by default, use this connection we've just set up.