From 8cf7a7f664c177a8a7299186af338c6a23768da0 Mon Sep 17 00:00:00 2001 From: Federico Caselli Date: Sat, 13 Feb 2021 21:20:58 +0100 Subject: [PATCH] Add supported database version for internal dialects Change-Id: I08d150f1780a0f3a848c0edcd40013b5593d18f0 --- doc/build/dialects/index.rst | 30 ++++++++++++++++++++++ doc/build/glossary.rst | 1 + lib/sqlalchemy/dialects/mssql/base.py | 4 ++- lib/sqlalchemy/dialects/mysql/base.py | 3 +++ lib/sqlalchemy/dialects/oracle/base.py | 6 ++--- lib/sqlalchemy/dialects/postgresql/base.py | 3 +++ lib/sqlalchemy/dialects/sqlite/base.py | 3 +++ 7 files changed, 46 insertions(+), 4 deletions(-) diff --git a/doc/build/dialects/index.rst b/doc/build/dialects/index.rst index e4a7e932f7..741b00d2f8 100644 --- a/doc/build/dialects/index.rst +++ b/doc/build/dialects/index.rst @@ -22,6 +22,36 @@ Included Dialects oracle mssql +Support Levels 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 +^^^^^^^^^^^^^^^^^^^ + +.. glossary:: + + 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. + + Normal support + **Normal support** indicates that most features should work, + but not all versions are tested in the ci configuration so there may + be some not supported edge cases. We will try to fix issues that affect + these versions. + + Best effort + **Best effort** indicates that we try to support basic features on them, + 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. + + Deprecated, no longer supported dialects ---------------------------------------- diff --git a/doc/build/glossary.rst b/doc/build/glossary.rst index f5ebe0a7da..2939fdf34c 100644 --- a/doc/build/glossary.rst +++ b/doc/build/glossary.rst @@ -1496,3 +1496,4 @@ Glossary .. seealso:: :ref:`session_object_states` + diff --git a/lib/sqlalchemy/dialects/mssql/base.py b/lib/sqlalchemy/dialects/mssql/base.py index 81f66e2f09..1be3965b8f 100644 --- a/lib/sqlalchemy/dialects/mssql/base.py +++ b/lib/sqlalchemy/dialects/mssql/base.py @@ -7,7 +7,9 @@ """ .. dialect:: mssql :name: Microsoft SQL Server - + :full_support: 2017 + :normal_support: 2012+ + :best_effort: 2005+ .. _mssql_external_dialects: diff --git a/lib/sqlalchemy/dialects/mysql/base.py b/lib/sqlalchemy/dialects/mysql/base.py index af35b3279b..e6052f69f7 100644 --- a/lib/sqlalchemy/dialects/mysql/base.py +++ b/lib/sqlalchemy/dialects/mysql/base.py @@ -9,6 +9,9 @@ r""" .. dialect:: mysql :name: MySQL / MariaDB + :full_support: 5.6, 5.7, 8.0 / 10.4, 10.5 + :normal_support: 5.6+ / 10+ + :best_effort: 5.0.2+ / 5.0.2+ Supported Versions and Features ------------------------------- diff --git a/lib/sqlalchemy/dialects/oracle/base.py b/lib/sqlalchemy/dialects/oracle/base.py index f9805abeb2..88b1018113 100644 --- a/lib/sqlalchemy/dialects/oracle/base.py +++ b/lib/sqlalchemy/dialects/oracle/base.py @@ -8,9 +8,9 @@ r""" .. dialect:: oracle :name: Oracle - - Oracle version 8 through current (11g at the time of this writing) are - supported. + :full_support: 11.2, 18c + :normal_support: 11+ + :best_effort: 8+ Auto Increment Behavior diff --git a/lib/sqlalchemy/dialects/postgresql/base.py b/lib/sqlalchemy/dialects/postgresql/base.py index d34d8dd17b..aea5ca17ca 100644 --- a/lib/sqlalchemy/dialects/postgresql/base.py +++ b/lib/sqlalchemy/dialects/postgresql/base.py @@ -8,6 +8,9 @@ r""" .. dialect:: postgresql :name: PostgreSQL + :full_support: 9.6, 10, 11, 12 + :normal_support: 9.6+ + :best_effort: 8+ .. _postgresql_sequences: diff --git a/lib/sqlalchemy/dialects/sqlite/base.py b/lib/sqlalchemy/dialects/sqlite/base.py index 8582c1f14e..691ca642d1 100644 --- a/lib/sqlalchemy/dialects/sqlite/base.py +++ b/lib/sqlalchemy/dialects/sqlite/base.py @@ -8,6 +8,9 @@ r""" .. dialect:: sqlite :name: SQLite + :full_support: 3.21, 3.28+ + :normal_support: 3.12+ + :best_effort: 3.7.16+ .. _sqlite_datetime: -- 2.47.2