ODBC

Dremio provides the following Dremio ODBC drivers:

[info] Note

To distribute query planning for ODBC and JDBC connections, configure secondary coordinator nodes for your deployment.

ODBC Parameters for Dremio wire encryption

If you are setting up encrypted communication between your ODBC/JDBC client applications and the Dremio server, use the following connection parameters to enable a connection with Dremio through an ODBC tool.

[info] Note

The Dremio ODBC driver does not support password-protected .pem/.crt files or multiple .crt certificates in a single .pem/.crt file.

The SSL parameters in the following table are not required.

Primary connection parameters

Use these parameters to configure basic connection details, such as what data source to connect with.

Name Default Value Description
Host localhost

Sets the IP address or hostname for the Dremio server.

Note: A value is required if the ConnectionType parameter is set to Direct.

ConnectionType Direct

Controls whether the driver should connect to a single Dremio server or ZooKeeper Quorum cluster. Accepted values are:

Direct: The driver connects to a single Dremio server.
ZooKeeper: The driver connects to a ZooKeeper Quorum cluster.

Port 31010 Sets the TCP port number the Dremio server uses to listen for client connections.
ZKClusterID coordinator

Specifies the name of the ZooKeeper Quorum cluster that the driver connects to.

Note: When a configuration uses ZooKeeper for the ConnectionType parameter, a value should be included here.

AuthenticationType No Authentication

Controls how the driver authenticates connections to Dremio. Accepted values include:

No Authentication: The driver will not authenticate the connection.
Username: The driver will not authenticate the connection to Dremio. Use this when the server has impersonation enabled or disabled.
Plain or Basic Authentication: The driver authenticates the connection using a username and password. Values for these must be set using the UID and PWD parameters.

Note: Authentication occurs independently from an SSL configuration. If the AuthenticationType and SSL parameters are both enabled, the driver will execute the specified authentication method using an SSL connection.

UID None

Sets the user name when accessing the Dremio server.

Note: This property is required when the ConnectionType parameter is set to Direct.

PWD None

Sets the password that corresponds with the username provided in the UID parameter.

Note: A value is required here when the ConnectionType parameter is set to Direct.

Schema None Provides the name of the database schema to use by default when a schema is not specified in a query. However, this does not prevent queries from being issued for other schemas. Such queries must explicitly include the schema.
ZKQuorum None

Identifies the server(s) in your ZooKeeper cluster. When listing multiple servers, separate them with a comma (,).

Note: This property is required if the ConnectionType parameter is set to ZooKeeper.

LogLevel OFF (0)

Handles logging behaviors in the driver and specifies the amount of detail to include in log files.

Note: We recommend only enabling logging when capturing an issue. Logging can dramatically impact server performance and consume large quantities of disk space. The settings for logging will apply to any connection using the Dremio ODBC driver, so always remember to disable this feature once you are done using it.

The following are accepted values:

OFF (0): Disables all logging.
FATAL (1): Logs severe error events that cause the driver to abort.
ERROR (2): Logs error events that may not prevent the driver from continuing to run.
WARNING (3): Logs events that may result in an error if action is not taken.
INFO (4): Logs general information describing the progress of the driver.
DEBUG (5): Logs detailed information useful when debugging the driver.
TRACE (6): Logs all driver activity.

When logging has been enabled, the driver will produce a log file at the location specified in the LogPath parameter.

LogPath None Sets the full path to the folder where the ODBC driver should save log files when logging has been enabled.
LogFileSize 20971520 Restricts the maximum size of each log file, as measured in bytes. Once the maximum file size is reached, the driver then creates a new file and continues logging.

SSL connection parameters

Use the following parameters to configure SSL encryption and verification methods for regular connections.

Name Default Value Description
SSL Clear (0)

Forces the client to use an SSL encrypted connection to communicate with the Dremio server. Accepted values include:

Enabled (1): The client communicates with the Dremio server only using SSL encryption.
Disabled (0): SSL encryption is disabled with the client.

Note: SSL configuration occurs independently from authentication. If AuthenticationType and SSL are both enabled, the driver will execute the specified authentication method using an SSL connection.

DisableHostVerification 0

Forces the driver to verify that the host in the certificate is the host being connected to. Accepted values are:

0: The driver will verify the certificate against the host being connected to.
1: The driver will not verify the certificate against the host.

DisableCertificateVerification 0

Specifies whether the driver should verify the host certificate against the trust store. Accepted values are:

0: The driver verifies the certificate against the trust store.
1: The driver will not verify the certificate against the trust store.

DisableCertificateValidation 0

Controls whether the driver verifies the host certificate against the trust store. Accepted values include:

Disabled (0): The driver will verify the certificate against the trust store.
Enabled (1): The driver will not verify the certificate against the trust store.

UseSystemTrustStore Clear (0)

Controls whether to use a CA certificate from the system's trust store, or from a specified .pem file.

Enabled (1): The driver verifies the connection using a certificate in the system trust store.
Disabled (0): The driver verifies the connection using the .pem file specified by the TrustedCerts parameter.

TLSProtocol tlsv12 Indicates the TLS protocol version to use for connections. Accepted values are: tlsv1, tlsv11, and tlsv12.
TrustedCerts The cacerts.pem file in the \lib subfolder within the driver's installation directory

The full path of the .pem file containing certificates trusted by a CA, for the purpose of verifying the server. If this option is not set, then the driver defaults to using the trusted CA certificates .pem file installed by the driver.

Note: The exact file path varies depending on the version of the driver that is installed. The path for the Windows driver is different from the path set for the Mac OS driver.

Advanced Properties

These describe the advanced properties you may use when configuring the Dremio ODBC driver.

[info] Note

When defining multiple parameters, each should be separated using a semicolon (;).

HandshakreTimeout 5

Specifies an integer value, which represents the number of seconds the driver must wait before ending an attempt to connect with a data source.

Note: If this property is set to 0, the driver will make connection attempts indefinitely.

HeartBeatFreqSec 15

Sets the total number of seconds of inactivity allowed before the Dremio client sends a heartbeat to the server to check on the status of a connection.

Note: If this property is set to 0, then the Dremio client will not send any heartbeats.

NonZeroMaxNameMaxLen false

Restricts the maximum length of schema, catalog, table, and column names. The Dremio ODBC Driver does not automatically enforce a maximum length for these names. By default, the driver reports these lengths as 0, indicating that there is no maximum length. Accepted values include:

true: The driver reports an appropriate non-zero value for the maximum length of schema, catalog, table, and column names.
false: The driver reports 0 as the maximum length of schema, catalog, table, and column names.

Note: Some BI tools interpret the length of 0 literally. To ensure that names display correctly in your BI tool, properly set the NonZeroNameMaxLen parameter.

NumberOfPrefetchBuffers 5

Controls the size of the record batch queue for the driver.

Note: When this property is set to a value less than 1, the value will default to 1.

QueryTimeout 180

Controls the number of seconds that the driver will wait before halting a query.

Note: If this property is set to 0, then queries will not be stopped by the driver.

StringColumnLength

65536 when connecting to Apache Drill server 1.11.0 or earlier.

The value specified by the server when connecting to Apache Drill server 1.12.0+

Sets the maximum column length that the driver reports for string columns. This property supports values between 1 and 2,147,483,647, inclusively.

TimestampTZDisplayTimeZone local

Specifies the timestamp to be used by the Dremio server. Accepted values include:

local: Timestamps use the local time zone associated with the user.
utc: Timestamps appear in Coordinated Universal Time (UTC).


results matching ""

    No results matching ""