Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature: add supported caching data sources description text #259

Merged
merged 1 commit into from
Jul 28, 2023
Merged

feature: add supported caching data sources description text #259

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions packages/doc/docs/develop/cache.mdx
View file
Open in desktop
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