Package com.databricks.jdbc.api.internal

## Interface IDatabricksConnectionContext

All Known Implementing Classes:
  `DatabricksConnectionContext`

    public interface IDatabricksConnectionContext

### Method Summary

All Methods Instance Methods Abstract Methods
`boolean` `acceptUndeterminedCertificateRevocation()`
`boolean` `allowSelfSignedCerts()` Returns whether self-signed certificates are allowed for SSL connections.
`boolean` `checkCertificateRevocation()`
`int` `getAsyncExecPollInterval()`
`String` `getAuthEndpoint()` Returns the OAuth2 authorization endpoint URL for the authorization code flow.
`AuthFlow` `getAuthFlow()`
`AuthMech` `getAuthMech()`
`String` `getAuthScope()` Returns the OAuth2 authentication scope used in the request.
`String` `getAzureTenantId()` Returns the Azure tenant ID for the Azure Databricks workspace.
`String` `getAzureWorkspaceResourceId()`
`String` `getCatalog()`
`String` `getClientId()`
`Map<String,​String>` `getClientInfoProperties()`
`String` `getClientSecret()`
`DatabricksClientType` `getClientType()`
`String` `getClientUserAgent()` Returns the userAgent string specific to client used to fetch results.
`com.databricks.sdk.core.utils.Cloud` `getCloud()`
`com.databricks.sdk.core.ProxyConfig.ProxyAuthType` `getCloudFetchProxyAuthType()`
`String` `getCloudFetchProxyHost()`
`String` `getCloudFetchProxyPassword()`
`int` `getCloudFetchProxyPort()`
`String` `getCloudFetchProxyUser()`
`int` `getCloudFetchThreadPoolSize()` Returns the number of threads to be used for fetching data from cloud storage
`CompressionCodec` `getCompressionCodec()`
`IDatabricksComputeResource` `getComputeResource()` Returns warehouse-Id as parsed from JDBC connection Url
`String` `getConnectionURL()`
`String` `getConnectionUuid()` Returns a unique identifier for this connection context.
`String` `getCustomerUserAgent()` Returns the userAgent string specified as part of the JDBC connection string
`Map<String,​String>` `getCustomHeaders()` Returns the custom headers set in the JDBC connection string.
`int` `getDefaultStringColumnLength()` Returns maximum number of characters that can be contained in STRING columns.
`Boolean` `getDirectResultMode()`
`String` `getEndpointURL()`
`String` `getGcpAuthType()`
`String` `getGoogleCredentials()`
`String` `getGoogleServiceAccount()`
`String` `getHostForOAuth()`
`String` `getHostUrl()` Returns host-Url for Databricks server as parsed from JDBC connection in format `https://server:port`
`int` `getHttpConnectionPoolSize()` Returns the size for HTTP connection pool
`String` `getHttpPath()`
`int` `getIdleHttpConnectionExpiry()`
`String` `getJWTAlgorithm()` Returns the algorithm used for signing the JWT (e.g., RS256, ES256).
`String` `getJWTKeyFile()` Returns the file path to the JWT private key used for signing the JWT.
`String` `getJWTPassphrase()` Returns the passphrase to decrypt the private key if the key is encrypted.
`String` `getKID()` Returns the Key ID (KID) used in the JWT header, identifying the key.
`int` `getLogFileCount()`
`int` `getLogFileSize()`
`LogLevel` `getLogLevel()`
`String` `getLogPathString()`
`int` `getMaxBatchSize()` Returns the maximum number of commands that can be executed in a single batch.
`String` `getNonProxyHosts()` Returns the non-proxy hosts that should be excluded from proxying.
`String` `getNullableClientId()`
`List<Integer>` `getOAuth2RedirectUrlPorts()` Returns the list of OAuth2 redirect URL ports used for OAuth authentication.
`String` `getOAuthDiscoveryURL()` Returns the discovery URL used to obtain the OAuth2 token and authorization endpoints.
`String` `getOAuthRefreshToken()` Returns the OAuth2 refresh token used to obtain a new access token when the current one expires.
`List<String>` `getOAuthScopesForU2M()`
`String` `getPassThroughAccessToken()` Returns the pass through access token
`com.databricks.sdk.core.ProxyConfig.ProxyAuthType` `getProxyAuthType()`
`String` `getProxyHost()`
`String` `getProxyPassword()`
`int` `getProxyPort()`
`String` `getProxyUser()`
`int` `getRateLimitRetryTimeout()`
`int` `getRowsFetchedPerBlock()` Returns maximum number of rows that a query returns at a time.
`String` `getSchema()`
`Map<String,​String>` `getSessionConfigs()`
`int` `getSocketTimeout()` Returns the socket timeout in seconds for HTTP connections.
`String` `getSSLTrustStore()` Returns the SSL trust store file path used for SSL connections.
`String` `getSSLTrustStorePassword()` Returns the SSL trust store password of the trust store file.
`String` `getSSLTrustStoreType()` Returns the SSL trust store type of the trust store file.
`int` `getTelemetryBatchSize()` Returns the batch size for Telemetry logs processing
`int` `getTemporarilyUnavailableRetryTimeout()`
`String` `getToken()` Returns the auth token (personal access token)
`String` `getTokenCachePassPhrase()` Returns the passphrase used for encrypting/decrypting token cache
`String` `getTokenEndpoint()` Returns the OAuth2 token endpoint URL for retrieving tokens.
`List<Integer>` `getUCIngestionRetriableHttpCodes()` Returns the list of HTTP codes to retry for UC Volume Ingestion
`int` `getUCIngestionRetryTimeoutSeconds()` Returns retry timeout in seconds for UC Volume Ingestion
`Boolean` `getUseCloudFetchProxy()`
`Boolean` `getUseEmptyMetadata()`
`Boolean` `getUseProxy()`
`Boolean` `getUseSystemProxy()`
`String` `getVolumeOperationAllowedPaths()` Returns allowlisted local file paths for UC Volume operations
`boolean` `isAllPurposeCluster()`
`boolean` `isComplexDatatypeSupportEnabled()` Returns true if driver return complex data type java objects natively as opposed to string
`boolean` `isOAuthDiscoveryModeEnabled()` Returns whether OAuth2 discovery mode is enabled, which fetches endpoints dynamically.
`boolean` `isPropertyPresent​(DatabricksJdbcUrlParams urlParam)`
`boolean` `isRequestTracingEnabled()` Returns true if request tracing should be enabled.
`boolean` `isSqlExecHybridResultsEnabled()` Returns true if driver should use hybrid results in SQL_EXEC API.
`boolean` `isTelemetryEnabled()` Checks if Telemetry is enabled
`boolean` `isTokenCacheEnabled()` Returns whether token caching is enabled for OAuth authentication
`void` `setClientType​(DatabricksClientType clientType)`
`Boolean` `shouldEnableArrow()`
`Boolean` `shouldRetryRateLimitError()`
`Boolean` `shouldRetryTemporarilyUnavailableError()`
`boolean` `supportManyParameters()`
`boolean` `useJWTAssertion()` Returns whether JWT assertion should be used for OAuth2 authentication.
`boolean` `useSystemTrustStore()` Returns whether the system property trust store should be used for SSL certificate validation.

