The Starburst ODBC driver V3 series is described in the following pages:
Keyword | Type | Required | Description | Default |
---|---|---|---|---|
Driver |
String | Yes unless DSN is specified |
Set to Starburst ODBC Driver . |
|
Server /Host |
String | Yes | Specify the host name or IP address of your Starburst server. When you specify both keywords, Server overrides Host . |
|
Port |
Integer | Yes | Specify the port number where your Starburst cluster's coordinator is listening. | |
AuthenticationType |
String | Yes | Specify how to authenticate with the Starburst server. Choose from: None , Password , WindowsPassword , WindowsIntegrated , JWT , or OAuth2 . |
|
UID |
String | Yes if AuthenticationType = Password |
Provide the username for Password authentication. |
|
PWD |
String | Yes if AuthenticationType = Password |
Provide the password for Password authentication. |
|
KerberosUsername |
String | Yes if AuthenticationType = WindowsPassword |
Provide the username for WindowsPassword authentication. |
|
KerberosPassword |
String | Yes if AuthenticationType = WindowsPassword |
Provide the password for WindowsPassword authentication. |
|
AccessToken |
String | Yes if AuthenticationType = JWT |
Provide the JWT access token for JWT authentication. |
|
Database /Catalog |
String | No | Set the current catalog context for all queries you run on the Starburst server. When you specify both keywords, Database overrides Catalog . |
|
Schema |
String | No | Set the current schema context for all queries you run on the Starburst server. | |
SSL |
Boolean | No | Enable TLS/HTTPS for connections. You must set this to true unless you set AuthenticationType to None . |
false |
SSLVerification |
String | No | Choose the TLS verification level. Choose from None (certificate not verified), CA (certificate verified but hostname mismatch allowed), or Full (standard TLS verification performed). |
Full |
SSLTrustStore |
String | No | Specify the path to a PEM file containing certificates you trust that are not included in the system truststore. |
Keyword | Type | Required | Description | Default |
---|---|---|---|---|
HTTPProxy |
String | No | Specify your HTTP proxy server host and port in host:port format. |
|
ProxyUid |
String | No | Provide the username for your proxy server. | |
ProxyPwd |
String | No | Provide the password for your proxy server. | |
NonProxyHosts |
String | No | Specify a comma-separated list of domains and IPs to reach directly, bypassing the proxy. The driver matches each name in the list as either a domain that contains the host name, or the host name itself. For more information, see the curl documentation. |
Keyword | Type | Required | Description | Default |
---|---|---|---|---|
AllowHTTPRedirect |
Boolean | No | Allow the driver to follow HTTP redirects when communicating with the Starburst server. | true |
ApplicationName |
String | No | Specify the name of your application. | Executable file name of the current process. |
CacheOAuthToken |
Boolean | No | Cache and reuse access tokens when the same user, using the same application, accesses the same Starburst server. This cache operates when you set AuthenticationType to OAuth2 . Note that the driver does not cache refresh tokens. |
true |
ClientTags |
String | No | Provide a comma-separated list of client tags for selecting resource groups. | |
DefaultVarcharLength |
Integer | No | Set the default length for unbounded varchar columns and parameters. |
2048 |
ExtraCredentials |
String | No | Provide a comma-separated list of key:value pairs for connecting to external services. |
|
IgnoreBrokenCatalog |
Boolean | No | Ignore broken catalogs when querying database metadata. A catalog is broken when it's not accessible for any reason, such as invalid configuration or lack of permissions. | true |
Roles |
String | No | Provide a comma-separated list of catalog:role pairs for authorization. |
|
SessionProperties |
String | No | Provide a comma-separated list of property:value pairs to set Starburst session properties. |
|
SessionUser |
String | No | Set the effective user of the session. This allows you to log in as an authenticated user while impersonating another user. For more information, see the Trino documentation. | |
Timezone ID |
String | No | Set the timezone to use for processing time and timestamp data. For valid timezone IDs, see the TZ identifier column in the tz database time zones list.
|
The timezone of the computer running the ODBC driver. |
You can configure log settings globally through the DSN configuration dialog.
The following options are included for reference. You cannot set them in a connection string. In Windows, configure these options by clicking the DSN configuration dialog’s Logging… button.
Keyword | Type | Required | Description | Default |
---|---|---|---|---|
LogLevel | String | No | Set the log level for driver logging. Choose from: Off , Fatal , Error , Warn , Info , Debug , Trace or their numeric equivalents 0 , 1 , 2 , 3 , 4 , 5 , 6 respectively. |
Off |
LogPath | String | No | Specify the folder where log files are saved. | Windows: %USERPROFILE% , or if not available, %HOMEDRIVE%%HOMEPATH% macOS/Linux: getpwuid() , or if not available, $HOME |
LogFileCount | Integer | No | Set the maximum number of log files to keep. When this limit is reached, the driver deletes the oldest log file each time it creates a new one. | 50 |
LogFileSize | Integer | No | Set the maximum size of each log file in bytes. When this limit is reached, the driver creates a new file and continues logging. | 20971520 |
Is the information on this page helpful?
Yes
No