Skip to main content

Snowflake

On Appsmith, it’s pretty straightforward to establish a connection with any data source, including SnowflakeDB, be it on the cloud, self-hosted version, or local environment.

note

The following document assumes that you understand the basics of connecting to databases on Appsmith. If not, please go over them before reading further.

Connection settings​

Appsmith needs the following parameters for connecting to a Snowflake database:

info

All required fields are suffixed with an asterisk (*).

Connection​

You need to fill in the following parameters:

  • Account name: Your account name is part of the connection string and consists of one or more components mentioned in the Snowflake documentation.
  • Warehouse: Specifies the virtual warehouse to use once connected. The specified warehouse should be an existing warehouse for which the default role has privileges.
  • Database: Specifies the default database to use once connected. The specified database should be an existing database for which the default role has privileges.
  • Default Schema: The connection does not limit queries to this schema. This information is only used to view the schema structure inside Appsmith.

Authentication​

Please fill in the following parameters:

  • Username: Fill in the username required to authenticate your database connection request.
  • Password: Fill password required for authenticating connection requests for the given username to the database.

Connecting Snowflake on Appsmith ​

What you need to make the connection are the endpoint, database name, and user credentials. With this in mind, let’s get started.

  • On your Appsmith application, click on the + icon next to Datasources on the left navigation bar under Page1.
  • Next, navigate to the Create New tab and choose SnowflakeDB data source.
  • Rename the Datasource to SnowflakeDB CRUD by double-clicking on the existing one.
  • Now, add your SnowflakeDB account details. All the details are available under the SnowflakeCloud settings:

Snowflake Database Dashboard

  • Here’s what the database configuration would look like:
Connecting Snowflake on Appsmith
  • Next, click on the Test button at the bottom right of the screen. It helps you understand whether your configuration is valid or not. If it returns a successful message, hit the ‘Save’ button to establish a secure connection between Appsmith and SnowflakeDB.
info

After the connection is established,you can see all the sample data (tables) under the connected data source.

Now that you have the sample data, you can query the snowflake database in the next section.

Querying Snowflake​

Snowflake databases can be queried using the SQL syntax provided in their command reference documentation. All Snowflake queries return an array of objects where each object is a row returned by the query and each property in the object is a column. Let's look at an example to see how to query the Snowflake database.

  • Click the + icon next to the datasources and choose to Create New + from the SnowflakeDB CRUD data source.
  • Rename the query to getCustomers.
  • Copy the following SQL script to query all the Customers from the CUSTOMER table:
SELECT * FROM TPCDS_SF100TCL.CUSTOMER LIMIT 10;
  • This simple query returns all the customers present in the sample data item. Hit the RUN button to view all the results.

The video below demonstrates how to query the Snowflake database.

Querying Snowflake

You have your query; you can bind it to various widgets. You can take reference from this example and learn how to build a frontend that can connect to SnowflakeDB as a data source.

Using queries in applications​

Once you have successfully run a Query, you can use it in your application to