6.3 从本地开发环境使用SQL API

我们将首先设置一个本地开发环境，这将使我们能够使用Snowpark Python构建客户端应用程序。

6.3.1 安装和配置本地开发环境

要安装和配置您的本地开发环境，请按照以下步骤操作：

1 在您的计算机上本地安装Python，或者如果您已经有一个，使用现有的Python安装。检查Snowflake文档以查看您是否有支持的版本之一。

2 根据您本地使用的Python版本，使用conda或venv为它创建一个虚拟环境。

3 根据您本地使用的Python，使用conda或pip安装snowflake-snowpark-python包。

注意：执行这些步骤的详细说明可在Snowflake文档中找到，网址为https://mng.bz/ZV65。

您可以使用集成开发环境（IDE）与Snowpark一起使用。一个流行的IDE是Microsoft Visual Studio Code，但您可以使用其他开发环境。确保开发环境使用支持的Python版本（有关将正确版本与您的开发环境关联的说明，请参阅您首选开发环境的文档）。

6.3.2 创建Snowflake会话

在本地开发环境中执行Snowpark Python的第一步是建立与您的Snowflake账户的连接。要使用Snowflake创建会话，请按照以下步骤操作：

1 从您之前在设置环境时安装的snowflake.snowpark包中导入Session模块。

2 在Python中创建一个字典数据结构，您在其中提供连接信息，例如Snowflake账户名称、您的用户名、您的密码，以及可选的角色、虚拟仓库、数据库和会话中使用的模式。

3 调用Session模块的create()方法以返回一个命名的会话对象。

清单6.3中的代码创建了一个名为connection_parameters_dict的Python字典，它指定了您的Snowflake账户、用户名、密码以及SYSADMIN角色，BAKERY_WH仓库、BAKERY_DB数据库以及SNOWPARK模式。然后，它在创建名为my_session的会话对象时使用这个字典作为参数。

在接下来的练习中，你将使用会话对象向Snowflake提交命令。我们现在不会提交任何命令，但我们会遵循良好的编程实践，关闭会话，以避免它在Snowflake中保持活动状态。

警告：清单6.3中的代码可用于测试，但绝不应在生产环境中使用，因为它包含了建立Snowflake连接所需的凭据。永远不要将凭据保存在代码仓库中或提供给其他方。相反，使用配置文件或密钥来提供连接凭据。

6.3.3 在配置文件中提供凭据

在Snowpark Python中，有多种方法可以提供Snowflake连接的凭据。例如，你可以将凭据存储在你的云提供商的密钥管理器中。或者，你可以创建一个存储凭据的配置文件，并读取文件以检索信息。另一种方法可能是将凭据定义为你的操作系统的环境变量。

替代用户名和密码创建会话的方式

除了使用凭证，如用户名和密码外，您还可以使用单点登录、多因素认证、密钥对认证或OAuth来创建Snowpark会话。有关创建Snowpark会话的更多信息，请参阅Snowflake文档，网址为https://mng.bz/RNrD。

在本章的例子中，我们将使用一个配置文件。配置文件可以是任何结构化的格式，如CSV、JSON或YML，这些格式都可以被Python，转换成字典结构，并随后用于连接参数。

让我们通过一个JSON文件来说明这个例子。我们将创建一个名为connection_parameters.json的文件，内容如下（确保替换你的Snowflake账户、用户名和密码）:

我们将使用Python中的json库来读取这个文件的内容，并调用json.load()方法来读取文件内容。然后我们将构建一个名为connection_parameters_dict的Python字典，并调用Session模块的create()方法，就像在列表6.3中一样。读取配置文件并创建与Snowflake的会话的代码如下所示。

如列表6.4中的代码所示，没有可见的配置参数，因此你可以安全地将这段代码保存到代码库中。

警告：不要将connection_parameters.json文件保存在你的代码库中。你可以将这个文件保存在代码项目文件以外的位置。

它不会提交到代码仓库，或者你可以将connection_parameters.json文件名添加到.gitignore文件中，以确保在提交到代码仓库时被忽略。

6.3.4 查询数据和执行SQL命令

一旦你的Python代码中存在会话对象，你可以使用session.sql()方法向Snowflake发送SQL命令。例如，要选择Snowflake服务器上的当前时间戳并将输出打印到Python控制台，你可以执行以下命令：

注意：在使用Snowpark执行SQL命令时，请记住返回的数据类型是一个惰性评估的数据框架。只有当你发送一个动作，如collect()、count()、show()或save_as_table()时，SQL语句才会在Snowflake服务器上执行。

6.4 在Snowpark Python中生成日期维度

凭借我们迄今为止的知识，我们可以通过结合我们在前面章节中开发的一些代码，继续我们的Snowpark Python学习之旅。首先，我们将使用Snowpark API在客户端本地构建Python代码，将数据保存到数据框架中，然后保存到Snowflake数据库和模式中的表里。

我们将构建一个日期维度，包括日期和标志，指示每个日期是否是面包店运营国家的假日。面包店稍后将使用这个维度，连同订单信息一起，更好地围绕假日规划需求。

我们将从导入编写代码所需的Python包开始。我们将使用以下包：

? snowflake.snowpark——从Snowpark Python连接到Snowflake

? snowflake.snowpark.types——定义数据类型（维度中的日期和用于指示日期是否为假日的布尔标志），以及在将数据保存到Snowflake时指定模式所需的StructType和StructField类型

? json——读取连接参数

? datetime——在Python中处理日期和时间间隔

? holidays——确定一天是否为假日。根据您使用的Python版本，您必须使用pip或conda在本地安装此包。

注意 在示例6.1中，我们在Snowsight Python工作表中创建了IS_HOLIDAY Python函数时，安装了holidays包。因为代码是在Snowflake服务器端执行的，在那里包已经可用。我们只需要在工作表的Packages下拉列表中指出我们将使用这个包。

在这一部分，我们是在客户端本地编写代码，这意味着我们必须在本地安装包。

下面的代码清单显示了导入所有包的代码。

下一步是在Python中创建一个函数，就像我们在列表6.2中构建的那个，除了我们希望这个函数能够在本地Python代码中运行，而不是在Python工作表中执行。当在本地运行时，函数不需要会话参数。下面的代码示例展示了如何使用holidays包来返回一个标志，指示参数中的日期是否是假日。

为了构建一个日期维度，我们必须生成一个日期列表。我们将使用Python的datetime包中的date和timedelta模块。最终，日期维度将包含从面包店开始运营的那一天起的历史日期，直到未来一年或更长时间，这取决于面包店想要规划多远的未来。

为了使这个例子中的代码开发和测试更加易于管理，我们将从2023年1月1日开始，并在维度中包括五天。稍后，一旦我们完成了代码的最终化和测试，并且我们确信它能正确工作，我们将重新运行它以包括更多的日期。

下一个列表显示了生成日期列表的Python代码，该列表从start_dt变量定义的起始日期开始，并持续no_days变量定义的天数。

我们将向这个日期列表中添加一个标志，以使用我们之前创建的is_holiday()函数来指示它是否是假日。输出将是一个列表的列表，如下面代码示例中所示。

此时，我们可以使用以下代码将假期标志的列表打印到控制台，以检查数据是否符合预期：

从2023年1月1日开始应该有五个日期，每个日期都标示是否为假日。以下片段展示了输出的样式（2023年1月1日和1月2日在美国是假日，而剩余的日期不是假日）：