]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
doc edits
authorMike Bayer <mike_mp@zzzcomputing.com>
Thu, 23 Sep 2010 23:24:28 +0000 (19:24 -0400)
committerMike Bayer <mike_mp@zzzcomputing.com>
Thu, 23 Sep 2010 23:24:28 +0000 (19:24 -0400)
doc/build/dialects/index.rst
doc/build/index.rst
lib/sqlalchemy/dialects/sqlite/pysqlite.py

index a8cfc33245960f20ad06b8d4a165a3a6b396a774..8ad9330bcc9e355c04b3fdc1dcfcbb635f281bb9 100644 (file)
@@ -3,22 +3,23 @@
 Dialects
 ========
 
-The *dialect* is the system SQLAlchemy uses to communicate with various types of DBAPIs and databases.
-A compatibility chart of supported backends can be found at :ref:`supported_dbapis`.
+The **dialect** is the system SQLAlchemy uses to communicate with various types of DBAPIs and databases.
+A compatibility chart of supported backends can be found at :ref:`supported_dbapis`.  The sections that 
+follow contain reference documentation and notes specific to the usage of each backend, as well as notes
+for the various DBAPIs.
 
-This section contains all notes and documentation specific to the usage of various backends.
-
-Supported Databases
--------------------
-
-These backends are fully operational with 
-current versions of SQLAlchemy.
+Note that not all backends are fully ported and tested with
+current versions of SQLAlchemy. The compatibility chart
+should be consulted to check for current support level.
 
 .. toctree::
     :maxdepth: 1
     :glob:
 
     firebird
+    informix
+    maxdb
+    access
     mssql
     mysql
     oracle
@@ -26,17 +27,4 @@ current versions of SQLAlchemy.
     sqlite
     sybase
 
-Unsupported Databases
----------------------
-
-These backends are untested and may not be completely
-ported to current versions of SQLAlchemy.
-
-.. toctree::
-    :maxdepth: 1
-    :glob:
-
-    access
-    informix
-    maxdb
 
index 2c66bd47f29f6645ce1b9600a9778ccb5bbdc89d..2d75a5c08f7e5e1dc133302bf713000ae5b4ea87 100644 (file)
@@ -8,7 +8,7 @@ Table of Contents
     orm/index
     core/index
     dialects/index
-
+    
 Indices and tables
 ------------------
 
index 575cb37f205d68fe3fd4a0def7e929b1f6f02ad8..b2295f49b44f5c112d8dd370934c732d275c4cbe 100644 (file)
@@ -68,12 +68,13 @@ pysqlite's driver does not.   Additionally, SQLAlchemy does not at
 this time automatically render the "cast" syntax required for the 
 freestanding functions "current_timestamp" and "current_date" to return
 datetime/date types natively.   Unfortunately, pysqlite 
-does not provide the standard DBAPI types in `cursor.description`,
+does not provide the standard DBAPI types in ``cursor.description``,
 leaving SQLAlchemy with no way to detect these types on the fly 
 without expensive per-row type checks.
 
-Usage of PARSE_DECLTYPES can be forced if one configures 
-"native_datetime=True" on create_engine()::
+Keeping in mind that pysqlite's parsing option is not recommended,
+nor should be necessary, for use with SQLAlchemy, usage of PARSE_DECLTYPES 
+can be forced if one configures "native_datetime=True" on create_engine()::
 
     engine = create_engine('sqlite://', 
                     connect_args={'detect_types': sqlite3.PARSE_DECLTYPES|sqlite3.PARSE_COLNAMES},