Skip to content

Commit 7fb09c9

Browse files
Update documentation to add sqlserver authentication properties
1 parent 1fc513c commit 7fb09c9

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

presto-docs/src/main/sphinx/connector/sqlserver.rst

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,46 @@ A connection string using a truststore would be similar to the following example
6262

6363
connection-url=jdbc:sqlserver://<host>:<port>;databaseName=<databaseName>;encrypt=true;trustServerCertificate=false;trustStoreType=PEM;hostNameInCertificate=hostname;trustStore=path/to/truststore.pem;trustStorePassword=password
6464

65+
.. note::
66+
67+
Starting from release 0.292, the default value of ``encrypt`` has changed from ``false`` to ``true``.
68+
69+
70+
Authentication
71+
^^^^^^^^^^^^^^
72+
+--------------------------+-----------------------------------------------------------------+------------------+
73+
| **Property** | **Description** | **Default Value**|
74+
+--------------------------+-----------------------------------------------------------------+------------------+
75+
| ``integratedSecurity`` | Enables Windows Authentication for SQL Server. | ``false`` |
76+
| | | |
77+
| | - Set to ``true`` with ``authenticationScheme=JavaKerberos`` | |
78+
| | to indicate that Kerberos credentials are used by SQL Server. | |
79+
| | - Set to ``true`` with ``authenticationScheme=NTLM`` to | |
80+
| | indicate that NTLM credentials are used by SQL Server. | |
81+
+--------------------------+-----------------------------------------------------------------+------------------+
82+
| ``authentication`` | Specifies the authentication method to use for connection. | ``NotSpecified`` |
83+
| | Possible values: | |
84+
| | | |
85+
| | - ``NotSpecified`` | |
86+
| | - ``SqlPassword`` | |
87+
| | - ``ActiveDirectoryPassword`` | |
88+
| | - ``ActiveDirectoryIntegrated`` | |
89+
| | - ``ActiveDirectoryManagedIdentity`` | |
90+
| | - ``ActiveDirectoryMSI`` | |
91+
| | - ``ActiveDirectoryInteractive`` | |
92+
| | - ``ActiveDirectoryServicePrincipal`` | |
93+
+--------------------------+-----------------------------------------------------------------+------------------+
94+
95+
Below is a sample connection URL with the NTLM authentication:
96+
97+
.. code-block:: none
98+
99+
connection-url=jdbc:sqlserver://<host>:<port>;databaseName=<databaseName>;encrypt=true;trustServerCertificate=false;integratedSecurity=true;authenticationScheme=NTLM;
100+
101+
102+
Refer to `setting the connection properties <https://learn.microsoft.com/en-us/sql/connect/jdbc/setting-the-connection-properties?view=sql-server-ver16>`_ from the Microsoft official documentation.
103+
104+
65105
Multiple SQL Server Databases or Servers
66106
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
67107

0 commit comments

Comments
 (0)