### Method Detail

#### getHostUrl

    String getHostUrl()
               throws DatabricksParsingException

Returns host-Url for Databricks server as parsed from JDBC connection in format `https://server:port`

Returns:
  Databricks host-Url
Throws:
  `DatabricksParsingException`

#### getComputeResource

    IDatabricksComputeResource getComputeResource()

Returns warehouse-Id as parsed from JDBC connection Url

Returns:
  warehouse-Id

#### getToken

    String getToken()

Returns the auth token (personal access token)

Returns:
  auth token

#### getPassThroughAccessToken

    String getPassThroughAccessToken()

Returns the pass through access token

Returns:
  access token

#### getHostForOAuth

    String getHostForOAuth()

#### getClientId

    String getClientId()
                throws DatabricksParsingException

Throws:
  `DatabricksParsingException`

#### getNullableClientId

    String getNullableClientId()

#### getClientSecret

    String getClientSecret()

#### getOAuthScopesForU2M

    List<String> getOAuthScopesForU2M()
                               throws DatabricksParsingException

Throws:
  `DatabricksParsingException`

#### getAuthMech

    AuthMech getAuthMech()

#### getAuthFlow

    AuthFlow getAuthFlow()

#### isPropertyPresent

    boolean isPropertyPresent​(DatabricksJdbcUrlParams urlParam)

#### getLogLevel

    LogLevel getLogLevel()

#### getLogPathString

    String getLogPathString()

#### getLogFileSize

    int getLogFileSize()

#### getLogFileCount

    int getLogFileCount()

#### getClientUserAgent

    String getClientUserAgent()

Returns the userAgent string specific to client used to fetch results.

#### getCompressionCodec

    CompressionCodec getCompressionCodec()

#### getCustomerUserAgent

    String getCustomerUserAgent()

