Installing and Configuring the Spark Connector

Multiple versions of the connector are supported; however, Snowflake strongly recommends using the most recent version of the connector. To view release information about the latest version, see the Spark Connector Release Notes (link in the sidebar).

The instructions in this topic can be used to install and configure all supported versions of the connector.

In this Topic:

Supported Versions

Snowflake supports multiple versions of the connector:

Connector versions:

2.x

Supported Spark versions:

Spark 3.1, 3.0, 2.4

Supported Scala versions:

Scala 2.12, 2.11

Data source name:

net.snowflake.spark.snowflake — v2.4.14 (or higher) of the connector allows snowflake as the data source name

Package name (for imported classes):

net.snowflake.spark.snowflake

Package distribution:

Maven Central Repository

Source code:

spark-snowflake (GitHub): . master (for latest version) , . previous_spark_version (for earlier versions)

The developer notes for the different versions are hosted with the source code.

Note

The Snowflake Spark Connector generally supports the three most recent versions of Spark. Download a version of the connector that is specific to your Spark version.

For example, to use version 2.8.3 of the connector with the older Spark version 2.4, download the 2.8.3-spark_2.4 version of the connector.

Requirements

To install and use Snowflake with Spark, you need the following:

  • A supported operating system. For a list of supported operating systems, see Operating System Support.

  • Snowflake Connector for Spark.

  • Snowflake JDBC Driver (the version compatible with the version of the connector).

  • Apache Spark environment, either self-hosted or hosted in any of the following:

  • In addition, you can use a dedicated Amazon S3 bucket or Azure Blob storage container as a staging zone between the two systems; however, this is not required with version 2.2.0 (and higher) of the connector, which uses a temporary Snowflake internal stage (by default) for all data exchange.

  • The role used in the connection needs USAGE and CREATE STAGE privileges on the schema that contains the table that you will read from or write to.

Note

If you are using Databricks or Qubole to host Spark, you do not need to download or install the Snowflake Connector for Spark (or any of the other requirements). Both Databricks and Qubole have integrated the connector to provide native connectivity.

For more details, see:

Verifying the OCSP Connector or Driver Version

Snowflake uses OCSP to evaluate the certificate chain when making a connection to Snowflake. The driver or connector version and its configuration both determine the OCSP behavior. For more information about the driver or connector version, their configuration, and OCSP behavior, see OCSP Configuration.

Downloading and Installing the Connector

The instructions in this section pertain to version 2.x and higher of the Snowflake Connector for Spark.

Important

Snowflake periodically releases new versions of the connector. The following installation tasks must be performed each time you install a new version. This also applies to the Snowflake JDBC driver, which is a prerequisite for the Spark connector.

Step 1: Download the Latest Version of the Snowflake Connector for Spark

Snowflake provides multiple versions of the connector. Download the appropriate version, based on the following:

  • The version of the Snowflake Connector for Spark that you want to use.

  • The version of Spark that you are using.

  • The version of Scala that you are using.

You can download the Snowflake Spark Connector from Maven. If you want to build the driver, you can access the source code from Github.

Maven Central Repository

Snowflake provides separate package artifacts for each supported Scala version (2.11 and 2.12). For each of these Scala versions, Snowflake provides different versions of the Spark connector as well as separate artifacts that support different versions of Spark.

To download the Spark connector:

  1. Search the Maven repository for the version of Scala that you are using:

    • For Scala 2.12, search for the matching artifacts by clicking this link.

    • For Scala 2.11, search for the matching artifacts by clicking this link.

    The following screenshot provides an example of the search results page:

    Snowflake Connector for Spark download page in Maven

    The Latest Version column lists the latest available version of the driver.

    The individual packages use the following naming convention:

    N.N.N-spark_P.P
    

    where:

    • N.N.N is the Snowflake version (e.g. 2.8.3).

    • P.P is the Spark version (e.g. 2.4).

    For example:

    2.9.1-spark_3.1
    
  2. If you don’t see the artifact for the supported version of Spark that you are using, click the all link under the Latest Version column.

  3. Download the JAR file by clicking the jar link in the Download column.

  4. If you plan to verify the package signature, you need to download the signature file as well.

    1. Click the N.N.N-spark_P.P link in the Version column to display the page for the version.

    2. Click the net.snowflake : spark-snowflake_x.xx : N.N.N-spark_P.P link to load the page that lists the artifacts for that version (where x.xx is the Scala version that you plan to use – e.g. 2.12).

    3. Click the spark-snowflake_2.1x-N.N.N-spark_P.P.jar.asc link to download the signature file.

GitHub

The source code for the Spark Snowflake Connector is available on GitHub. However, the compiled packages are not available on GitHub. You can download the compiled packages from Maven.

Step 2: Download the Compatible Version of the Snowflake JDBC Driver

Next, you need to download the version of the Snowflake JDBC driver that is compatible with the version of the Snowflake Spark Connnector that you are using.

The Snowflake JDBC driver is provided as a standard Java package through the Maven Central Repository. You can either download the package as a .jar file or you can directly reference the package. These instructions assume you are referencing the package.

To find the supported version of the Snowflake JDBC Driver for the version of the Snowflake Spark Connector that you are using, see the Snowflake For Spark Connector Release Notes.

For more details on downloading and installing the Snowflake JDBC Driver, see Downloading / Integrating the JDBC Driver.

Step 3 (Optional): Verify the Snowflake Connector for Spark Package Signature

