Skip to content

Commit

Permalink
Merge pull request #259 from cyyeh/feature/update-doc
Browse files Browse the repository at this point in the history
feature: add supported caching data sources description text
  • Loading branch information
cyyeh committed Jul 28, 2023
2 parents 3c282e6 + 7e53303 commit 57773b2
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions packages/doc/docs/develop/cache.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ To provide efficient caching functionality, VulcanSQL utilizes [DuckDB](https://
Please note that in order to use the caching layer feature, you need to have the [DuckDB extension](../connectors/duckdb) installed. If you are using VulcanSQL CLI binary, the DuckDB extension is already pre-bundled, so no additional installation is required. However, if you are using VulcanSQL in a NodeJS project, make sure to install the DuckDB extension separately to enable the caching functionality.
:::

:::caution
At the moment, if you need to use the caching layer, only these data sources are supported: BigQuery, Snowflake and DuckDB.
If you need to have the caching layer enabled for other data sources, please [submit a feature request on GitHub](https://github.com/Canner/vulcan-sql/issues/new?assignees=&labels=type%2Fenhancement%2C+needs-triage&projects=&template=feature-request.md&title=). Thank you!
:::

First, you need to add the following configuration to vulcan.yaml.

```yaml title="vulcan.yaml"
Expand Down

1 comment on commit 57773b2

@vercel
Copy link

@vercel vercel bot commented on 57773b2 Jul 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.