1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
.. _dialect_toplevel:
Dialects
========
The **dialect** is the system SQLAlchemy uses to communicate with various types of :term:`DBAPI` implementations and databases.
The sections that follow contain reference documentation and notes specific to the usage of each backend, as well as notes
for the various DBAPIs.
All dialects require that an appropriate DBAPI driver is installed.
.. _included_dialects:
Included Dialects
-----------------
.. toctree::
:maxdepth: 1
:glob:
postgresql
mysql
sqlite
oracle
mssql
Supported versions for Included Dialects
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The following table summarizes the support level for each included dialect.
.. dialect-table:: **Supported database versions for included dialects**
:header-rows: 1
Support Definitions
^^^^^^^^^^^^^^^^^^^
.. Fully tested in CI
.. **Fully tested in CI** indicates a version that is tested in the sqlalchemy
.. CI system and passes all the tests in the test suite.
.. glossary::
Supported version
**Supported version** indicates that most SQLAlchemy features should work
for the mentioned database version. Since not all database versions may be
tested in the ci there may be some not working edge cases.
Best effort
**Best effort** indicates that SQLAlchemy tries to support basic features on these
versions, but most likely there will be unsupported features or errors in some use cases.
Pull requests with associated issues may be accepted to continue supporting
older versions, which are reviewed on a case-by-case basis.
.. _external_toplevel:
External Dialects
-----------------
Currently maintained external dialect projects for SQLAlchemy include:
+------------------------------------------------+---------------------------------------+
| Database | Dialect |
+================================================+=======================================+
| Actian Data Platform, Vector, Actian X, Ingres | sqlalchemy-ingres_ |
+------------------------------------------------+---------------------------------------+
| Amazon Athena | pyathena_ |
+------------------------------------------------+---------------------------------------+
| Amazon Aurora DSQL | aurora-dsql-sqlalchemy_ |
+------------------------------------------------+---------------------------------------+
| Amazon Redshift (via psycopg2) | sqlalchemy-redshift_ |
+------------------------------------------------+---------------------------------------+
| Apache Drill | sqlalchemy-drill_ |
+------------------------------------------------+---------------------------------------+
| Apache Druid | pydruid_ |
+------------------------------------------------+---------------------------------------+
| Apache Hive and Presto | PyHive_ |
+------------------------------------------------+---------------------------------------+
| Apache Solr | sqlalchemy-solr_ |
+------------------------------------------------+---------------------------------------+
| Clickhouse | clickhouse-sqlalchemy_ |
+------------------------------------------------+---------------------------------------+
| CockroachDB | sqlalchemy-cockroachdb_ |
+------------------------------------------------+---------------------------------------+
| CrateDB | sqlalchemy-cratedb_ |
+------------------------------------------------+---------------------------------------+
| Databend | databend-sqlalchemy_ |
+------------------------------------------------+---------------------------------------+
| Databricks | databricks_ |
+------------------------------------------------+---------------------------------------+
| Denodo | denodo-sqlalchemy_ |
+------------------------------------------------+---------------------------------------+
| EXASolution | sqlalchemy_exasol_ |
+------------------------------------------------+---------------------------------------+
| Elasticsearch (readonly) | elasticsearch-dbapi_ |
+------------------------------------------------+---------------------------------------+
| Firebird | sqlalchemy-firebird_ |
+------------------------------------------------+---------------------------------------+
| Firebolt | firebolt-sqlalchemy_ |
+------------------------------------------------+---------------------------------------+
| Google BigQuery | sqlalchemy-bigquery_ |
+------------------------------------------------+---------------------------------------+
| Google Sheets | gsheets_ |
+------------------------------------------------+---------------------------------------+
| Greenplum | sqlalchemy-greenplum_ |
+------------------------------------------------+---------------------------------------+
| HyperSQL (hsqldb) | sqlalchemy-hsqldb_ |
+------------------------------------------------+---------------------------------------+
| IBM DB2 and Informix | ibm-db-sa_ |
+------------------------------------------------+---------------------------------------+
| IBM Netezza Performance Server [1]_ | nzalchemy_ |
+------------------------------------------------+---------------------------------------+
| Impala | impyla_ |
+------------------------------------------------+---------------------------------------+
| Kinetica | sqlalchemy-kinetica_ |
+------------------------------------------------+---------------------------------------+
| Microsoft Access (via pyodbc) | sqlalchemy-access_ |
+------------------------------------------------+---------------------------------------+
| Microsoft SQL Server (via python-tds) | sqlalchemy-pytds_ |
+------------------------------------------------+---------------------------------------+
| Microsoft SQL Server (via turbodbc) | sqlalchemy-turbodbc_ |
+------------------------------------------------+---------------------------------------+
| MonetDB | sqlalchemy-monetdb_ |
+------------------------------------------------+---------------------------------------+
| OpenGauss | openGauss-sqlalchemy_ |
+------------------------------------------------+---------------------------------------+
| Rockset | rockset-sqlalchemy_ |
+------------------------------------------------+---------------------------------------+
| SAP ASE (fork of former Sybase dialect) | sqlalchemy-sybase_ |
+------------------------------------------------+---------------------------------------+
| SAP HANA | sqlalchemy-hana_ |
+------------------------------------------------+---------------------------------------+
| SAP Sybase SQL Anywhere | sqlalchemy-sqlany_ |
+------------------------------------------------+---------------------------------------+
| Snowflake | snowflake-sqlalchemy_ |
+------------------------------------------------+---------------------------------------+
| Teradata Vantage | teradatasqlalchemy_ |
+------------------------------------------------+---------------------------------------+
| TiDB | sqlalchemy-tidb_ |
+------------------------------------------------+---------------------------------------+
| YDB | ydb-sqlalchemy_ |
+------------------------------------------------+---------------------------------------+
| YugabyteDB | sqlalchemy-yugabytedb_ |
+------------------------------------------------+---------------------------------------+
.. [1] Supports version 1.3.x only at the moment.
.. _openGauss-sqlalchemy: https://pypi.org/project/opengauss-sqlalchemy
.. _rockset-sqlalchemy: https://pypi.org/project/rockset-sqlalchemy
.. _sqlalchemy-ingres: https://github.com/ActianCorp/sqlalchemy-ingres
.. _nzalchemy: https://pypi.org/project/nzalchemy/
.. _ibm-db-sa: https://pypi.org/project/ibm-db-sa/
.. _PyHive: https://github.com/dropbox/PyHive#sqlalchemy
.. _teradatasqlalchemy: https://pypi.org/project/teradatasqlalchemy/
.. _sqlalchemy-bigquery: https://pypi.org/project/sqlalchemy-bigquery/
.. _sqlalchemy-redshift: https://pypi.org/project/sqlalchemy-redshift
.. _sqlalchemy-drill: https://github.com/JohnOmernik/sqlalchemy-drill
.. _sqlalchemy-hana: https://github.com/SAP/sqlalchemy-hana
.. _sqlalchemy-solr: https://github.com/aadel/sqlalchemy-solr
.. _sqlalchemy_exasol: https://github.com/blue-yonder/sqlalchemy_exasol
.. _sqlalchemy-sqlany: https://github.com/sqlanywhere/sqlalchemy-sqlany
.. _sqlalchemy-monetdb: https://github.com/MonetDB/sqlalchemy-monetdb
.. _snowflake-sqlalchemy: https://github.com/snowflakedb/snowflake-sqlalchemy
.. _sqlalchemy-pytds: https://pypi.org/project/sqlalchemy-pytds/
.. _sqlalchemy-cratedb: https://github.com/crate/sqlalchemy-cratedb
.. _sqlalchemy-access: https://pypi.org/project/sqlalchemy-access/
.. _elasticsearch-dbapi: https://github.com/preset-io/elasticsearch-dbapi/
.. _pydruid: https://github.com/druid-io/pydruid
.. _gsheets: https://github.com/betodealmeida/gsheets-db-api
.. _sqlalchemy-firebird: https://github.com/pauldex/sqlalchemy-firebird
.. _sqlalchemy-cockroachdb: https://github.com/cockroachdb/sqlalchemy-cockroachdb
.. _sqlalchemy-turbodbc: https://pypi.org/project/sqlalchemy-turbodbc/
.. _sqlalchemy-sybase: https://pypi.org/project/sqlalchemy-sybase/
.. _firebolt-sqlalchemy: https://pypi.org/project/firebolt-sqlalchemy/
.. _pyathena: https://github.com/laughingman7743/PyAthena/
.. _sqlalchemy-yugabytedb: https://pypi.org/project/sqlalchemy-yugabytedb/
.. _impyla: https://pypi.org/project/impyla/
.. _databend-sqlalchemy: https://github.com/datafuselabs/databend-sqlalchemy
.. _sqlalchemy-greenplum: https://github.com/PlaidCloud/sqlalchemy-greenplum
.. _sqlalchemy-hsqldb: https://pypi.org/project/sqlalchemy-hsqldb/
.. _databricks: https://docs.databricks.com/en/dev-tools/sqlalchemy.html
.. _clickhouse-sqlalchemy: https://pypi.org/project/clickhouse-sqlalchemy/
.. _sqlalchemy-kinetica: https://github.com/kineticadb/sqlalchemy-kinetica/
.. _sqlalchemy-tidb: https://github.com/pingcap/sqlalchemy-tidb
.. _ydb-sqlalchemy: https://github.com/ydb-platform/ydb-sqlalchemy/
.. _denodo-sqlalchemy: https://pypi.org/project/denodo-sqlalchemy/
.. _aurora-dsql-sqlalchemy: https://pypi.org/project/aurora-dsql-sqlalchemy/
|
