Snowflake Extension for Visual Studio Code¶

打开或创建 SQL 个文件¶

1. 在 VS Code 中，选择 File > Open，浏览到 SQL 文件所在的位置，然后打开它。

   要创建一个新的 SQL 文件，请选择 File > New File，并创建类型为 Snowflake SQL File 的文件。

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

3. 可选。选择 Snowflake: Execute All Statements () 以执行命令。

执行命令或查询¶

在 VS 代码中，选择以下选项之一：

• 要执行文件中的所有 SQL 语句，请选择 Snowflake: Execute All Statements ()。

• 要执行特定命令，请将光标放在您想要运行的语句上，然后选择 Execute。

• 要执行多个命令，请选择要运行的语句，然后选择 Execute。这些命令按从上到下的顺序执行。

要使用键盘快捷键执行语句，请选择您想要运行的 SQL 语句，在 Mac 键盘上按 + [enter]，或在 Windows 键盘上按 + [enter]。

执行的 SQL 语句结果显示在 SNOWFLAKE 窗格中。

要取消正在进行的查询，请在 QUERY HISTORY 列表中选择一个查询，然后选择 Cancel query ()。

查看查询历史记录¶

1. 在 VS 代码中，展开 Query History。

2. 选择语句。

3. 在 SNOWFLAKE 窗格中查看结果。

4. 可选。选择以下选项之一：

   • 选择 Snowflake: Copy to Clipboard () 将查询文本复制到剪贴板。

   • 选择 Snowflake: Remove Query () 删除查询。

处理查询结果¶

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

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

2. 在 SNOWFLAKE 窗格中，选择一列。

3. 选择展开箭头 (↓)，然后选择以下选项之一：Sort Ascending、Sort Descending、Hide column "column name" 或 Freeze columns up to "column name"。

   如果之前隐藏了某一列，请选择任何其他列，然后选择 Unhide N columns。

4. 可选。选择以下选项之一：

   • 选择 Cloud () 以将结果保存为压缩的 gzip 文件。

   • 选择 Save () 以将结果保存为逗号分隔的 (CSV) 文件。

调试 Snowpark Python 函数¶

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

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

自动检测 SQL 语句¶

要设置自动 SQL 语法突出显示，请启用 扩展设置 Auto Detect Sql in Python。该扩展可自动检测测 SQL 语句，方法是查找全部为大写字母的 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 自动完成¶

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

2. 写入 SQL 语句。此时将显示自动完成建议。

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

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

Jinja 模板语法突出显示¶

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

查看 VS Code 扩展 Snowflake Native App 命令面板¶

VS Code 扩展 Snowflake Native App 命令面板提供对以下 Snowflake Native App 命令的访问：

• 创建原生应用程序

• 部署原生应用程序

• 关注原生应用程序视图

• 打开原生应用程序

• 运行（部署并重新安装）原生应用程序

• 拆解原生应用程序

要访问这些命令，请在 VS Code 窗口顶部的搜索字段中键入 >Snowflake Native。

创建 Snowflake Native App¶

1. 在 VS Code 中，打开 Snowflake VS Code 扩展并登录到 Snowflake。

2. 展开 NATIVE APP 窗格，然后选择 Create new from template。

3. 选择以下选项之一：

   • 输入您要在其中创建 Snowflake Native App 的文件夹名称，然后按 Enter。

   • 按 Enter 接受默认目录作为 Snowflake Native App 的位置。

4. 选择以下选项之一：

   • 输入在其中存储 Snowflake Native App 模板的 GitHub 存储库的 URL，然后选择 Enter。

   • 输入本地模板文件夹的路径。

   • 要接受默认 GitHub Snowflake Native App 模板存储库 URL，请选择 Enter。

5. 选择以下模板之一：

   • 选择 basic 来创建一个 Snowflake Native App，其中包含最小的代码示例和指导。

   • 选择 streamlit-python 来创建一个 Snowflake Native App，其中包含 Python 扩展代码和 Streamlit 代码示例。

   • 选择 streamlit-java 来创建一个 Snowflake Native App，其中包含 Java 扩展代码和 Streamlit 代码示例。

   • 选择 spcs-basic 来创建一个 Snowflake Native App，其中包含 SPCS 扩展代码和 Streamlit 代码示例。

部署并打开一个 Snowflake Native App¶

如果您使用 Run (deploy and re-install) 或 Deploy 选项，系统会使用在 NATIVE APP 窗格中选择的应用程序。当多个 Snowflake Native App 应用程序可用时，系统会显示提示，您可以选择将哪个 snowflake.yml 文件用于部署。

在您部署您的 Snowflake Native App 后，您可以在 Snowflake 中打开它以管理访问、查看、添加和验证应用程序包、查看日志和事件，以及修改权限。