Returns the userAgent string specified as part of the JDBC connection string

#### getCatalog

    String getCatalog()

#### getSchema

    String getSchema()

#### getSessionConfigs

    Map<String,​String> getSessionConfigs()

#### getClientInfoProperties

    Map<String,​String> getClientInfoProperties()

#### getCustomHeaders

    Map<String,​String> getCustomHeaders()

Returns the custom headers set in the JDBC connection string.

Returns:
  Map of custom headers

#### isAllPurposeCluster

    boolean isAllPurposeCluster()

#### getHttpPath

    String getHttpPath()

#### getProxyHost

    String getProxyHost()

#### getProxyPort

    int getProxyPort()

#### getProxyUser

    String getProxyUser()

#### getProxyPassword

    String getProxyPassword()

#### getUseProxy

    Boolean getUseProxy()

#### getProxyAuthType

    com.databricks.sdk.core.ProxyConfig.ProxyAuthType getProxyAuthType()

#### getUseSystemProxy

    Boolean getUseSystemProxy()

#### getUseCloudFetchProxy

    Boolean getUseCloudFetchProxy()

#### getCloud

    com.databricks.sdk.core.utils.Cloud getCloud()
                                          throws DatabricksParsingException

Throws:
  `DatabricksParsingException`

#### getCloudFetchProxyHost

    String getCloudFetchProxyHost()

#### getCloudFetchProxyPort

    int getCloudFetchProxyPort()

#### getCloudFetchProxyUser

    String getCloudFetchProxyUser()

#### getCloudFetchProxyPassword

    String getCloudFetchProxyPassword()

#### getCloudFetchProxyAuthType

    com.databricks.sdk.core.ProxyConfig.ProxyAuthType getCloudFetchProxyAuthType()

#### getEndpointURL

    String getEndpointURL()
                   throws DatabricksParsingException

Throws:
  `DatabricksParsingException`

#### getAsyncExecPollInterval

    int getAsyncExecPollInterval()

#### shouldEnableArrow

    Boolean shouldEnableArrow()

#### getClientType

    DatabricksClientType getClientType()

#### setClientType

    void setClientType​(DatabricksClientType clientType)

#### getUseEmptyMetadata

    Boolean getUseEmptyMetadata()

#### getCloudFetchThreadPoolSize

    int getCloudFetchThreadPoolSize()

Returns the number of threads to be used for fetching data from cloud storage

#### getDirectResultMode

    Boolean getDirectResultMode()

#### shouldRetryTemporarilyUnavailableError

    Boolean shouldRetryTemporarilyUnavailableError()

#### shouldRetryRateLimitError

    Boolean shouldRetryRateLimitError()

#### getTemporarilyUnavailableRetryTimeout

    int getTemporarilyUnavailableRetryTimeout()

#### getRateLimitRetryTimeout

    int getRateLimitRetryTimeout()

#### getIdleHttpConnectionExpiry

    int getIdleHttpConnectionExpiry()

#### supportManyParameters

    boolean supportManyParameters()

#### getConnectionURL

    String getConnectionURL()

#### checkCertificateRevocation

    boolean checkCertificateRevocation()

#### acceptUndeterminedCertificateRevocation

    boolean acceptUndeterminedCertificateRevocation()

#### getJWTKeyFile

    String getJWTKeyFile()

Returns the file path to the JWT private key used for signing the JWT.

#### getKID

    String getKID()

Returns the Key ID (KID) used in the JWT header, identifying the key.

#### getJWTPassphrase

    String getJWTPassphrase()

Returns the passphrase to decrypt the private key if the key is encrypted.

#### getJWTAlgorithm

    String getJWTAlgorithm()

Returns the algorithm used for signing the JWT (e.g., RS256, ES256).

#### useJWTAssertion

    boolean useJWTAssertion()

Returns whether JWT assertion should be used for OAuth2 authentication.

#### getTokenEndpoint

    String getTokenEndpoint()

Returns the OAuth2 token endpoint URL for retrieving tokens.

#### getAuthEndpoint

    String getAuthEndpoint()

Returns the OAuth2 authorization endpoint URL for the authorization code flow.

#### isOAuthDiscoveryModeEnabled

    boolean isOAuthDiscoveryModeEnabled()

Returns whether OAuth2 discovery mode is enabled, which fetches endpoints dynamically.

#### getOAuthDiscoveryURL

    String getOAuthDiscoveryURL()

Returns the discovery URL used to obtain the OAuth2 token and authorization endpoints.