To verify the Snowflake Connector for Spark package signature:

  1. Download and import the latest Snowflake GPG public key from the public keyserver:

    $ gpg --keyserver hkp://keyserver.ubuntu.com --recv-keys <GPG_KEY_ID>
    

    For <GPG_KEY_ID>, specify one of the following key IDs:

    Snowflake Spark Connector Version

    GPG Key ID

    2.8.2 and higher

    37C7086698CB005C

    2.4.13 through 2.8.1

    EC218558EABB25A1

    Up to 2.4.12

    93DB296A69BE019A

    Note

    If this command fails with the following error:

    gpg: keyserver receive failed: Server indicated a failure
    

    then specify that you want to use port 80 for the keyserver:

    gpg --keyserver hkp://keyserver.ubuntu.com:80  ...
    
  2. Run the gpg --verify command to verify the signature of the package.

    For the --verify command-line flag, specify the .asc file that you downloaded earlier as the signature file and the JAR file as the file containing the signed data.

    $ gpg --verify spark-snowflake_x.xx-N.N.N-spark_P.P.jar.asc spark-snowflake_x.xx-N.N.N-spark_P.P.jar
    gpg: Signature made Wed 22 Feb 2017 04:31:58 PM UTC using RSA key ID <gpg_key_id>
    gpg: Good signature from "Snowflake Computing <snowflake_gpg\ @snowflake.net>"
    

    where:

    • x.xx is the Scala version (e.g. 2.12).

    • N.N.N is the Snowflake version (e.g. 2.8.3).

    • P.P is the Spark version (e.g. 2.4).

    Note

    Verifying the signature produces a warning similar to the following:

    gpg: Signature made Mon 24 Sep 2018 03:03:45 AM UTC using RSA key ID <gpg_key_id>
    gpg: Good signature from "Snowflake Computing <snowflake_gpg@snowflake.net>" unknown
    gpg: WARNING: This key is not certified with a trusted signature!
    gpg: There is no indication that the signature belongs to the owner.
    

    To avoid the warning, you can grant the Snowflake GPG public key implicit trust.

  3. Your local environment can contain multiple GPG keys; however, for security reasons, Snowflake periodically rotates the public GPG key. As a best practice, we recommend deleting the existing public key after confirming that the latest key works with the latest signed package. For example:

    $ gpg --delete-key "Snowflake Computing"
    

Step 4: Configure the Local Spark Cluster or Amazon EMR-hosted Spark Environment

If you have a local Spark installation, or a Spark installation in Amazon EMR, you need to configure the spark-shell program to include both the Snowflake JDBC driver and the Spark Connector:

  • To include the Snowflake JDBC driver, use the --package option to reference the JDBC package hosted in the Maven Central Repository, providing the exact version of the driver you wish to use (e.g. net.snowflake:snowflake-jdbc:3.12.17).

  • To include the Spark Connector, use the --package option to reference the appropriate package ( Scala 2.11 or Scala 2.12 ) hosted in the Maven Central Repository, providing the exact version of the driver you want to use (e.g. net.snowflake:spark-snowflake_2.12:2.8.4-spark_3.0).

For example:

spark-shell --packages net.snowflake:snowflake-jdbc:3.12.17,net.snowflake:spark-snowflake_2.12:2.8.4-spark_3.0

Installing Additional Packages (If Needed)

Depending on your Spark installation, some packages required by the connector may be missing. You can add missing packages to your installation by using the appropriate flag for spark-shell:

  • --packages

  • --jars (if the packages were downloaded as .jar files)

The required packages are listed below, with the syntax (including version number) for using the --packages flag to reference the packages:

  • org.apache.hadoop:hadoop-aws:2.7.1

  • org.apache.httpcomponents:httpclient:4.3.6

  • org.apache.httpcomponents:httpcore:4.3.3

  • com.amazonaws:aws-java-sdk-core:1.10.27

  • com.amazonaws:aws-java-sdk-s3:1.10.27

  • com.amazonaws:aws-java-sdk-sts:1.10.27

For example, if the Apache packages are missing, to add the packages by reference:

spark-shell --packages org.apache.hadoop:hadoop-aws:2.7.1,org.apache.httpcomponents:httpclient:4.3.6,org.apache.httpcomponents:httpcore:4.3.3

Preparing an External Location For Files

You might need to prepare an external location for files that you want to transfer between Snowflake and Spark.

This task is required if either of the following situations is true:

  • You will run jobs that take longer than 36 hours, which is the maximum duration for the token used by the connector to access the internal stage for data exchange.

  • The Snowflake Connector for Spark version is 2.1.x or lower (even if your jobs require less than 36 hours).

    Note

    If you are not currently using v2.2.0 (or higher) of the connector, Snowflake strongly recommends upgrading to the latest version.

Preparing an AWS External S3 Bucket

Prepare an external S3 bucket that the connector can use to exchange data between Snowflake and Spark. You then provide the location information, together with the necessary AWS credentials for the location, to the connector. For more details, see Authenticating S3 for Data Exchange in the next topic.

Important

If you use an external S3 bucket, the connector does not automatically remove any intermediate/temporary data from this location. As a result, it’s best to use a specific bucket or path (prefix) and set a lifecycle policy on the bucket/path to clean up older files automatically. For more details on configuring a lifecycle policy, see the Amazon S3 documentation.

Preparing an Azure Blob Storage Container

Prepare an external Azure Blob storage container that the connector can use to exchange data between Snowflake and Spark. You then provide the location information, together with the necessary Azure credentials for the location, to the connector. For more details, see Authenticating Azure for Data Exchange in the next topic.