AuthMode

Authentication mode. The driver authenticates with username + password by default; supplying Token= uses a bearer credential instead.

Category: connection-string

Syntax

AuthMode=Password

Description

## Two practical paths | What you supply | What happens | |---|---| | `Uid=` and `Pwd=` (the default) | The driver posts the credentials to the control plane's auth endpoint and receives a session token used for the rest of the connection. | | `Token=` | The driver presents the supplied token directly on every request to the engine; no auth round-trip. The token is typically a Delta Forge personal access token (prefix `df_pat_`) generated from the desktop app's **Settings -> Personal Access Tokens** page. | If both `Pwd=` and `Token=` are omitted, the driver looks `Pwd:<Uid>` (and as a secondary fallback `Token:<Uid>`) up in the OS credential store under the DSN name; see `ODBC_CRED_STORE`. ## Aliases The parser accepts `Authentication=` and `AuthMech=` so connection strings copied from Tableau, Databricks, or Spark tooling are not rejected for an unknown key. They map to the native `AuthMode=` slot. ## Refresh The driver does not refresh the token mid-session. If a session token expires, the next request fails with an authentication SQLSTATE; the application is expected to disconnect and reconnect.

Parameters

Name	Type	Description
`AuthMode`		Reserved key for selecting the authentication mode. The default and currently active mode is `Password`. Aliases `Authentication=` and `AuthMech=` are accepted to keep connection strings copied from other vendors from being rejected at parse time.

Examples

# Username + password (the default; the AuthMode key may be omitted)
Uid=alice@example.com;Pwd=hunter2

# Bearer token (no AuthMode required; supplying Token= is sufficient)
Token=df_pat_abcd1234...

Pitfalls

`AuthMode=` is parsed but the value is currently informational; behaviour is determined by which credential keys you supply (`Pwd=` or `Token=`).
A leading or trailing whitespace in `Token=` is preserved by the parser; many auth providers reject tokens with surrounding whitespace, producing a confusing authentication error. Trim before assigning.