#### getAuthScope

    String getAuthScope()

Returns the OAuth2 authentication scope used in the request.

#### getOAuthRefreshToken

    String getOAuthRefreshToken()

Returns the OAuth2 refresh token used to obtain a new access token when the current one expires.

#### getOAuth2RedirectUrlPorts

    List<Integer> getOAuth2RedirectUrlPorts()

Returns the list of OAuth2 redirect URL ports used for OAuth authentication.

#### getGcpAuthType

    String getGcpAuthType()
                   throws DatabricksParsingException

Throws:
  `DatabricksParsingException`

#### getGoogleServiceAccount

    String getGoogleServiceAccount()

#### getGoogleCredentials

    String getGoogleCredentials()

#### getNonProxyHosts

    String getNonProxyHosts()

Returns the non-proxy hosts that should be excluded from proxying.

#### getSSLTrustStore

    String getSSLTrustStore()

Returns the SSL trust store file path used for SSL connections.

#### getSSLTrustStorePassword

    String getSSLTrustStorePassword()

Returns the SSL trust store password of the trust store file.

#### getSSLTrustStoreType

    String getSSLTrustStoreType()

Returns the SSL trust store type of the trust store file.

#### getMaxBatchSize

    int getMaxBatchSize()

Returns the maximum number of commands that can be executed in a single batch.

#### isTelemetryEnabled

    boolean isTelemetryEnabled()

Checks if Telemetry is enabled

#### getTelemetryBatchSize

    int getTelemetryBatchSize()

Returns the batch size for Telemetry logs processing

#### getConnectionUuid

    String getConnectionUuid()

Returns a unique identifier for this connection context.

This UUID is generated when the connection context is instantiated and serves as a unique internal identifier for each JDBC connection.

#### getVolumeOperationAllowedPaths

    String getVolumeOperationAllowedPaths()

Returns allowlisted local file paths for UC Volume operations

#### isSqlExecHybridResultsEnabled

    boolean isSqlExecHybridResultsEnabled()

Returns true if driver should use hybrid results in SQL_EXEC API.

#### getAzureTenantId

    String getAzureTenantId()

Returns the Azure tenant ID for the Azure Databricks workspace.

#### isRequestTracingEnabled

    boolean isRequestTracingEnabled()

Returns true if request tracing should be enabled.

#### getDefaultStringColumnLength

    int getDefaultStringColumnLength()

Returns maximum number of characters that can be contained in STRING columns.

#### isComplexDatatypeSupportEnabled

    boolean isComplexDatatypeSupportEnabled()

Returns true if driver return complex data type java objects natively as opposed to string

#### getHttpConnectionPoolSize

    int getHttpConnectionPoolSize()

Returns the size for HTTP connection pool

#### getUCIngestionRetriableHttpCodes

    List<Integer> getUCIngestionRetriableHttpCodes()

Returns the list of HTTP codes to retry for UC Volume Ingestion

#### getUCIngestionRetryTimeoutSeconds

    int getUCIngestionRetryTimeoutSeconds()

Returns retry timeout in seconds for UC Volume Ingestion

#### getAzureWorkspaceResourceId

    String getAzureWorkspaceResourceId()

#### getRowsFetchedPerBlock

    int getRowsFetchedPerBlock()

Returns maximum number of rows that a query returns at a time.

#### getSocketTimeout

    int getSocketTimeout()

Returns the socket timeout in seconds for HTTP connections.

#### allowSelfSignedCerts

    boolean allowSelfSignedCerts()

Returns whether self-signed certificates are allowed for SSL connections.

When true, the driver will accept any certificate, including self-signed certificates. This option is insecure and should only be used in non-production environments.

Returns:
  true if self-signed certificates are allowed, false otherwise

#### useSystemTrustStore

    boolean useSystemTrustStore()

Returns whether the system property trust store should be used for SSL certificate validation.

When true, the driver will use either:

1. The trust store specified by the Java system property `javax.net.ssl.trustStore` if set
2. Or the JDK's default trust store (cacerts) if no system property is set

When false, the driver will:

1. Use the custom trust store specified by the SSLTrustStore parameter if provided
2. Or use the JDK's default trust store (cacerts) but ignore any javax.net.ssl.trustStore system property

Returns:
  true if the system property trust store should be used, false otherwise

#### getTokenCachePassPhrase

    String getTokenCachePassPhrase()

Returns the passphrase used for encrypting/decrypting token cache

#### isTokenCacheEnabled

    boolean isTokenCacheEnabled()

Returns whether token caching is enabled for OAuth authentication