Snowflake Extension for Visual Studio Code¶

Open or create SQL files¶

1. In VS Code, select File » Open, browse to the location of a SQL file, and then open it.

   To create a new SQL file, select File » New File and create a file of type Snowflake SQL File.

2. Add one or more Snowflake SQL statements to the file.

3. (Optional) Click Snowflake: Execute All Statements () to execute a command.

Execute commands or queries¶

In VS Code, select one of the following options:

• To execute all SQL statements in a file, click Snowflake: Execute All Statements ().

• To execute a specific command, place your cursor on the statement you want to run and then click Execute.

• To execute multiple commands, select the statements you want to run and then click Execute. The commands execute in order from top to bottom.

To use keyboard shortcuts to execute statements, select the SQL statements you want to run, press + [enter] on a Mac keyboard, or + [enter] on a Windows keyboard.

Executed SQL statement results display in the SNOWFLAKE panel.

To cancel in-progress queries, select a query in QUERY HISTORY list and click Cancel query ().

View query history¶

1. In VS Code, expand Query History.

2. Select a statement.

3. Review the results in the SNOWFLAKE panel.

4. (Optional) Select one of the following:

   1. Click Snowflake: Copy to Clipboard () to copy the query text to the clipboard.

   2. Click Snowflake: Remove Query () to delete a query.

Work with query results¶

You can sort, reorder, hide, freeze, or save query results to disk.

1. In QUERY HISTORY, select a query.

2. In the SNOWFLAKE panel, choose a column.

3. Select the expander arrow (↓) and then one of: Sort Ascending, Sort Descending, Hide column “column name”, or Freeze columns up to “column name”.

   If a column was previously hidden, choose any other column and select Unhide N columns.

4. (Optional) Select one of the following:

   1. Click Cloud () to save the results as a a compressed gzip file.

   2. Click Save () to save the results as a comma-separated (CSV) file.

Debug Snowpark Python functions¶

1. Write a Snowflake stored procedure in a Python function where the first parameter is a Snowpark Session object.

2. An inline Snowflake: Debug option appears above the function name. Choose this option to run the stored procedure in the function, using your current active session through the extension. You can also set debug breakpoints.

Detect SQL statements automatically¶

To set up automatic SQL syntax highlighting, enable the extension setting Auto Detect Sql in Python. The extension automatically detects SQL statements by looking for a SQL keyword in all capital letters as the first word in a Python string, as shown in the following image.

Denote SQL statements manually¶

1. (Optional) Disable the extension setting Auto Detect Sql in Python.

2. Use comments to denote the start and end of a SQL statement. You can use any combination of the following markers:

   • Start markers: -–startsql, -–beginsql, -–start-sql, -–begin-sql

   • End markers: –-endsql, –-end-sql

   The following image shows how the --begin-sql and --end-sql markers manually denote a SQL statement.

Use SQL autocomplete in Python strings¶

1. In a Python file, create a Python string while connected to an active Snowflake session with the VS Code extension.

2. Write a SQL statement. The autocomplete suggestions appear.

   For example, when you start writing a statement such as SELECT * FROM db1.public, the extension automatically suggests table names.

   Similarly, when you start filling out columns inside a SELECT statement that references a table, the extension automatically suggests column names, as shown in the following image.

Jinja template syntax highlighting¶

By default, the VS Code extension adds basic syntax highlighting and bracket autocomplete for writing Jinja templates in Snowflake SQL, as shown in the following image.

List all the files in a stage¶

1. In the VS Code OBJECT EXPLORER, navigate to a stage.

2. Expand the stage to see all staged files.

Upload files from the local file system to a stage¶

The Snowflake Extension for Visual Studio Code only supports uploads for internal stages, all other operations work for both internal and external stages.

1. In the VS Code OBJECT EXPLORER, navigate to a stage and click Upload ().

2. Enter optional parameters for the upload operation. See PUT for a list of optional parameters.

3. Navigate to the folder containing upload files, and then select and upload one or more files.

Download files from a stage to a local file system¶

1. In the VS Code OBJECT EXPLORER, navigate to a stage.

2. Click Download () to download all files, or expand the stage.

3. Select and download a file.

4. Select a directory to complete the download.

Remove files from a stage¶

See also REMOVE.

1. In the VS Code OBJECT EXPLORER, navigate to a stage.

2. Select a file.

3. Click Remove ().

VS Code extension preview settings¶

The following table lists the VS Code extension preview settings.

Change VS Code extension settings¶

1. Select one of the following:

   1. On Windows/Linux select File » Preferences » Settings.

   2. On macOS select Code » Settings » Settings.

2. In the Search settings field, enter Snowflake.

3. Select the User or Workspace tabs to view or modify user specific or workspace specific settings.

4. Close the Settings tab.