summaryrefslogtreecommitdiff
path: root/doc/build/dialects
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2010-09-04 13:25:13 -0400
committerMike Bayer <mike_mp@zzzcomputing.com>2010-09-04 13:25:13 -0400
commit4e24d6cb01c58d9617d5e22e1068b2d164e4a3db (patch)
treec7d1bbb0fe8717df14da56ed5ad634606e371b3a /doc/build/dialects
parent6e83926657057c97239bef114e640f2b102be02c (diff)
downloadsqlalchemy-4e24d6cb01c58d9617d5e22e1068b2d164e4a3db.tar.gz
experiment with removing the API section and putting docstrings inline.
new outline section is provided with a new flow.
Diffstat (limited to 'doc/build/dialects')
-rw-r--r--doc/build/dialects/access.rst4
-rw-r--r--doc/build/dialects/firebird.rst11
-rw-r--r--doc/build/dialects/index.rst35
-rw-r--r--doc/build/dialects/informix.rst4
-rw-r--r--doc/build/dialects/maxdb.rst4
-rw-r--r--doc/build/dialects/mssql.rst116
-rw-r--r--doc/build/dialects/mysql.rst178
-rw-r--r--doc/build/dialects/oracle.rst58
-rw-r--r--doc/build/dialects/postgresql.rst86
-rw-r--r--doc/build/dialects/sqlite.rst21
-rw-r--r--doc/build/dialects/sybase.rst20
11 files changed, 537 insertions, 0 deletions
diff --git a/doc/build/dialects/access.rst b/doc/build/dialects/access.rst
new file mode 100644
index 000000000..52a2ee371
--- /dev/null
+++ b/doc/build/dialects/access.rst
@@ -0,0 +1,4 @@
+Microsoft Access
+================
+
+.. automodule:: sqlalchemy.dialects.access.base
diff --git a/doc/build/dialects/firebird.rst b/doc/build/dialects/firebird.rst
new file mode 100644
index 000000000..dd6b6d0ba
--- /dev/null
+++ b/doc/build/dialects/firebird.rst
@@ -0,0 +1,11 @@
+Firebird
+========
+
+.. automodule:: sqlalchemy.dialects.firebird.base
+
+.. _kinterbasdb:
+
+kinterbasdb
+-----------
+
+.. automodule:: sqlalchemy.dialects.firebird.kinterbasdb
diff --git a/doc/build/dialects/index.rst b/doc/build/dialects/index.rst
new file mode 100644
index 000000000..a1808dff9
--- /dev/null
+++ b/doc/build/dialects/index.rst
@@ -0,0 +1,35 @@
+.. _sqlalchemy.dialects_toplevel:
+
+sqlalchemy.dialects
+====================
+
+Supported Databases
+-------------------
+
+These backends are fully operational with
+current versions of SQLAlchemy.
+
+.. toctree::
+ :glob:
+
+ firebird
+ mssql
+ mysql
+ oracle
+ postgresql
+ sqlite
+ sybase
+
+Unsupported Databases
+---------------------
+
+These backends are untested and may not be completely
+ported to current versions of SQLAlchemy.
+
+.. toctree::
+ :glob:
+
+ access
+ informix
+ maxdb
+
diff --git a/doc/build/dialects/informix.rst b/doc/build/dialects/informix.rst
new file mode 100644
index 000000000..7cf271d0b
--- /dev/null
+++ b/doc/build/dialects/informix.rst
@@ -0,0 +1,4 @@
+Informix
+========
+
+.. automodule:: sqlalchemy.dialects.informix.base
diff --git a/doc/build/dialects/maxdb.rst b/doc/build/dialects/maxdb.rst
new file mode 100644
index 000000000..3edd55a77
--- /dev/null
+++ b/doc/build/dialects/maxdb.rst
@@ -0,0 +1,4 @@
+MaxDB
+=====
+
+.. automodule:: sqlalchemy.dialects.maxdb.base
diff --git a/doc/build/dialects/mssql.rst b/doc/build/dialects/mssql.rst
new file mode 100644
index 000000000..658ca8988
--- /dev/null
+++ b/doc/build/dialects/mssql.rst
@@ -0,0 +1,116 @@
+Microsoft SQL Server
+====================
+
+.. automodule:: sqlalchemy.dialects.mssql.base
+
+SQL Server Data Types
+-----------------------
+
+As with all SQLAlchemy dialects, all UPPERCASE types that are known to be
+valid with SQL server are importable from the top level dialect, whether
+they originate from :mod:`sqlalchemy.types` or from the local dialect::
+
+ from sqlalchemy.dialects.mssql import \
+ BIGINT, BINARY, BIT, CHAR, DATE, DATETIME, DATETIME2, \
+ DATETIMEOFFSET, DECIMAL, FLOAT, IMAGE, INTEGER, MONEY, \
+ NCHAR, NTEXT, NUMERIC, NVARCHAR, REAL, SMALLDATETIME, \
+ SMALLINT, SMALLMONEY, SQL_VARIANT, TEXT, TIME, \
+ TIMESTAMP, TINYINT, UNIQUEIDENTIFIER, VARBINARY, VARCHAR
+
+Types which are specific to SQL Server, or have SQL Server-specific
+construction arguments, are as follows:
+
+.. autoclass:: BIT
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: CHAR
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: DATETIME2
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: DATETIMEOFFSET
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: IMAGE
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: MONEY
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: NCHAR
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: NTEXT
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: NVARCHAR
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: REAL
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: SMALLDATETIME
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: SMALLMONEY
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: SQL_VARIANT
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: TEXT
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: TIME
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: TINYINT
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: UNIQUEIDENTIFIER
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: VARCHAR
+ :members: __init__
+ :show-inheritance:
+
+
+PyODBC
+------
+.. automodule:: sqlalchemy.dialects.mssql.pyodbc
+
+mxODBC
+------
+.. automodule:: sqlalchemy.dialects.mssql.mxodbc
+
+pymssql
+-------
+.. automodule:: sqlalchemy.dialects.mssql.pymssql
+
+zxjdbc Notes
+--------------
+
+.. automodule:: sqlalchemy.dialects.mssql.zxjdbc
+
+AdoDBAPI
+--------
+.. automodule:: sqlalchemy.dialects.mssql.adodbapi
+
diff --git a/doc/build/dialects/mysql.rst b/doc/build/dialects/mysql.rst
new file mode 100644
index 000000000..8796adb3e
--- /dev/null
+++ b/doc/build/dialects/mysql.rst
@@ -0,0 +1,178 @@
+MySQL
+=====
+
+.. automodule:: sqlalchemy.dialects.mysql.base
+
+MySQL Data Types
+------------------
+
+As with all SQLAlchemy dialects, all UPPERCASE types that are known to be
+valid with MySQL are importable from the top level dialect::
+
+ from sqlalchemy.dialects.mysql import \
+ BIGINT, BINARY, BIT, BLOB, BOOLEAN, CHAR, DATE, \
+ DATETIME, DECIMAL, DECIMAL, DOUBLE, ENUM, FLOAT, INTEGER, \
+ LONGBLOB, LONGTEXT, MEDIUMBLOB, MEDIUMINT, MEDIUMTEXT, NCHAR, \
+ NUMERIC, NVARCHAR, REAL, SET, SMALLINT, TEXT, TIME, TIMESTAMP, \
+ TINYBLOB, TINYINT, TINYTEXT, VARBINARY, VARCHAR, YEAR
+
+Types which are specific to MySQL, or have MySQL-specific
+construction arguments, are as follows:
+
+.. autoclass:: BIGINT
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: BINARY
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: BIT
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: BLOB
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: BOOLEAN
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: CHAR
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: DATE
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: DATETIME
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: DECIMAL
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: DOUBLE
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: ENUM
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: FLOAT
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: INTEGER
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: LONGBLOB
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: LONGTEXT
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: MEDIUMBLOB
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: MEDIUMINT
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: MEDIUMTEXT
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: NCHAR
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: NUMERIC
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: NVARCHAR
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: REAL
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: SET
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: SMALLINT
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: TEXT
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: TIME
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: TIMESTAMP
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: TINYBLOB
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: TINYINT
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: TINYTEXT
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: VARBINARY
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: VARCHAR
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: YEAR
+ :members: __init__
+ :show-inheritance:
+
+
+MySQL-Python Notes
+--------------------
+
+.. automodule:: sqlalchemy.dialects.mysql.mysqldb
+
+OurSQL Notes
+--------------
+
+.. automodule:: sqlalchemy.dialects.mysql.oursql
+
+MySQL-Connector Notes
+----------------------
+
+.. automodule:: sqlalchemy.dialects.mysql.mysqlconnector
+
+pyodbc Notes
+--------------
+
+.. automodule:: sqlalchemy.dialects.mysql.pyodbc
+
+zxjdbc Notes
+--------------
+
+.. automodule:: sqlalchemy.dialects.mysql.zxjdbc
diff --git a/doc/build/dialects/oracle.rst b/doc/build/dialects/oracle.rst
new file mode 100644
index 000000000..363cebffd
--- /dev/null
+++ b/doc/build/dialects/oracle.rst
@@ -0,0 +1,58 @@
+Oracle
+======
+
+.. automodule:: sqlalchemy.dialects.oracle.base
+
+Oracle Data Types
+-------------------
+
+As with all SQLAlchemy dialects, all UPPERCASE types that are known to be
+valid with Oracle are importable from the top level dialect, whether
+they originate from :mod:`sqlalchemy.types` or from the local dialect::
+
+ from sqlalchemy.dialects.oracle import \
+ BFILE, BLOB, CHAR, CLOB, DATE, DATETIME, \
+ DOUBLE_PRECISION, FLOAT, INTERVAL, LONG, NCLOB, \
+ NUMBER, NVARCHAR, NVARCHAR2, RAW, TIMESTAMP, VARCHAR, \
+ VARCHAR2
+
+Types which are specific to Oracle, or have Oracle-specific
+construction arguments, are as follows:
+
+.. autoclass:: BFILE
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: DOUBLE_PRECISION
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: INTERVAL
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: NCLOB
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: NUMBER
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: LONG
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: RAW
+ :members: __init__
+ :show-inheritance:
+
+cx_Oracle Notes
+---------------
+
+.. automodule:: sqlalchemy.dialects.oracle.cx_oracle
+
+zxjdbc Notes
+--------------
+
+.. automodule:: sqlalchemy.dialects.oracle.zxjdbc
diff --git a/doc/build/dialects/postgresql.rst b/doc/build/dialects/postgresql.rst
new file mode 100644
index 000000000..fe1fcb2f7
--- /dev/null
+++ b/doc/build/dialects/postgresql.rst
@@ -0,0 +1,86 @@
+PostgreSQL
+==========
+
+.. automodule:: sqlalchemy.dialects.postgresql.base
+
+PostgreSQL Data Types
+------------------------
+
+As with all SQLAlchemy dialects, all UPPERCASE types that are known to be
+valid with Postgresql are importable from the top level dialect, whether
+they originate from :mod:`sqlalchemy.types` or from the local dialect::
+
+ from sqlalchemy.dialects.postgresql import \
+ ARRAY, BIGINT, BIT, BOOLEAN, BYTEA, CHAR, CIDR, DATE, \
+ DOUBLE_PRECISION, ENUM, FLOAT, INET, INTEGER, INTERVAL, \
+ MACADDR, NUMERIC, REAL, SMALLINT, TEXT, TIME, TIMESTAMP, \
+ UUID, VARCHAR
+
+Types which are specific to PostgreSQL, or have PostgreSQL-specific
+construction arguments, are as follows:
+
+.. autoclass:: ARRAY
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: BIT
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: BYTEA
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: CIDR
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: DOUBLE_PRECISION
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: ENUM
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: INET
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: INTERVAL
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: MACADDR
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: REAL
+ :members: __init__
+ :show-inheritance:
+
+.. autoclass:: UUID
+ :members: __init__
+ :show-inheritance:
+
+
+psycopg2 Notes
+--------------
+
+.. automodule:: sqlalchemy.dialects.postgresql.psycopg2
+
+
+py-postgresql Notes
+--------------------
+
+.. automodule:: sqlalchemy.dialects.postgresql.pypostgresql
+
+pg8000 Notes
+--------------
+
+.. automodule:: sqlalchemy.dialects.postgresql.pg8000
+
+zxjdbc Notes
+--------------
+
+.. automodule:: sqlalchemy.dialects.postgresql.zxjdbc
diff --git a/doc/build/dialects/sqlite.rst b/doc/build/dialects/sqlite.rst
new file mode 100644
index 000000000..a4e87e1b0
--- /dev/null
+++ b/doc/build/dialects/sqlite.rst
@@ -0,0 +1,21 @@
+SQLite
+======
+
+.. automodule:: sqlalchemy.dialects.sqlite.base
+
+SQLite Data Types
+------------------------
+
+As with all SQLAlchemy dialects, all UPPERCASE types that are known to be
+valid with SQLite are importable from the top level dialect, whether
+they originate from :mod:`sqlalchemy.types` or from the local dialect::
+
+ from sqlalchemy.dialects.sqlite import \
+ BLOB, BOOLEAN, CHAR, DATE, DATETIME, DECIMAL, FLOAT, \
+ INTEGER, NUMERIC, SMALLINT, TEXT, TIME, TIMESTAMP, \
+ VARCHAR
+
+Pysqlite
+--------
+
+.. automodule:: sqlalchemy.dialects.sqlite.pysqlite \ No newline at end of file
diff --git a/doc/build/dialects/sybase.rst b/doc/build/dialects/sybase.rst
new file mode 100644
index 000000000..724656a30
--- /dev/null
+++ b/doc/build/dialects/sybase.rst
@@ -0,0 +1,20 @@
+Sybase
+======
+
+.. automodule:: sqlalchemy.dialects.sybase.base
+
+python-sybase notes
+-------------------
+
+.. automodule:: sqlalchemy.dialects.sybase.pysybase
+
+pyodbc notes
+------------
+
+.. automodule:: sqlalchemy.dialects.sybase.pyodbc
+
+mxodbc notes
+------------
+
+.. automodule:: sqlalchemy.dialects.sybase.mxodbc
+