From: Mike Bayer Date: Fri, 5 Jul 2019 16:19:55 +0000 (-0400) Subject: Note DBAPIs and dialects that we don't support X-Git-Tag: rel_1_3_6~20 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d36c7d0601b23c6e8a62aad2f242cc423dadbf5f;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git Note DBAPIs and dialects that we don't support Since we have strong CI for the DBAPIs and dialects that are actively supported, this indicates that those DBAPIs that aren't in CI are continuing to fall behind in support, to the point where we can not address issues that may arise. As such, the Sybase and Firebird dialects overall are moving into an explicit "not supported" zone where we would like to eventually remove them. Additionally, a pass is made through legacy MySQL and PostgreSQL DBAPI dialects as well as those which we aren't able to include in CI to note that these DBAPIs aren't actively supported by the project. Change-Id: I61f1515b97b741b7534b54e434e3e47065df7b5d (cherry picked from commit 4bd4bae5c1132e1ca41425f742402d06026a918a) --- diff --git a/doc/build/dialects/index.rst b/doc/build/dialects/index.rst index b8a443ec3f..0d5a904aa8 100644 --- a/doc/build/dialects/index.rst +++ b/doc/build/dialects/index.rst @@ -21,6 +21,18 @@ Included Dialects sqlite oracle mssql + +Included, but not currently supported dialects +---------------------------------------------- + +The following dialects have implementations wtihin SQLAlchemy however are not +part of continuous integration testing nor are they actively developed. +These dialects may be removed in future major releases. + +.. toctree:: + :maxdepth: 1 + :glob: + firebird sybase diff --git a/lib/sqlalchemy/dialects/firebird/base.py b/lib/sqlalchemy/dialects/firebird/base.py index 7ae198f6c9..2e3ecba5d9 100644 --- a/lib/sqlalchemy/dialects/firebird/base.py +++ b/lib/sqlalchemy/dialects/firebird/base.py @@ -10,6 +10,12 @@ r""" .. dialect:: firebird :name: Firebird +.. note:: + + The Firebird dialect within SQLAlchemy **is not currently supported**. The + dialect is not tested within continuous integration and is likely to have + many issues and caveats not currently handled. + Firebird Dialects ----------------- diff --git a/lib/sqlalchemy/dialects/mssql/adodbapi.py b/lib/sqlalchemy/dialects/mssql/adodbapi.py index 0b8cc01dcb..38b4a764f8 100644 --- a/lib/sqlalchemy/dialects/mssql/adodbapi.py +++ b/lib/sqlalchemy/dialects/mssql/adodbapi.py @@ -14,7 +14,7 @@ .. note:: - The adodbapi dialect is not implemented SQLAlchemy versions 0.6 and + The adodbapi dialect is not implemented in SQLAlchemy versions 0.6 and above at this time. """ diff --git a/lib/sqlalchemy/dialects/mysql/cymysql.py b/lib/sqlalchemy/dialects/mysql/cymysql.py index 47bdbbc994..ed9582477e 100644 --- a/lib/sqlalchemy/dialects/mysql/cymysql.py +++ b/lib/sqlalchemy/dialects/mysql/cymysql.py @@ -12,6 +12,12 @@ r""" :connectstring: mysql+cymysql://:@/[?] :url: https://github.com/nakagami/CyMySQL +.. note:: + + The CyMySQL dialect is **not tested as part of SQLAlchemy's continuous + integration** and may have unresolved issues. The recommended MySQL + dialects are mysqlclient and PyMySQL. + """ # noqa from .base import BIT diff --git a/lib/sqlalchemy/dialects/mysql/mysqlconnector.py b/lib/sqlalchemy/dialects/mysql/mysqlconnector.py index e4027351de..90c7db2cd6 100644 --- a/lib/sqlalchemy/dialects/mysql/mysqlconnector.py +++ b/lib/sqlalchemy/dialects/mysql/mysqlconnector.py @@ -12,6 +12,12 @@ r""" :connectstring: mysql+mysqlconnector://:@[:]/ :url: https://pypi.org/project/mysql-connector-python/ +.. note:: + + The MySQL Connector/Python DBAPI has had many issues since its release, + some of which may remain unresolved, and the mysqlconnector dialect is + **not tested as part of SQLAlchemy's continuous integration**. + The recommended MySQL dialects are mysqlclient and PyMySQL. """ # noqa diff --git a/lib/sqlalchemy/dialects/mysql/oursql.py b/lib/sqlalchemy/dialects/mysql/oursql.py index 80313a2fc9..483c24221b 100644 --- a/lib/sqlalchemy/dialects/mysql/oursql.py +++ b/lib/sqlalchemy/dialects/mysql/oursql.py @@ -13,6 +13,12 @@ :connectstring: mysql+oursql://:@[:]/ :url: http://packages.python.org/oursql/ +.. note:: + + The OurSQL MySQL dialect is legacy and is no longer supported upstream, + and is **not tested as part of SQLAlchemy's continuous integration**. + The recommended MySQL dialects are mysqlclient and PyMySQL. + Unicode ------- diff --git a/lib/sqlalchemy/dialects/postgresql/pg8000.py b/lib/sqlalchemy/dialects/postgresql/pg8000.py index e4fc0a970c..05327f81e4 100644 --- a/lib/sqlalchemy/dialects/postgresql/pg8000.py +++ b/lib/sqlalchemy/dialects/postgresql/pg8000.py @@ -11,6 +11,11 @@ r""" :connectstring: postgresql+pg8000://user:password@host:port/dbname[?key=value&key=value...] :url: https://pythonhosted.org/pg8000/ +.. note:: + + The pg8000 dialect is **not tested as part of SQLAlchemy's continuous + integration** and may have unresolved issues. The recommended PostgreSQL + dialect is psycopg2. .. _pg8000_unicode: diff --git a/lib/sqlalchemy/dialects/postgresql/pygresql.py b/lib/sqlalchemy/dialects/postgresql/pygresql.py index 6df77a2978..efeea26f11 100644 --- a/lib/sqlalchemy/dialects/postgresql/pygresql.py +++ b/lib/sqlalchemy/dialects/postgresql/pygresql.py @@ -10,6 +10,13 @@ :dbapi: pgdb :connectstring: postgresql+pygresql://user:password@host:port/dbname[?key=value&key=value...] :url: http://www.pygresql.org/ + +.. note:: + + The pygresql dialect is **not tested as part of SQLAlchemy's continuous + integration** and may have unresolved issues. The recommended PostgreSQL + dialect is psycopg2. + """ # noqa import decimal diff --git a/lib/sqlalchemy/dialects/postgresql/pypostgresql.py b/lib/sqlalchemy/dialects/postgresql/pypostgresql.py index fdb66f29cb..17a80cf025 100644 --- a/lib/sqlalchemy/dialects/postgresql/pypostgresql.py +++ b/lib/sqlalchemy/dialects/postgresql/pypostgresql.py @@ -11,6 +11,12 @@ :connectstring: postgresql+pypostgresql://user:password@host:port/dbname[?key=value&key=value...] :url: http://python.projects.pgfoundry.org/ +.. note:: + + The pypostgresql dialect is **not tested as part of SQLAlchemy's continuous + integration** and may have unresolved issues. The recommended PostgreSQL + driver is psycopg2. + """ # noqa diff --git a/lib/sqlalchemy/dialects/sybase/base.py b/lib/sqlalchemy/dialects/sybase/base.py index 31efed0ab2..71ff629768 100644 --- a/lib/sqlalchemy/dialects/sybase/base.py +++ b/lib/sqlalchemy/dialects/sybase/base.py @@ -16,9 +16,9 @@ .. note:: - The Sybase dialect functions on current SQLAlchemy versions - but is not regularly tested, and may have many issues and - caveats not currently handled. + The Sybase dialect within SQLAlchemy **is not currently supported**. The + dialect is not tested within continuous integration and is likely to have + many issues and caveats not currently handled. """