1. 选择以下选项之一：

   • 在 VS Code 扩展 NATIVE APP 窗格中，选择 Run (deploy and re-install)。这是在您进行了重大更改并且需要应用对象时推荐的选项。

   • 在 VS Code 扩展 NATIVE APP 窗格中，选择 Deploy。这是在部署应用程序包和暂存文件并且不需要应用程序对象时推荐的选项。

2. 可选。选择查询结果窗格中的 OUTPUT 选项卡，以查看部署进度。

3. 在 NATIVE APP 窗格中，选择 Open。

查看 Snowflake Native App 应用程序对象状态¶

• 在 VS Code 扩展 NATIVE APP 面板中，展开您的应用程序。

  蓝色字体和蓝色圆圈表示尚未安装或部署应用程序对象。

查看 Snowflake Environment Variables Manager¶

使用 Snowflake Environment Variables Manager 在环境变量配置文件中创建和管理环境变量。您可以使用环境变量配置文件在 Snowflake Native App 项目定义文件中自定义对象行为。例如，您可以创建环境变量配置文件，以更改开发、暂存和生产环境中的对象行为。有关环境变量和 Snowflake 连接的更多信息，请参阅 项目定义文件。

使用以下方法之一查看 Snowflake Environment Variables Manager：

• 在 VS Code 扩展 NATIVE APP 窗格中，选择 Environment Variables。

• 在命令面板中，选择 Open Environment Variables Manager。

将环境变量添加到环境变量配置文件¶

环境变量配置文件存储环境变量。

1. 在 VS Code 扩展 NATIVE APP 窗格中，选择 Environment Variables。

2. 在 Selected Profile 列表中，选择一个配置文件。

3. 在 Environment Variable 列中，输入一个环境变量。

4. 在 Value 列中，输入环境变量的值。

5. 可选：要将其他环境变量添加到环境变量配置文件，请重复第 3 步和第 4 步。

6. 可选：要将其他行添加到环境变量配置文件，请选择 + (Add Row)。

添加环境变量配置文件¶

环境变量配置文件存储环境变量。要在 Snowflake Native App 项目定义文件中自定义对象行为，请创建一个新的配置文件。

1. 在 VS Code 扩展 NATIVE APP 窗格中，选择 Environment Variables。

2. 选择 Add Profile。

3. 输入配置文件的名称，然后按 Enter。

向环境变量配置文件添加行¶

要添加环境变量，请向环境变量配置文件添加行。

1. 在 VS Code 扩展 NATIVE APP 窗格中，选择 Environment Variables。

2. 在 Selected Profile 列表中选择配置文件。

3. 选择 + (Add Row)。

重命名环境变量配置文件¶

1. 在 VS Code 扩展 NATIVE APP 窗格中，选择 Environment Variables。

2. 在 Selected Profile 列表中选择配置文件。

3. 选择 Rename Profile。

4. 输入配置文件的名称，然后按 Enter。

删除环境变量配置文件¶

1. 在 VS Code 扩展 NATIVE APP 窗格中，选择 Environment Variables。

2. 在 Selected Profile 列表中选择配置文件。

3. 选择 Delete Profile。

启用 Snowflake Native App 调试模式¶

使用调试模式可查看对使用者不可见的应用程序对象，例如共享内容对象或未授予特定数据库角色的对象。有关调试模式以及以编程方式开启它的更多信息，请参阅 启用调试模式。

• 在 VS Code 扩展 NATIVE APP 窗格中，选择 App Debug Mode: OFF。

删除 Snowflake Native App 包和应用程序对象¶

使用 Teardown 选项来删除在解析的项目定义中定义的应用程序对象和包。

• 在 VS Code 扩展 NATIVE APP 窗格中，选择 Teardown。当拆卸完成时，会出现确认消息。

列出暂存区中的所有文件¶

1. 在 VS Code OBJECT EXPLORER 中，导航到一个暂存区。

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

将文件从本地文件系统上传到暂存区¶

Snowflake Extension for Visual Studio Code 仅支持内部暂存区的上传，所有其他操作对内部和外部暂存区均适用。

1. 在 VS Code OBJECT EXPLORER 中，导航到一个暂存区，然后选择 Upload ()。

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

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

将文件从暂存区下载到本地文件系统¶

1. 在 VS Code OBJECT EXPLORER 中，导航到一个暂存区。

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

3. 选择并下载文件。

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

从暂存区移除文件¶

另请参阅 REMOVE。

1. 在 VS Code OBJECT EXPLORER 中，导航到一个暂存区。

2. 选择一个文件。

3. 选择 Remove ()。

VS Code 扩展预览设置¶

下表列出了 VS Code 扩展预览设置。

更改 VS Code 扩展设置¶

1. 选择以下选项之一：

   • 在 Windows/Linux 上，选择 File > Preferences > Settings。

   • 在 macOS 上，选择 Code > Settings > Settings。

2. 在 Search settings 字段中，输入 Snowflake。

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

4. 关闭 Settings 选项卡。