JDBC Driver for Spark SQL

Build 21.0.7930

Establishing a Connection

Creating a JDBC Data Source

You can create a JDBC data source to connect from your Java application. Creating a JDBC data source based on the CData JDBC Driver for Spark SQL consists of three basic steps:

  • Add the driver JAR file to the classpath. The JAR file is located in the lib subfolder of the installation directory. Note that the .lic file must be located in the same folder as the JAR file.
  • Provide the driver class. For example:
    cdata.jdbc.sparksql.SparkSQLDriver
  • Provide the JDBC URL. For example:
    jdbc:sparksql:Server=127.0.0.1;
    
    or
    
    jdbc:cdata:sparksql:Server=127.0.0.1;

    The second format above can be used whenever there is a conflict in your application between drivers using the same URL format to ensure you are using the CData driver. The URL must start with either "jdbc:sparksql:" or "jdbc:cdata:sparksql:" and can include any of the connection properties in name-value pairs separated with semicolons.

Connecting to Spark SQL

Specify the following to establish a connection with Spark SQL:

  • Server: Set this to the host name or IP address of the server hosting SparkSQL.
  • Port: Set this to the port for the connection to the SparkSQL instance.
  • TransportMode: The transport mode to use to communicate with the SparkSQL server. Accepted entries are BINARY and HTTP. BINARY is selected by default.

Securing Spark SQL Connections

To enable TLS/SSL in the driver, set UseSSL to True.

Authenticating to Spark SQL

The service may be authenticated to using the PLAIN, LDAP, NOSASL, KERBEROS auth schemes.

Authenticating with PLAIN

To authenticate with PLAIN, set the following connection properties:

  • AuthScheme: Set this to PLAIN.
  • User: Set this to user to login as.
  • Password: Set this to the password of the user.
To authenticate, set User and Password.

Authenticating with LDAP

To authenticate with LDAP, set the following connection properties:

  • AuthScheme: Set this to LDAP.
  • User: Set this to user to login as.
  • Password: Set this to the password of the user.
To authenticate, set User, Password, and AuthScheme.

Authenticating with NOSASL

When using NOSASL, no authentication is performed. Set the following connection properties:

  • AuthScheme: Set this to NOSASL.

Authenticating with Kerberos

Please see Using Kerberos for details on how to authenticate with Kerberos.

Connecting to Databricks

To connect to a Databricks cluster, set the properties as described below. Note: The needed values can be found in your Databricks instance by navigating to 'Clusters', selecting the desired cluster, and selecting the JDBC/ODBC tab under 'Advanced Options'.

  • Server: Set to the Server Hostname of your Databricks cluster.
  • Port: 443
  • TransportMode: HTTP
  • HTTPPath: Set to the HTTP Path of your Databricks cluster.
  • UseSSL: True
  • AuthScheme: PLAIN
  • User: Set this to user to login as
  • Password: Set to your personal access token (value can be obtained by navigating to the User Settings page of your Databricks instance and selecting the Access Tokens tab).

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 21.0.7930