Creating a Session for Snowpark

To use Snowpark in your application, you need to create a session. For convenience in writing code, you can also import the names of packages and objects.

In this Topic:

Importing Names from Packages and Objects for Snowpark

The Snowpark API provides a number of classes, objects, and functions that are available in different packages. For convenience, you can import the class, object, and function names from packages and objects to avoid having to use qualified names.

For example:

Note

If you used the run.sh script to start the Scala REPL, the script already imports names com.snowflake.snowpark and com.snowflake.snowpark.functions.

Creating a Session for Snowpark

The first step in using the library is establishing a session with the Snowflake database. To create a session, use the SessionBuilder object. You can access the SessionBuilder object through the builder field in the Session companion object:

import com.snowflake.snowpark._

...
// Get a SessionBuilder object.
val builder = Session.builder

To provide the details to establish a session with a Snowflake database (for example, the account identifier, user name, etc.), either create a properties file (a text file) or programmatically build a Map containing the properties.

In the properties file or Map, set the following properties:

  • URL: Set this to the URL for your account in the form https://account_identifier.snowflakecomputing.com.

    See Account Identifiers.

    If the account identifier contains underscores (_), replace those underscores with hyphens (-).

  • Any additional JDBC parameters (see JDBC Driver Connection Parameter Reference in the JDBC driver documentation) needed to connect to Snowflake (e.g. USER, ROLE, WAREHOUSE, DB, SCHEMA, etc.).

    Note

    To change the logging level (e.g. from INFO to DEBUG), see Changing the Logging Settings.

To authenticate, you can use the same mechanisms that the JDBC Driver supports. For example, you can use:

For key-pair authentication, you can either:

  • Set the PRIVATE_KEY_FILE property to the path to the private key file.

    If the private key is encrypted, set the PRIVATE_KEY_FILE_PWD property to the passphrase for decrypting the key.

  • Set the PRIVATEKEY property to the string value of the unencrypted private key from the private key file. (If the private key is encrypted, you must decrypt the key before setting it as the value of the PRIVATEKEY property.)

To create the session:

  1. Set the properties in the Session.builder object.

    • If you created a properties file, pass the path to the properties file to the Session.builder.configFile method.

    • If you programmatically built a Map of the properties, pass the Map to the Session.builder.configs method.

    Both methods return a builder object that has these properties.

  2. Call the create method of the builder object to establish the session.

The following is an example of a properties file that sets the basic parameters for connecting to a Snowflake database. The example is set up to use key-pair authentication. Set PRIVATE_KEY_FILE to the path to the private key file. In addition, if the private key is encrypted, you must set PRIVATE_KEY_FILE_PWD to the passphrase for decrypting the private key:

# profile.properties file (a text file)
URL = https://<account_identifier>.snowflakecomputing.com
USER = <username>
PRIVATE_KEY_FILE = </path/to/private_key_file.p8>
PRIVATE_KEY_FILE_PWD = <if the private key is encrypted, set this to the passphrase for decrypting the key>
ROLE = <role_name>
WAREHOUSE = <warehouse_name>
DB = <database_name>
SCHEMA = <schema_name>

As an alternative, you can set the PRIVATEKEY property to the unencrypted private key from the private key file.

# profile.properties file (a text file)
URL = https://<account_identifier>.snowflakecomputing.com
USER = <username>
PRIVATEKEY = <unencrypted_private_key_from_the_private_key_file>
ROLE = <role_name>
WAREHOUSE = <warehouse_name>
DB = <database_name>
SCHEMA = <schema_name>

The following example uses this properties file to create a new session:

// Create a new session, using the connection properties
// specified in a file.
val session = Session.builder.configFile("/path/to/properties/file").create

The following example uses a Map to set the properties:

// Create a new session, using the connection properties
// specified in a Map.
val session = Session.builder.configs(Map(
    "URL" -> "https://<account_identifier>.snowflakecomputing.com",
    "USER" -> "<username>",
    "PRIVATE_KEY_FILE" -> "</path/to/private_key_file.p8>",
    "PRIVATE_KEY_FILE_PWD" -> "<if the private key is encrypted, set this to the passphrase for decrypting the key>",
    "ROLE" -> "<role_name>",
    "WAREHOUSE" -> "<warehouse_name>",
    "DB" -> "<database_name>",
    "SCHEMA" -> "<schema_name>"
)).create

Closing a Session

If you no longer need to use a session for executing queries and you want to cancel any queries that are currently running, call close method of the Session object. For example:

// Close the session, cancelling any queries that are currently running, and
// preventing the use of this Session object for performing any subsequent queries.
session.close();