Skip to content

Commit b194ab3

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

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

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

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,41 @@ 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+
Authentication
66+
^^^^^^^^^^^^^^
67+
+--------------------------+-----------------------------------------------------------------+------------------+
68+
| **Property** | **Description** | **Default Value**|
69+
+--------------------------+-----------------------------------------------------------------+------------------+
70+
| ``integratedSecurity`` | Enables Windows Authentication for SQL Server. | ``false`` |
71+
| | | |
72+
| | - Set to ``true`` with ``authenticationScheme=JavaKerberos`` | |
73+
| | to indicate that Kerberos credentials are used by SQL Server. | |
74+
| | - Set to ``true`` with ``authenticationScheme=NTLM`` to | |
75+
| | indicate that NTLM credentials are used by SQL Server. | |
76+
+--------------------------+-----------------------------------------------------------------+------------------+
77+
| ``authentication`` | Specifies the authentication method to use for connection. | ``NotSpecified`` |
78+
| | Possible values: | |
79+
| | | |
80+
| | - ``NotSpecified`` | |
81+
| | - ``SqlPassword`` | |
82+
| | - ``ActiveDirectoryPassword`` | |
83+
| | - ``ActiveDirectoryIntegrated`` | |
84+
| | - ``ActiveDirectoryManagedIdentity`` | |
85+
| | - ``ActiveDirectoryMSI`` | |
86+
| | - ``ActiveDirectoryInteractive`` | |
87+
| | - ``ActiveDirectoryServicePrincipal`` | |
88+
+--------------------------+-----------------------------------------------------------------+------------------+
89+
90+
Below is a sample connection URL with the NTLM authentication:
91+
92+
.. code-block:: none
93+
94+
connection-url=jdbc:sqlserver://<host>:<port>;databaseName=<databaseName>;encrypt=true;trustServerCertificate=false;integratedSecurity=true;authenticationScheme=NTLM;
95+
96+
97+
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.
98+
99+
65100
Multiple SQL Server Databases or Servers
66101
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
67102

0 commit comments

Comments
 (0)