SnowflakeSearchTool
描述
SnowflakeSearchTool 旨在连接到 Snowflake 数据仓库并执行具有连接池、重试逻辑和异步执行等高级功能的 SQL 查询。此工具允许 CrewAI 代理与 Snowflake 数据库交互,使其成为数据分析、报告和需要访问 Snowflake 中存储的企业数据的商业智能任务的理想选择。
安装
要使用此工具,您需要安装所需的依赖项开始步骤
要有效使用SnowflakeSearchTool,请遵循以下步骤
- 安装依赖项:使用上述命令之一安装所需的软件包。
- 配置 Snowflake 连接:使用您的 Snowflake 凭据创建
SnowflakeConfig对象。 - 初始化工具:使用必要的配置创建工具实例。
- 执行查询:使用该工具对您的 Snowflake 数据库运行 SQL 查询。
示例
以下示例演示了如何使用SnowflakeSearchTool 从 Snowflake 数据库查询数据
代码
代码
参数
SnowflakeConfig 参数
SnowflakeConfig 类接受以下参数
- account:必需。Snowflake 账户标识符。
- user:必需。Snowflake 用户名。
- password:可选*。Snowflake 密码。
- private_key_path:可选*。私钥文件路径(密码的替代方案)。
- warehouse:必需。Snowflake 仓库名称。
- database:必需。默认数据库。
- snowflake_schema:必需。默认模式。
- role:可选。Snowflake 角色。
- session_parameters:可选。自定义会话参数,以字典形式。
password 或 private_key_path 之一。
SnowflakeSearchTool 参数
SnowflakeSearchTool 在初始化期间接受以下参数
- config:必需。包含连接详细信息的
SnowflakeConfig对象。 - pool_size:可选。连接池中的连接数。默认值为 5。
- max_retries:可选。失败查询的最大重试次数。默认值为 3。
- retry_delay:可选。重试之间的延迟,以秒为单位。默认值为 1.0。
- enable_caching:可选。是否启用查询结果缓存。默认值为 True。
用法
使用SnowflakeSearchTool 时,您需要提供以下参数
- query:必需。要执行的 SQL 查询。
- database:可选。覆盖配置中指定的默认数据库。
- snowflake_schema:可选。覆盖配置中指定的默认模式。
- timeout:可选。查询超时时间,以秒为单位。默认值为 300。
代码
高级功能
连接池
SnowflakeSearchTool 实现了连接池,通过重用数据库连接来提高性能。您可以使用 pool_size 参数控制连接池大小。
自动重试
该工具会自动重试失败的查询,并采用指数退避策略。您可以使用max_retries 和 retry_delay 参数配置重试行为。
查询结果缓存
为了提高重复查询的性能,该工具可以缓存查询结果。此功能默认启用,但可以通过设置enable_caching=False 来禁用。
密钥对认证
除了密码认证,该工具还支持密钥对认证以增强安全性代码
错误处理
SnowflakeSearchTool 包含针对常见 Snowflake 问题的全面错误处理
- 连接失败
- 查询超时
- 认证错误
- 数据库和模式错误
结论
SnowflakeSearchTool 提供了一种强大的方式来将 Snowflake 数据仓库与 CrewAI 代理集成。凭借连接池、自动重试和查询缓存等功能,它能够高效可靠地访问企业数据。此工具对于需要访问 Snowflake 中存储的结构化数据的数据分析、报告和商业智能任务特别有用。