vulcan-sql

<p align="center"> <img src="https://i.imgur.com/9xLnLed.png" width="600" > </p> <p align="center"> <a aria-label="Canner" href="https://cannerdata.com/"> <img src="https://img.shields.io/badge/%F0%9F%A7%A1-Made%20by%20Canner-orange?style=for-the-badge"> </a> <a aria-label="NPM版本" href="https://www.npmjs.com/package/@vulcan-sql/core"> <img alt="" src="https://img.shields.io/npm/v/@vulcan-sql/core?color=orange&style=for-the-badge"> </a> <a aria-label="许可证" href="https://github.com/Canner/vulcan-sql/blob/develop/LICENSE"> <img alt="" src="https://img.shields.io/github/license/canner/vulcan-sql?color=orange&style=for-the-badge"> </a> <a aria-label="关注我们" href="https://twitter.com/vulcansql"> <img alt="" src="https://img.shields.io/badge/-@vulcansql-orange?style=for-the-badge&logo=twitter&logoColor=white&labelColor=gray&logoWidth=20"> </a> <a href="https://img.shields.io/codecov/c/gh/Canner/vulcan-sql" > <img alt="" src="https://img.shields.io/codecov/c/gh/Canner/vulcan-sql?style=for-the-badge&color=orange&labelColor=gray&logoColor=white&logoWidth=20"/> </a> </p>

什么是VulcanSQL？

VulcanSQL是一个面向AI代理和数据应用的分析数据API框架。它旨在帮助数据专业人员更轻松、安全地从数据库、数据仓库或数据湖交付RESTful API。它能快速将您的SQL转换为API！

为什么选择VulcanSQL？

鉴于数据库、数据仓库和数据湖中存在大量分析数据，目前数据专业人员没有简便的方法与相关利益相关者共享数据以用于运营业务用例。

如果没有专门的框架来简化为AI代理和应用程序创建与数据库和数据仓库交互的API，开发人员今天必须采取更加手动和复杂的流程。这种方法带来了几个痛点和挑战：

传统方法和痛点

1. 自定义API开发：

• 耗时：开发人员需要手动编写API代码，这可能很耗时，尤其是对于复杂的应用程序或处理多个数据源时。
• 容易出错：手动编码增加了出现错误和漏洞的风险，可能影响API的可靠性和性能。

2. 集成复杂性：

• 多样化数据源：集成具有不同格式和协议的多个数据源需要大量努力和专业知识。
• 缺乏标准化：没有标准化的方法，每个API可能遵循不同的约定，使AI代理更难以一致地与它们交互。

3. 安全性和合规性：

• 安全风险：确保API安全并且数据访问符合法规（如GDPR、HIPAA）需要额外的工作层，包括身份验证、授权和数据加密。
• 维护开销：安全和合规要求可能会不断演变，需要对API进行持续维护和更新。

4. 可扩展性和性能：

• 可扩展性问题：自定义构建的API可能没有针对可扩展性进行优化，随着请求数量或数据量的增长可能导致性能问题。
• 资源密集：优化性能和可扩展性可能需要大量资源，无论是开发时间还是基础设施方面。

5. 文档和可用性：

• 缺乏文档：为其他开发人员或AI代理正确编写易于理解和使用的API文档可能被忽视或低估。
• 可用性问题：没有清晰全面的文档，其他人很难集成和有效使用API。

使用VulcanSQL，您可以

• 快速开发和集成：通过抽象直接与数据库和数据仓库交互的复杂性，开发人员可以专注于应用程序的高层逻辑。这减少了开发时间，简化了将AI功能集成到应用程序中的过程。

• 标准化：利用OpenAPI文档进行交互为AI代理提供了一种标准化的方式来理解和与不同的API交互。这促进了各种系统和工具之间的互操作性，使其更容易与广泛的服务和数据源集成。

• 可扩展性和维护性：采用模板驱动的API创建方法可以使API更容易随时间扩展和维护。底层数据模式或业务逻辑的变化可以更有效地传播到API，无需进行大量手动调整。

• 可访问性：通过定义良好的API使数据更容易被AI代理访问，可以通过利用机器学习和分析解锁新的洞察力和功能。这可以增强决策过程并自动化常规任务等。

在线演练场

使用在线演练场来体验VulcanSQL！

安装

请访问安装指南。

示例

需要灵感？这里有一个精选示例汇编，展示了如何使用VulcanSQL！

VulcanSQL如何工作？

💻 构建

VulcanSQL提供类似于dbt的开发体验。只需将变量插入到模板化的SQL中。VulcanSQL接受来自您的API的输入，并动态生成SQL语句。

🚀 加速

VulcanSQL使用DuckDB作为缓存层，提高查询速度并减少API响应时间。这意味着更快、更流畅的数据API，同时减少对数据源的压力。

🔥 部署

VulcanSQL提供灵活的部署选项 - 无论您喜欢Docker还是基于命令的设置。我们的package命令帮助打包您的资产，确保从开发到部署数据API的顺利过渡。

❤️ 共享

VulcanSQL提供多种数据共享选项，无缝将您的数据集成到工作流程中的熟悉应用程序中，并构建AI代理。

文档

以下是您可能感兴趣的一些常见场景：

• 入门
• 介绍
• 构建数据API指南
  • 连接数据源
  • 编写SQL模板
  • 缓存数据集
  • 错误处理
  • API参数验证
  • 数据隐私
• 扩展
• API配置
• 部署

用例

🤖 AI代理：简化为AI代理创建与数据库和数据仓库交互的API。

📈 面向客户的分析：在您的SaaS产品中公开分析，让客户通过客户仪表板、洞察和报告了解产品对他们的表现。

👏 数据共享：与合作伙伴、供应商或客户共享数据，需要一种安全且可扩展的方式来公开数据。

⚙️ 内部工具：与Zapier、AppSmith和Retools等内部工具集成。

社区

• 如有任何问题，请访问Github问题。