Connect to Snowflake with the Snowflake Python API¶

Connect using a Python dictionary¶

You can specify the values needed to connect to Snowflake by using a Python dictionary. When you connect, you pass this dictionary as an argument to the function or method you’re using to connect:

import os

CONNECTION_PARAMETERS = {
    "account": os.environ["snowflake_account_demo"],
    "user": os.environ["snowflake_user_demo"],
    "password": os.environ["snowflake_password_demo"],
    "role": "test_role",
    "database": "test_database",
    "warehouse": "test_warehouse",
    "schema": "test_schema",
}

Connect using a configuration file¶

You can specify connection definitions in a TOML configuration file. This eliminates the need to explicitly define a connection to Snowflake in your code.

For example, create a configuration file located at ~/.snowflake/connections.toml, and add connection parameters similar to the following:

[myconnection]
account = "test_account"
user = "test_user"
password = "******"
role = "test_role"
warehouse = "test_warehouse"
database = "test_database"
schema = "test_schema"

In this example, you define a Snowflake connection called myconnection with the account test_account, user test_user, password credentials, and database information.

Connection definitions support the same configuration options available in the Snowflake Python Connector.

Connect with a Snowpark Session¶

If you’re using the Snowpark API for Python, you can create a connection to Snowflake by using its snowflake.snowpark.Session object.

Code in the following example uses connection parameters defined in a configuration file to create a connection to Snowflake. Using the resulting Session object, the code creates a Root object from which to use the API:

from snowflake.core import Root
from snowflake.snowpark import Session

session = Session.builder.config("connection_name", "myconnection").create()
root = Root(session)

For more information about creating a Session, see Creating a Session for Snowpark Python.

Connect with a Python Connector Connection¶

If you’re using the Snowflake Connector for Python, you can create a connection to Snowflake by using its snowflake.connector.connect function. The function returns a Connection object.

Code in the following example uses connection parameters defined in a configuration file to create a connection to Snowflake. Using the resulting Connection object, the code creates a Root object from which to use the API:

from snowflake.connector import connect
from snowflake.core import Root

connection = connect(connection_name="myconnection")
root = Root(connection)

For more information about the Snowflake Connector for Python API, see Python Connector API.