atoti_directquery_synapse.connection_info module

class atoti_directquery_synapse.SynapseConnectionInfo

Information needed to connect to a Synapse database.

__init__(url, /, *, password=None)

Create a Synapse connection info.

Parameters:

• url (str) – The JDBC connection string. See https://docs.microsoft.com/en-us/azure/synapse-analytics/sql/connection-strings#sample-jdbc-connection-string for more information.

• password (str | None) –

  The password to connect to the database.

  Passing it in this separate parameter allows to avoid having it logged alongside the connection string.

  If None, a password is expected to be present in the passed url.

Example

>>> import os
>>> from atoti_directquery_synapse import SynapseConnectionInfo
>>> connection_info = SynapseConnectionInfo(
...     "jdbc:sqlserver://"
...     + account_identifier
...     + ".sql.azuresynapse.net;authentication="
...     + os.environ["SYNAPSE_AUTHENTICATION_METHOD"]
...     + ";user="
...     + os.environ["SYNAPSE_USERNAME"],
...     password=os.environ["SYNAPSE_PASSWORD"],
... )