]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
Update pymssql information for mssql dialect
authorGord Thompson <gord@gordthompson.com>
Sat, 18 Apr 2020 23:04:03 +0000 (17:04 -0600)
committerMike Bayer <mike_mp@zzzcomputing.com>
Mon, 20 Apr 2020 13:12:25 +0000 (09:12 -0400)
Change-Id: I94cf63299a094b53e7078b282311f7d0faa256a6

lib/sqlalchemy/dialects/mssql/pymssql.py

index 2d355d964dc1fc607e043bda8dea59c2cddf4e82..ef15bb26604b2dbae543b99f81a4183dfeb7a286 100644 (file)
     :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