summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorGord Thompson <gord@gordthompson.com>2020-04-18 17:04:03 -0600
committerMike Bayer <mike_mp@zzzcomputing.com>2020-04-20 09:12:25 -0400
commit0358e275dd960f5bddd11342c6502f7769e2a9f5 (patch)
treebcd95f4b6c8ee92d8bd1d6c10430ff6f43b1d947 /lib
parent2f617f56f2acdce00b88f746c403cf5ed66d4d27 (diff)
downloadsqlalchemy-0358e275dd960f5bddd11342c6502f7769e2a9f5.tar.gz
Update pymssql information for mssql dialect
Change-Id: I94cf63299a094b53e7078b282311f7d0faa256a6
Diffstat (limited to 'lib')
-rw-r--r--lib/sqlalchemy/dialects/mssql/pymssql.py23
1 files changed, 18 insertions, 5 deletions
diff --git a/lib/sqlalchemy/dialects/mssql/pymssql.py b/lib/sqlalchemy/dialects/mssql/pymssql.py
index 2d355d964..ef15bb266 100644
--- a/lib/sqlalchemy/dialects/mssql/pymssql.py
+++ b/lib/sqlalchemy/dialects/mssql/pymssql.py
@@ -10,14 +10,27 @@
:name: pymssql
:dbapi: pymssql
:connectstring: mssql+pymssql://<username>:<password>@<freetds_name>/?charset=utf8
- :url: http://pymssql.org/
pymssql is a Python module that provides a Python DBAPI interface around
-`FreeTDS <http://www.freetds.org/>`_. Compatible builds are available for
-Linux, MacOSX and Windows platforms.
+`FreeTDS <http://www.freetds.org/>`_.
+
+Modern versions of this driver worked very well with SQL Server and FreeTDS
+from Linux and were highly recommended. However, pymssql is currently
+unmaintained and has fallen behind the progress of the Microsoft ODBC driver in
+its support for newer features of SQL Server. The latest official release of
+pymssql at the time of this docuemnt is August, 2018 and lacks support for:
+
+1. table-valued parameters (TVPs),
+2. ``datetimeoffset`` columns using timezone-aware ``datetime`` objects
+ (values are sent and retrieved as strings), and
+3. encrypted connections (e.g., to Azure SQL), when pymssql is installed from
+ the pre-built wheels. Support for encrypted connections requires building
+ pymssql from source, which can be a nuisance, especially under Windows.
+
+The above features are all supported by mssql+pyodbc when using Microsoft's
+ODBC Driver for SQL Server (msodbcsql), which is now available for Windows,
+(several flavors of) Linux, and macOS.
-Modern versions of this driver work very well with SQL Server and
-FreeTDS from Linux and is highly recommended.
""" # noqa
import re