Mapping keywords from V2 to V3 #

The Starburst ODBC driver V3 series is described in the following pages:

Connection string keyword changes #

Some connection string keywords are renamed or removed in the v3 release. The following table shows how the old keywords map to the new ones:

Keyword Note
AccessTokenUnchanged.
AllowHostNameCNMismatchDeprecated. See the SSLVerification conversion section.
AllowHTTPRedirectThe default value changed from false to true.
AllowMetadataFromMultipleCatalogsNot implemented yet.
AllowSelfSignedServerCertDeprecated. See the SSLVerification conversion section.
ApplicationNameUnchanged.
ApplicationNamePrefixDeprecated, use ApplicationName instead.
AuthenticationTypeSee the AuthenticationType conversion section.
AutoCommitObsolete. No longer applicable.
AutoIPDObsolete. No longer applicable.
CacheAccessTokenDeprecated. Use CacheOAuthToken instead.
CacheOAuthTokenNew. Replaces CacheAccessToken.
CallingAppNameObsolete. No longer applicable.
CatalogDeprecated. Use Database instead.
CheckCertRevocationObsolete. CRL is always checked.
ClientCertObsolete. No longer applicable.
ClientPrivateKeyObsolete. No longer applicable.
ClientPrivateKeyPasswordObsolete. No longer applicable.
ClientTagsUnchanged.
ConnectionTestObsolete. No longer applicable.
DatabaseNew. Replaces Catalog.
DefaultVarcharLengthNew. Replaces MaxDefaultVarCharLength.
DelegateKrbCredsObsolete. Configure this in your Kerberos KDC instead.
DelegationUIDDeprecated. Use SessionUser instead.
DriverUnchanged.
EffectiveUserNameDeprecated. Use SessionUser instead.
ExtraCredentialsUnchanged.
HostDeprecated. Use Server instead.
HTTPProxyNew. Replaces UseProxy, ProxyHost and ProxyPort.
IgnoreBrokenCatalogThe default value changed from false to true.
KerberosKeytabNot implemented yet.
KerberosPasswordUnchanged.
KerberosUsernameUnchanged.
KinitTypeDeprecated. Set AuthenticationType accordingly.
KrbServiceNameNot implemented yet.
LogFileCountUnchanged.
LogFileSizeUnchanged.
LogLevelUnchanged.
LogPathUnchanged.
MaxCatalogNameLenObsolete. There is no length limit for catalog names.
MaxColumnNameLenObsolete. There is no length limit for column names.
MaxComplexTypeColumnLengthObsolete. The max length for complex types (e.g. row, JSON) is 2147483647.
MaxDefaultVarCharLengthDeprecated. Use DefaultVarcharLength instead.
MaxPreparedStatementLengthObsolete. There is no length limit for prepared statements.
MaxSchemaNameLengthObsolete. There is no length limit for schema names.
MaxTableNameLenObsolete. There is no length limit for table names.
Min_TLSObsolete. The driver always uses the Starburst server TLS level.
MuteServerWarningsObsolete. Use SessionProperties to prevent specific warnings.
NonProxyHostsNew.
PortUnchanged.
ProxyHostDeprecated. Use HTTPProxy instead.
ProxyPortDeprecated. Use HTTPProxy instead.
ProxyPwdUnchanged.
ProxyUidUnchanged.
PWDUnchanged.
RemoveTypeNameParametersObsolete. Type names never have parameters.
RolesUnchanged.
SchemaUnchanged.
ServerNew. Replaces Host.
ServerVersionObsolete. No longer applicable.
SessionPropertiesUnchanged.
SessionUserUnchanged.
SSLUnchanged.
SSLVerificationNew.
TimeZoneIDUnchanged.
TrustedCertsUnchanged.
TwoWaySSLObsolete. No longer applicable.
UIDUnchanged.
UseDSNSchemaForMetadataObsolete. No longer applicable.
UseEqualInMetadataFiltersObsolete. No longer applicable.
UseExistingKrbCredsDeprecated. Set AuthenticationType instead.

AuthenticationType conversion #

The following table shows how old AuthenticationType values map to new AuthenticationType values:

Old value New value
No Authentication None
LDAP Authentication Password
JWT Authentication JWT
OIDC Authentication OAuth2
Kerberos Authentication If your current configuration uses DelegateKrbCreds = 1, use WindowsIntegrated.

If your current configuration uses KInitType = KInit with Password, use WindowsPassword.

If your current configuration uses KInitType = KInit with Keytab, use WindowsKeytab (not implemented yet).

SSLVerification conversion #

The AllowSelfSignedServerCert and AllowHostNameCNMismatch keywords are deprecated but continue to work. The recommended V3 settings are:

  • If your current configuration uses AllowSelfSignedServerCert = true, set SSLVerification = None.
  • If your current configuration uses AllowHostNameCNMismatch = true, set SSLVerification = CA.
  • Otherwise, set SSLVerification = Full.