Skip to content

Commit 72079e3

Browse files
author
Ramiro Morales
committed
docs: Document FreeTDS SSL requirement for Azure connections.
1 parent 56fb06f commit 72079e3

4 files changed

Lines changed: 19 additions & 5 deletions

File tree

README_building_and_developing.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,13 @@ To build pymssql you should have:
1515
software distribution channels, e.g, ``freetds-dev`` or ``freetds-devel``
1616
packages.
1717

18+
.. note::
19+
If you need to connect to Azure:
20+
21+
* Use FreeTDS 0.91 or newer
22+
* Make sure FreeTDS is built with SSL support. Instructions on how to do
23+
this are out of the scope of this document.
24+
1825
Windows
1926
-------
2027

docs/building_and_developing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
.. include:: ../README_building_and_developing.rst
22

3-
.. Please see the `README:building_and_developing.rst` file located in the root of the pymssql source
3+
.. Please see the `README_building_and_developing.rst` file located in the root of the pymssql source
44
code tree.

docs/ref/_mssql.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,12 @@ Functions
9898
*conn_properties* wasn't customizable and its value was hard-coded to
9999
the literal shown above.
100100

101-
.. note:: If you need to connect to Azure make sure you use FreeTDS 0.91 or newer.
101+
.. note::
102+
If you need to connect to Azure:
103+
104+
* Use FreeTDS 0.91 or newer
105+
* Make sure FreeTDS is built with SSL support
106+
* Specify the database name you are connecting to in the *database* parameter
102107

103108
.. versionadded:: 2.1.1
104109
The ability to connect to Azure.

docs/ref/pymssql.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,11 @@ Functions
6565
timeouts have a global effect.
6666

6767
.. note::
68-
If you need to connect to Azure make sure you:
69-
* Use FreeTDS 0.91 or newer.
70-
* Specify the database name you are connecting to in the ``connect()`` call.
68+
If you need to connect to Azure:
69+
70+
* Use FreeTDS 0.91 or newer
71+
* Make sure FreeTDS is built with SSL support
72+
* Specify the database name you are connecting to in the ``connect()`` call
7173

7274
.. versionadded:: 2.1.1
7375
The ability to connect to Azure.

0 commit comments

Comments
 (0)