Tableau Connector for Databricks

Build 25.0.9434

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.


PropertyDescription
AllowPreparedStatementSpecifies whether the provider prepares SQL statements before executing them to improve performance on repeated queries.
ConnectRetryWaitTimeSpecifies the number of seconds the provider waits before retrying a connection request.
ApplicationNameSpecifies the application name that the provider includes in the HTTP User-Agent header when connecting to Databricks.
AsyncQueryTimeoutSpecifies the number of seconds the provider waits for asynchronous requests that retrieve large result sets before timing out.
BatchSizeSpecifies the maximum number of rows included in each batch submitted during batch operations. To submit the entire batch as a single request, set BatchSize to 0 .
ConnectionLifeTimeSpecifies the maximum lifetime of a connection in seconds. When the specified time elapses, the provider closes the connection.
ConnectOnOpenSpecifies whether the provider establishes a connection to Databricks immediately upon opening the connection. Set ConnectOnOpen to True if immediate connectivity verification is necessary.
DefaultColumnSizeSpecifies the default length, in characters, of string fields when the provider cannot determine a size from metadata.
DescribeCommandSpecifies which command the provider uses to retrieve metadata from Databricks.
DetectViewSpecifies whether the provider uses the DESCRIBE FORMATTED command to determine whether an object in Databricks is a table or a view.
IncludeSystemSchemasSpecifies whether to include the system catalog 'system' and system schema 'information_schema'.
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
OtherSpecifies additional hidden properties for specific use cases., to be used only when our Support team advises it, to address specific issues. See Remarks for details.
PoolIdleTimeoutSpecifies the maximum idle time, in seconds, that a connection can remain in the pool before being closed. Requires UseConnectionPooling=True.
PoolMaxSizeSpecifies the maximum number of connections allowed in the connection pool.
PoolMinSizeSpecifies the minimum number of connections to be maintained in the connection pool at all times.
PoolWaitTimeSpecifies the maximum number of seconds a connection request waits for an available connection in the pool. If the wait exceeds this time, an error is returned.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
QueryPassthroughThis option passes the query to the Databricks server as is.
ReadonlyToggles read-only access to Databricks from the provider.
RTKSpecifies the runtime key for licensing the provider. If unset or invalid, the provider defaults to the standard licensing method. This property is only required in environments where the standard licensing method is unsupported or requires a runtime key.
ServerConfigurationsSpecifies configuration variables to override the default settings on the Databricks server.
ServerTimeZoneSpecifies how the provider interprets datetime values returned from Databricks.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UseConnectionPoolingEnables the connection pooling feature, which allows the provider to reuse existing connections instead of creating new ones for each request.
UseDescTableQuerySpecifies whether the provider retrieves table column metadata using a DESC TABLE query instead of the Thrift API.
UseInsertSelectSyntaxDEPRECATED. This property is no longer supported, and should not be used. It will be removed in a future release.
UserDefinedViewsSpecifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434