diff options
| author | Mike Bayer <mike_mp@zzzcomputing.com> | 2012-10-18 18:24:15 -0400 |
|---|---|---|
| committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2012-10-18 18:24:15 -0400 |
| commit | 017989ce8bca6e0540701fe0221fcfc556f7aba8 (patch) | |
| tree | b7d0acba55f2af66d7c90b1042b8fd397caad53d /doc/build/dialects | |
| parent | ba67f7dbc5eb7a1ed2a3e1b56df72a837130f7bb (diff) | |
| download | sqlalchemy-017989ce8bca6e0540701fe0221fcfc556f7aba8.tar.gz | |
- move out maxdb
- begin consolidating docs for dialects to be more self contained
- add a separate section for "external" dialects
- not sure how we're going to go with this yet.
Diffstat (limited to 'doc/build/dialects')
| -rw-r--r-- | doc/build/dialects/drizzle.rst | 4 | ||||
| -rw-r--r-- | doc/build/dialects/index.rst | 32 | ||||
| -rw-r--r-- | doc/build/dialects/maxdb.rst | 6 | ||||
| -rw-r--r-- | doc/build/dialects/mysql.rst | 29 | ||||
| -rw-r--r-- | doc/build/dialects/postgresql.rst | 15 |
5 files changed, 61 insertions, 25 deletions
diff --git a/doc/build/dialects/drizzle.rst b/doc/build/dialects/drizzle.rst index 114c6f9c9..ec0af93ce 100644 --- a/doc/build/dialects/drizzle.rst +++ b/doc/build/dialects/drizzle.rst @@ -16,7 +16,7 @@ valid with Drizzle are importable from the top level dialect:: DECIMAL, DOUBLE, ENUM, FLOAT, INT, INTEGER, NUMERIC, TEXT, TIME, TIMESTAMP, VARBINARY, VARCHAR -Types which are specific to Drizzle, or have Drizzle-specific +Types which are specific to Drizzle, or have Drizzle-specific construction arguments, are as follows: .. currentmodule:: sqlalchemy.dialects.drizzle @@ -70,6 +70,8 @@ construction arguments, are as follows: :show-inheritance: +.. _drizzle_mysqldb: + MySQL-Python Notes -------------------- diff --git a/doc/build/dialects/index.rst b/doc/build/dialects/index.rst index 2eb770bde..7f87439a0 100644 --- a/doc/build/dialects/index.rst +++ b/doc/build/dialects/index.rst @@ -4,13 +4,13 @@ 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 sections that -follow contain reference documentation and notes specific to the usage of each backend, as well as notes +The sections that follow contain reference documentation and notes specific to the usage of each backend, as well as notes for the various DBAPIs. -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. +All dialects require that an appropriate DBAPI driver is installed. + +Included Dialects +----------------- .. toctree:: :maxdepth: 1 @@ -19,7 +19,6 @@ should be consulted to check for current support level. drizzle firebird informix - maxdb mssql mysql oracle @@ -27,5 +26,26 @@ should be consulted to check for current support level. sqlite sybase +.. _external_toplevel: + +External Dialects +----------------- + +.. note:: + + As of SQLAlchemy 0.8, several dialects have been moved to external + projects, and dialects for new databases will also be published + as external projects. The rationale here is to keep the base + SQLAlchemy install and test suite from growing inordinately large. + + The "classic" dialects such as SQLite, MySQL, Postgresql, Oracle, + SQL Server, Firebird will remain in the Core for the time being. + +Current external dialect projects for SQLAlchemy include: + +* `sqlalchemy-access <https://bitbucket.org/zzzeek/sqlalchemy-access>`_ - driver for Microsoft Access. +* `sqlalchemy-akiban <https://github.com/zzzeek/sqlalchemy_akiban>`_ - driver and ORM extensions for the `Akiban <http://www.akiban.com>`_ database. +* `sqlalchemy-cubrid <https://bitbucket.org/zzzeek/sqlalchemy-cubrid>`_ - driver for the CUBRID database. +* `sqlalchemy-maxdb <https://bitbucket.org/zzzeek/sqlalchemy-maxdb>`_ - driver for the MaxDB database. diff --git a/doc/build/dialects/maxdb.rst b/doc/build/dialects/maxdb.rst deleted file mode 100644 index c4f8a802c..000000000 --- a/doc/build/dialects/maxdb.rst +++ /dev/null @@ -1,6 +0,0 @@ -.. _maxdb_toplevel: - -MaxDB -===== - -.. automodule:: sqlalchemy.dialects.maxdb.base diff --git a/doc/build/dialects/mysql.rst b/doc/build/dialects/mysql.rst index 916df525e..2110e375a 100644 --- a/doc/build/dialects/mysql.rst +++ b/doc/build/dialects/mysql.rst @@ -18,7 +18,7 @@ valid with MySQL are importable from the top level dialect:: NUMERIC, NVARCHAR, REAL, SET, SMALLINT, TEXT, TIME, TIMESTAMP, \ TINYBLOB, TINYINT, TINYTEXT, VARBINARY, VARCHAR, YEAR -Types which are specific to MySQL, or have MySQL-specific +Types which are specific to MySQL, or have MySQL-specific construction arguments, are as follows: .. currentmodule:: sqlalchemy.dialects.mysql @@ -155,38 +155,51 @@ construction arguments, are as follows: :members: __init__ :show-inheritance: +.. _mysqldb: -MySQL-Python Notes +MySQL-Python -------------------- .. automodule:: sqlalchemy.dialects.mysql.mysqldb -OurSQL Notes +.. _oursql: + +OurSQL -------------- .. automodule:: sqlalchemy.dialects.mysql.oursql -pymysql Notes +.. _pymysql: + +pymysql ------------- .. automodule:: sqlalchemy.dialects.mysql.pymysql -MySQL-Connector Notes +.. _mysqlconnector: + +MySQL-Connector ---------------------- .. automodule:: sqlalchemy.dialects.mysql.mysqlconnector -Google App Engine Notes +.. _gaerdbms: + +Google App Engine ----------------------- .. automodule:: sqlalchemy.dialects.mysql.gaerdbms -pyodbc Notes +.. _mysql_pyodbc: + +pyodbc -------------- .. automodule:: sqlalchemy.dialects.mysql.pyodbc -zxjdbc Notes +.. _mysql_zxjdbc: + +zxjdbc -------------- .. automodule:: sqlalchemy.dialects.mysql.zxjdbc diff --git a/doc/build/dialects/postgresql.rst b/doc/build/dialects/postgresql.rst index 5a2f3343a..cf6f277f5 100644 --- a/doc/build/dialects/postgresql.rst +++ b/doc/build/dialects/postgresql.rst @@ -69,24 +69,31 @@ construction arguments, are as follows: :members: __init__ :show-inheritance: +.. _psycopg2: -psycopg2 Notes +psycopg2 -------------- .. automodule:: sqlalchemy.dialects.postgresql.psycopg2 -py-postgresql Notes +.. _pypostgresql: + +py-postgresql -------------------- .. automodule:: sqlalchemy.dialects.postgresql.pypostgresql -pg8000 Notes +.. _pg8000: + +pg8000 -------------- .. automodule:: sqlalchemy.dialects.postgresql.pg8000 -zxjdbc Notes +.. _zxjdbc: + +zxjdbc -------------- .. automodule:: sqlalchemy.dialects.postgresql.zxjdbc |
