Skip to content

Commit 72914d9

Browse files
authored
Merge pull request #251 from cyyeh/feature/update-doc
[WIP]Feature: update doc
2 parents 7c0158b + 1be304b commit 72914d9

39 files changed

Lines changed: 788 additions & 1139 deletions

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Below are some common scenarios that you may be interested:
6363
- [Getting Started](https://vulcansql.com/docs/get-started/first-api)
6464
- [Introduction](https://vulcansql.com/docs/intro)
6565
- [Guides to Build Data APIs](https://vulcansql.com/docs/develop/init)
66-
- [Connecting to Data Sources](https://vulcansql.com/docs/connect/overview)
66+
- [Connecting to Data Sources](https://vulcansql.com/docs/connectors/overview)
6767
- [Writing SQL Templates](https://vulcansql.com/docs/develop/overview)
6868
- [Caching Datasets](https://vulcansql.com/docs/develop/cache)
6969
- [Error Handling](https://vulcansql.com/docs/develop/error)

packages/doc/blog/powering-rapid-data-apps-with-vulcansql.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Let's assume we are creating an API that will provide the daily revenue for the
4545

4646
For instance, I will set up a VulcanSQL server and use BigQuery as the data warehouse with **[TPC-H](http://www.tpc.org/tpch/)** SF1 data within. We need to handle two things first, but I won't delve into the specifics here.
4747
- **Project configuration**: Establish project-related configurations. For more information, visit: **https://vulcansql.com/docs/api-plugin/overview**
48-
- **Connecting to a data source**: For more details, visit **https://vulcansql.com/docs/connect/overview**. We support BigQuery, Snowflake, PostgreSQL, and Clickhouse.
48+
- **Connecting to a data source**: For more details, visit **https://vulcansql.com/docs/connectors/overview**. We support BigQuery, Snowflake, PostgreSQL, and Clickhouse.
4949

5050
**Now let's dive into the most critical aspect - writing our APIs.**
5151

@@ -87,7 +87,7 @@ Here we've defined an API with the path **`/daily_revenue`**. In the **`cache`**
8787
* **`cacheTableName`**: The name of the table in DuckDB that will store the cached data.
8888
* **`sql`**: The SQL query that will be executed to extract data from BigQuery.
8989
* **`refreshTime`**: The frequency at which the cache will be refreshed. In this case, it's daily.
90-
* **`profile`**: We created a BigQuery profile in the project configuration step. Here, we specify the profile to use. Check out the **[Connecting to Data Sources](https://vulcansql.com/docs/connect/overview)** for more information.
90+
* **`profile`**: We created a BigQuery profile in the project configuration step. Here, we specify the profile to use. Check out the **[Connecting to Data Sources](https://vulcansql.com/docs/connectors/overview)** for more information.
9191

9292
Once you start the VulcanSQL server, it syncs data from BigQuery to DuckDB for caching and then serves it at the **`/daily_revenue`** endpoint.
9393

packages/doc/docs/catalog/installation.mdx

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,14 @@ Before installing the VulcanSQL catalog-server from NPM, make sure the following
1919

2020
### NPM Install
2121
```bash
22-
npm i -g @vulcan-sql/catalog-server
22+
npm i @vulcan-sql/catalog-server
2323
```
2424

25+
:::info
26+
27+
At the moment, `@vulcan-sql/catalog-server` should be installed per project
28+
:::
29+
2530
After installing `@vulcan-sql/catalog-server`, you can run:
2631
```bash
2732
vulcan catalog
File renamed without changes.

packages/doc/docs/connect/clickhouse.mdx renamed to packages/doc/docs/connectors/clickhouse.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ For more information, please refer to the [ClickHouse Client documentation](http
5050
| password | N | | The user's password. |
5151
| application | N | VulcanSQL | The name of the application using the Node.js client. |
5252
| database | N | default | Database name to use. |
53-
| clickhouse_settings | N | | ClickHouse settings to apply to all requests. For all available settings, see [Advance Settings](https://clickhouse.com/docs/en/operations/settings), and For the definition, see [Definition](https://github.com/ClickHouse/clickhouse-js/blob/0.1.1/src/settings.ts) |
53+
| clickhouse_settings | N | | ClickHouse settings to apply to all requests. For all available settings, see [Advanced Settings](https://clickhouse.com/docs/en/operations/settings), and For the definition, see [Definition](https://github.com/ClickHouse/clickhouse-js/blob/0.1.1/src/settings.ts) |
5454
| tls | N | | Configure TLS certificates. See [TLS docs](https://clickhouse.com/docs/en/integrations/language-clients/nodejs#tls-certificates). |
5555
| session_id | N | | ClickHouse Session ID to send with every request. |
5656
| keep_alive | N | | HTTP Keep-Alive related settings. See [Keep Alive docs](https://clickhouse.com/docs/en/integrations/language-clients/nodejs#keep-alive) |
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
pagination_next: connect/bigquery
2+
pagination_next: connectors/bigquery
33
---
44

55
# Overview
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)