Connect to Snowflake

Important Nexla Help Center Update:

Nexla's Zendesk Help Center pages are being deprecated and will soon no longer be available.

Nexla Documentation is now the home for Nexla's User Guides, with improved formatting and categories that are easier to navigate, providing a better overall user experience.

Please update any bookmarks to the new Nexla Documentation site (docs.nexla.com/user-guides).

_______________________________________________

This article describes how to add a new Snowflake data source in Nexla.

For the version of this article pertaining to the previous Nexla UI, click here.

Contents:

1. Begin Adding a Snowflake Data Source
2. Input Your Credential
3. Configure the Database Source
3.1 Table Mode
3.2 Query Mode
4. Schedule Data Source Scanning
5. Finish Creating the Snowflake Data Source

1. Begin Adding a Snowflake Data Source

1. Log into Nexla with your provided credentials.
   

   If you need credentials, contact [e-mail].

2. Navigate to the Integrate section by selecting from the platform menu on the left side of the screen.
   
   
3. Click  at the top of the Integrate toolbar on the left.
   
   
   
   
4. Select from the data source list; then, click in the top right corner of the screen to begin adding the Snowflake data source.

2. Input Your Credential

1. Select to open the Add a New Credential window and begin adding a new Snowflake credential.
   

   To use a credential that has already been added, select that credential, click in the top right corner of the screen, and skip to Section 3.

2. Enter a name for the credential in the Credential Name field.
   
   
   
   
3. Optional: Enter a description of the credential in the Credential Description field.
   
   
   
   
4. Enter the Snowflake host name corresponding to the database to be added in the Host field.
   

   The Snowflake host typically follows the format of <account_name>.snowflakecomputing.com.

   
   
   
5. Enter the appropriate port number in the Port field.
   
   
   
   
6. Select the type of permission mechanism—basic authentication or key pair authentication—that should be used to allow Snowflake access from the Authenticate Using pulldown menu.
   
   
   
   
7. Enter the username associated with the Snowflake account in the Username field.
   
   
   
   
8. Enter the password associated with the Snowflake account in the Password field.
   
   
   
   
9. Enter the name of the Snowflake database from which data should be read in the Database Name field.
   
   
   
   
10. Enter the name of the Snowflake warehouse containing the database specified in Step 9 in the Snowflake Warehouse field.
    
    
11. Enter the name of the schema used in the database in the Snowflake Schema Name field.
    
    
    
    
12. Optional: Click at the bottom of the Add New Credential window to access the following additional credential settings:
    
    
    • If the Snowflake database from which data should be read is not publicly accessible, check the box next to . This will append additional related fields to be populated in the Add New Credential window.
      

      Selecting this option allows Nexla to connect to a bastion host via SSH, and the database connection will then be provided through the SSH host.

      
      
      
      1. Enter the SSH tunnel hostname or IP address of the bastion host running the SSH tunnel server that has access to the database in the SSH Tunnel Host field.
         
         
         
         
      2. Enter the number of the tunnel bastion host port to which Nexla can connect in the SSH Tunnel Port field.
         
         
         
         
      3. Create an SSH username for Nexla in the bastion host, and enter that username in the Username for Tunnel field.
         

         Typically, this username is set to "nexla".

         
         
         
    • If the configuration of the Snowflake database from which data should be read requires the application of a special, non-default role to allow access to the needed data, enter the name of the required role in the Access Control Role field.
      
      
      
      
13. Click at the bottom of the Add New Credential window to save the credential, and proceed to Section 3 to configure the source in table mode (Section 3.1) or query mode Section 3.2).
    
    

3. Configure the Database Source

In Nexla, the Snowflake database source can be selected using either Table Mode or Query Mode.

Table Mode allows users to specify the database source through a simple selection method. This mode is equivalent to running a simple, optimized SELECT operation on any database table. To use this mode for configuration, see Section 3.1.

Query Mode allows users to perform a complex query to specify the database source. This mode provides a free-form query editor that can be used to perform any complex query written using the syntax and convention supported by the underlying database and/or warehouse. To use this mode for configuration, see Section 3.2.

3.1 Table Mode

1. To configure the database source using Table Mode, ensure that the tab is selected.
   
   
   
   
2. Find the database location from which Nexla should read data. Expand files as necessary by clicking the icon next to each.
   
   
3. Select the location from which data should be read by hovering over it and clicking the button that appears to the right.
   

   The button should now display , and the path of the selected location will be shown at the top of the list.
   
   

4. Optional: Click the button to the right of the mode-selection tabs to generate preview samples of data from the selected source at the bottom of the screen.
   
   
   
   

3.2 Query Mode

1. To configure the Snowflake source using Query Mode, select the tab.
   
   
   
   
2. Enter the query specifying the database location from which Nexla should read data in the Custom Query to Fetch Data field, adhering to the Snowflake SQL syntax and convention.
   

   In this mode, Nexla supports any query that can be written following the Snowflake syntax and convention, regardless of complexity.
   
   For more information about Snowflake SQL syntax, see this Snowflake document.

   
   
   
3. Optional: Click the button to the right of the mode-selection tabs to generate preview samples of the data selected according to the entered query at the bottom of the screen.
   
   
   
   

4. Schedule Data Source Scanning

1. In the Advanced Settings menu on the right, use the Scheduling pulldown menu to specify how often Nexla should fetch data from the source.
   

   The default setting configures Nexla to fetch any new data from the source once every day.

   
   
   
   • For options such as "Every N Hours" and "Every N Days", use the additional pulldown menu that appears when these options are selected to specify the value of N defining the fetching frequency.
     
     
     
     
2. Optional: To set a specific time at which Nexla should fetch any new data from the source, check the box, and type or use the pulldown menus to enter the desired time.
   
   
   
   

5. Finish Creating the Snowflake Data Source

1. Once all of the above steps have been completed, click in the upper right corner of the screen to create the new Snowflake data source.
   
   
2. The confirmation page indicates that the Snowflake database has been successfully created as a data source.
   
   
   
   
3. Optional: Edit the name of the newly added data source by clicking on the name field and entering the desired text.
   
   
   
   
4. Optional: Add a description of the data source by clicking on the field below the data source name and entering the desired text.
   
   
   
   
   • To return to My Data Sources, click in the upper right corner of the screen.
     
     
   • To view the newly created data source, click .
     
     
   • To view datasets detected from the newly added source, click .