summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/dialects/firebird
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2012-10-18 18:24:15 -0400
committerMike Bayer <mike_mp@zzzcomputing.com>2012-10-18 18:24:15 -0400
commit017989ce8bca6e0540701fe0221fcfc556f7aba8 (patch)
treeb7d0acba55f2af66d7c90b1042b8fd397caad53d /lib/sqlalchemy/dialects/firebird
parentba67f7dbc5eb7a1ed2a3e1b56df72a837130f7bb (diff)
downloadsqlalchemy-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 'lib/sqlalchemy/dialects/firebird')
-rw-r--r--lib/sqlalchemy/dialects/firebird/base.py19
-rw-r--r--lib/sqlalchemy/dialects/firebird/fdb.py15
-rw-r--r--lib/sqlalchemy/dialects/firebird/kinterbasdb.py5
3 files changed, 28 insertions, 11 deletions
diff --git a/lib/sqlalchemy/dialects/firebird/base.py b/lib/sqlalchemy/dialects/firebird/base.py
index 4a83f2332..b99040038 100644
--- a/lib/sqlalchemy/dialects/firebird/base.py
+++ b/lib/sqlalchemy/dialects/firebird/base.py
@@ -7,10 +7,19 @@
"""
Support for the Firebird database.
-Connectivity is usually supplied via the kinterbasdb_ DBAPI module.
+DBAPI Support
+-------------
-Dialects
-~~~~~~~~
+The following dialect/driver options are available:
+
+``firebird://``- uses kinterbasdb_
+
+``firebird+kinterbasdb://`` - uses kinterbasdb_
+
+``firebird+fdb://`` - uses fdb_
+
+Firebird Dialects
+-----------------
Firebird offers two distinct dialects_ (not to be confused with a
SQLAlchemy ``Dialect``):
@@ -27,7 +36,7 @@ support for dialect 1 is not well tested and probably has
incompatibilities.
Locking Behavior
-~~~~~~~~~~~~~~~~
+----------------
Firebird locks tables aggressively. For this reason, a DROP TABLE may
hang until other transactions are released. SQLAlchemy does its best
@@ -47,7 +56,7 @@ The above use case can be alleviated by calling ``first()`` on the
all remaining cursor/connection resources.
RETURNING support
-~~~~~~~~~~~~~~~~~
+-----------------
Firebird 2.0 supports returning a result set from inserts, and 2.1
extends that to deletes and updates. This is generically exposed by
diff --git a/lib/sqlalchemy/dialects/firebird/fdb.py b/lib/sqlalchemy/dialects/firebird/fdb.py
index e6ca170f7..3601b391b 100644
--- a/lib/sqlalchemy/dialects/firebird/fdb.py
+++ b/lib/sqlalchemy/dialects/firebird/fdb.py
@@ -7,15 +7,12 @@
"""
fdb is a kinterbasdb compatible DBAPI for Firebird.
-Usage is currently the same as that of kinterbasdb, with the exception
-of the connect string below.
-
.. versionadded:: 0.8 - Support for the fdb Firebird driver.
-Status
-------
+DBAPI
+-----
-The fdb dialect is new and not yet tested (can't get fdb to build).
+http://pypi.python.org/pypi/fdb/
Connecting
-----------
@@ -24,6 +21,12 @@ Connect string format::
firebird+fdb://user:password@host:port/path/to/db[?key=value&key=value...]
+Status
+------
+
+The fdb dialect is new and not yet tested (can't get fdb to build).
+
+
"""
from .kinterbasdb import FBDialect_kinterbasdb
diff --git a/lib/sqlalchemy/dialects/firebird/kinterbasdb.py b/lib/sqlalchemy/dialects/firebird/kinterbasdb.py
index 47160f5ea..78fffd647 100644
--- a/lib/sqlalchemy/dialects/firebird/kinterbasdb.py
+++ b/lib/sqlalchemy/dialects/firebird/kinterbasdb.py
@@ -6,6 +6,11 @@
"""
+DBAPI
+-----
+
+http://firebirdsql.org/index.php?op=devel&sub=python
+
Connecting
-----------