Snowflake Extension for Visual Studio Code¶

从 Visual Studio Marketplace 安装¶

若要直接从 Visual Studio Marketplace 安装，请执行以下操作：

1. 打开 Visual Studio Code。

2. 选择 Code » Preferences » Extensions。

   您还可以选择 View » Extensions 或点击 VS Code Activity Bar 中的扩展按钮 。

3. 在 Search Extensions 文本框中，输入文本 Snowflake 来搜索 Snowflake Visual Studio 扩展。

4. 从扩展集中，选择由 Snowflake 编写的扩展，然后点击 Install。

从 .vsix 文件安装¶

若要下载 .vsix 文件并从该文件安装，请执行以下操作：

1. 下载扩展。

   1. 打开 Snowflake Visual Studio Code 扩展 (https://marketplace.visualstudio.com/items?itemName=snowflake.snowflake-vsc) 页面。

   2. 选择 Version History 选项卡。

   3. 选择要下载的版本，然后点击 Download。 记下文件的下载位置。

2. 打开 Visual Studio Code。

3. 选择 Code » Preferences » Extensions。

   您还可以选择 View » Extensions 或点击 Activity Bar 中的扩展按钮 。

4. 从“More”(...) 菜单中选择 Install from VSIX。

1. 在计算机上找到 snowflake-x.y.z.vsix 文件，选中该文件，然后选择 Install。

安装完成后，Snowflake Extension for Visual Studio Code 将显示在 VS Code Extensions 菜单的 INSTALLED 部分中。

将 Snowflake Extension for Visual Studio Code 与 SnowSQL 配置文件一起使用¶

Snowflake Extension for Visual Studio Code 可以使用 Snow SQL 配置文件 来加载连接配置。

要配置 Snowflake Extension for Visual Studio Code 以使用 Snow SQL 配置文件，请执行以下操作：

1. 在 Activity Bar 中，选择 Snowflake 图标。

   边栏面板将更改为 Snowflake 导航，并显示 Add Account 或 Sign in 对话框。

2. 选择 Username 下拉列表，然后选择 Sign in to another account。

3. 选择 Use SnowSQL Config。此时将打开 Snowflake Extension for Visual Studio Code 的 Visual Studio 代码设置页，并选中 SnowSQL Config Path。

4. 输入有效 SnowSQL 配置文件的路径。

账户下拉列表将更新，以包含指定配置文件中定义的所有连接。

打开 SQL 文件¶

要创建或打开 Snowflake SQL 文件，请执行以下操作：

1. 选择 File » Open，导航到包含 SQL 的文本文件并打开。

   如果没有现有 SQL 文件，可以创建一个新文件。选择 File » New File，创建一个类型为 Snowflake SQL File 的文件。或者，在数据库资源管理器面板中选择 ()，创建新的 SQL 文件。

2. 将一个或多个 Snowflake SQL 语句添加到文件中。

3. 选择一行，然后点按该行上方的 [Execute] 以执行命令。

执行命令或查询¶

若要执行一个或多个命令或查询，请执行以下操作：

1. 选择所选 SQL 文件的 ，执行该文件中的所有语句。

2. 将光标放在要运行的语句上来选择要运行的行。

   选择两个或多个命令 – 将执行所有选定的命令。

3. 点击所选第一个命令上方的[执行]按钮。

如果选择多个命令，则命令将按从上到下的顺序执行。

还可以使用键盘快捷键运行语句。选择要运行的 SQL 语句后，在 Mac 键盘上按 + [Enter]，或在 Windows 键盘上按 + [Enter]。

您可以在 Output 部分的 SNOWFLAKE:QUERY RESULTS 表中查看 SQL 语句的结果。

使用查询历史记录¶

QUERY HISTORY 中可跟踪查询结果。

若要检查以前执行的查询结果，请执行以下操作：

1. 展开 Query History。

2. 选择语句。

3. 在 Output 窗格的 SNOWFLAKE:QUERY RESULTS 选项卡中检查结果。

处理查询结果¶

您可以对查询结果进行排序、重新排序、隐藏、冻结或保存到磁盘。

若要修改给定查询的显示，请执行以下操作：

1. 在 QUERY HISTORY 中，选择一个查询。

2. 在 QUERY RESULTS 中，选择一列。

3. 选择向下箭头 (↓)，然后选择以下选项之一：SORT A-Z （降序）、Sort Z-A （升序）、Hide column "column name" 或 Freeze columns up to "column name"。

内容显示将相应更改。

若要将查询结果保存到磁盘，请选择与该查询关联的磁盘 () 或下载 ()。内容将保存在文件中，可以是压缩的 gzip，也可以是逗号分隔的文件。

调试 Snowpark Python 函数¶

要调试 Snowpark Python 函数，请执行以下操作：

1. 在 Python 函数中编写一个 Snowflake 存储过程，其中第一个参数是 Snowpark Session 对象。

2. 您应该看到函数名称上方出现一个内联 Snowflake: Debug 选项。选择此选项可通过扩展使用当前活动会话在函数中运行存储过程。您还可以设置调试断点。

Python 中 SQL 的语法突出显示和自动完成¶

您可以通过启用自动检测，或使用注释手动表示 SQL 字符串，在 Python 代码中添加 SQL 的语法突出显示。

自动检测 SQL 语句¶

要设置自动 SQL 语法突出显示，请启用 扩展设置 Auto Detect Sql in Python。该扩展可自动检测测 SQL 语句，方法是查找全部为大写字母的 SQL 关键字作为 Python 字符串中的第一个单词，如下方屏幕截图所示。

手动表示 SQL 语句¶

要手动表示 Python 字符串中的 SQL 语句，请执行以下操作：

1. （可选）禁用 扩展设置 Auto Detect Sql in Python。

2. 使用注释表示 SQL 语句的开始和结束。您可以使用以下标记的任意组合：

   • 起始标记：-–startsql、-–beginsql、-–start-sql、-–begin-sql

   • 结束标记：–-endsql、–-end-sql

例如，下面的屏幕截图显示了使用 --begin-sql 和 --end-sql 手动表示 SQL 语句的代码。

在 Python 字符串中使用 SQL 自动完成¶

要在 Python 字符串中使用 SQL 语句自动完成，请执行以下操作：

1. 在 Python 文件中，创建一个 Python 字符串，同时通过扩展连接到活动的 Snowflake 会话。

2. 开始编写 SQL 语句并查看出现的自动完成建议。

例如，开始编写 SELECT * FROM db1.public 等语句时，扩展会自动建议表名称。

同样，开始在引用表的 SELECT 语句内部填充列时，扩展会自动建议列名称，如下面的屏幕截图所示。

Jinja 模板语法突出显示¶

默认情况下，该扩展在 Snowflake SQL 中为编写 ` Jinja 模板 <https://jinja.palletsprojects.com/en/3.1.x/ (https://jinja.palletsprojects.com/en/3.1.x/)>`_ 添加基本的语法突出显示和括号自动完成，如下图所示。

使用暂存区¶

Snowflake Extension for Visual Studio Code 支持直接在数据库资源管理器中管理暂存区内容。您可以：

• 列出暂存区中的所有文件：

  1. 导航到特定暂存区。

  2. 展开暂存区以查看所有暂存文件。

• 将文件从本地文件系统上传到暂存区，类似于 PUT：

  1. 导航到暂存区，然后选择上传 ()。

  2. 输入上传操作的可选参数。有关可选参数的列表，请参阅 PUT。

  3. 导航到包含要上传的文件的文件夹，选择一个或多个文件并上传。

• 将文件从暂存区下载到本地文件系统，类似于 GET：

  1. 导航到暂存区。

  2. 在暂存区上选择下载 () 以下载所有文件，或展开暂存区。

  3. 选择一个文件并下载该文件。

  4. 选择一个目录以完成下载。

• 从暂存区中移除文件，类似于 REMOVE：

  1. 选择一个文件。

  2. 选择相应的移除按钮 ()。

显示更新日志¶

要查看扩展的更新日志，也可以使用 Show Change Log 命令：

1. 在 Mac 键盘上按 CMD+Shift+P 或在 Windows 键盘上按 CTRL+Shift+P 打开 Command Palette。

2. 输入以下命令：

   Show Change Log
   

   Copy

预览中的扩展设置¶

以下扩展设置当前可用于预览：

更改扩展设置¶

要更改扩展设置，请执行以下操作：

1. 在 Windows/Linux 上，选择 File » Preferences » Settings。. 在 macOS 上，选择 Code » Preferences » Settings。

2. 在 Search settings 文本框中输入 Snowflake。

3. 选择 User 或 Workspace 选项卡，查看或修改特定于用户或工作区的设置。

4. 关闭 Settings 选项卡。