Skip to content

Commit 40e73d7

Browse files
committed
chore: update
1 parent 59dbcab commit 40e73d7

4 files changed

Lines changed: 21 additions & 2 deletions

File tree

packages/doc/docs/develop/api-doc.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ In this section, we will discuss how VulcanSQL automatically generates API docum
44
VulcanSQL automatically generates and serves the API documentation for you. To view the documentation, navigate to `<vulcan-endpoint>/doc` after starting the VulcanSQL server. From this page, you can also download the API specification in the Swagger format.
55

66
## Setting Sampler
7+
8+
:::caution
9+
If [caching is enabled](../develop/cache) in the API endpoint, the sampling funcaionality is disabled.
10+
:::
11+
712
VulcanSQL offers a powerful feature called `sampler` that allows us to infer the response format by sending a sample query to your data warehouse. To enable this feature, you can set the sample property in each configuration file. For example:
813

914
```yaml title="artist.yaml"

packages/doc/docs/develop/cache.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ cache:
1616
type: parquet
1717
folderPath: tmp
1818
loader: duckdb
19+
extensions:
20+
duckdb: @vulcan-sql/extension-driver-duckdb
1921
```
2022
2123
In the configuration, `tmp` means there will be a new folder called `tmp` in the root directory of the project you created.

packages/doc/docs/references/api-schema.mdx

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ Here is the introduction of each field in the API Schema.
2626
### `urlPath` Field
2727

2828
This is the Data API endpoint URL path. You could add the path parameter here using the `:[param-name]` format.
29-
If you forgot to add the `fieldName` and `filedIn` only if it's not `header`, VulcanSQL will auto generate it to make it work.
29+
There are [three types of values in the `fieldIn` field](#request-fields), namely `path`, `query` and `header`.
30+
If the value is `header`, you are required to fill in the request parameters. VulcanSQL will auto generate other two values.
3031

3132
```yaml
3233
urlPath: /users/:id
@@ -118,6 +119,10 @@ For further details of using the `sample` field, please check out the section of
118119

119120
:::
120121

122+
:::caution
123+
If [caching is enabled](../develop/cache) in the API endpoint, the sampling funcaionality is disabled.
124+
:::
125+
121126
### `profiles` / `profile` field
122127

123128
The `profiles` / `profile` indicate what data sources the APIs use to query the data.
@@ -139,6 +144,13 @@ Like the above example, if user3 would like to query data from APIs, he doesn't
139144

140145
If you specify the `profiles` field, it could support multiple data sources like the below example:
141146

147+
:::caution
148+
As the moment, in each SQL file, VulcanSQL only supports one data source,
149+
but the data source used for caching is excluded.
150+
So, in any case you can add DuckDB as the caching layer.
151+
152+
:::
153+
142154
```yaml
143155
urlPath: user/:id
144156
request: ...

packages/doc/docs/references/project-configurations.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,4 +215,4 @@ response-format:
215215

216216
Every built-in extension has its configuration, but you don't need to define all of them manually because we have default configurations for most of them.
217217

218-
For the above configuration, if you are interested, you could see [Data Source Profile](./data-source-profile), [Rate Limit](../api-plugin/rate-limit), Enforce HTTPS, [Response Format](../api-plugin/format), [Authentication](../data-privacy/authn) first.
218+
For the above configuration, if you are interested, you could see [Data Source Profile](./data-source-profile), [Rate Limit](../api-plugin/rate-limit), Enforce HTTPs, [Response Format](../api-plugin/format), [Authentication](../data-privacy/authn) first.

0 commit comments

Comments
 (0)