The following table summarizes connection properties required to connect to a database. The first section describes options required for both binary (TCP) mode and HTTP modes, while the second documents additional options required to establish an HTTP connection.

Table 1. Required Properties
Property Characteristic
Required properties for all connections
DatabaseName Specifies the name of the database. The database must exist, or the connection attempt will fail.
PortNumber

The TCP port of the primary database server that is listening for connections to the database.

The default is 10000.
ServerName Specifies either the IP address or the server name (if your network supports named servers) of the primary database server.
Additional properties required for enabling HTTP mode
HTTPPath Specifies the path of the HTTP/HTTPS endpoint used for connections when HTTP mode is enabled (TransportMode=http).

The default is cliservice.

TransportMode

Specifies whether binary (TCP) mode or HTTP mode is used to access Apache Spark SQL data sources.

If set to binary, Thrift RPC requests are sent to directly to data sources using a binary connection (TCP mode).

If set to http, Thrift RPC requests are sent using HTTP transport (HTTP mode). HTTP mode is typically used when connecting to a reverse-proxy server, such as a gateway, for improved security, or a load balancer.

Note: To configure the driver to use HTTPS end points, set TransportMode=http and EncryptionMethod=SSL.

The default is binary.