Canner/vulcan-sql

What is VulcanSQL

VulcanSQL is a Data API Framework for data applications that helps data folks create and share data APIs faster. It turns your SQL templates into data APIs. No backend skills required.

Online Playground

Use Online Playground to get a taste of VulcanSQL!

Examples

Need Inspiration?! Discover a selected compilation of examples showcasing the use of VulcanSQL!

Installation

Please visit the installation guide.

How VulcanSQL works?

💻 Build

VulcanSQL offers a development experience similar to dbt. Just insert variables into your templated SQL. VulcanSQL accepts input from your API and generates SQL statements on the fly.

🚀 Accelerate

VulcanSQL uses DuckDB as a caching layer, boosting your query speed and API response time . This means faster, smoother data APIs for you and less strain on your data sources.

🔥 Deploy

VulcanSQL offers flexible deployment options - whether you prefer Docker or command-based setups. Our package command assists in bundling your assets, ensuring a smooth transition from development to deployment of your data APIs.

❤️ Share

VulcanSQL offers many data sharing options, seamlessly integrating your data into familiar applications within your workflow.

Documentation

Below are some common scenarios that you may be interested:

• Getting Started
• Introduction
• Guides to Build Data APIs
  • Connecting to Data Sources
  • Writing SQL Templates
  • Caching Datasets
  • Error Handling
  • API Parameters Validation
  • Data Privacy
• API Configurations
• Deployment

Use Cases

📈 Customer-facing analytics: Expose analytics in your SaaS product for customers to understand how the product is performing for them via customer dashboards, insights, and reports.

👏 Data sharing: Sharing data with partners, vendors, or customers, which requires a secure and scalable way to expose data.

⚙️ Internal tools: Integration with internal tools like AppSmith and Retools, etc.

Community

• Welcome to our Discord server to give us feedback!
• If there is any issues, please visit Github Issues.