docs(skills): add file-based connector docs, venv setup, and fix path/typo issues (#1438)

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Jax Liu
2026-03-10 17:44:40 +08:00
committed by GitHub
parent 154d96afec
commit a6cdfff49e
6 changed files with 45 additions and 16 deletions
@@ -65,13 +65,13 @@ If you prefer to run each step yourself, follow these phases in order.
Create a directory on your host machine. This directory will be mounted into the Docker container so it can read and write MDL files.
```bash
mkdir -p /${PWD}/wren-workspace
mkdir -p ${PWD}/wren-workspace
```
The completed workspace will look like:
```
/${PWD}/wren-workspace/
${PWD}/wren-workspace/
├── wren_project.yml
├── connection.yml
├── models/
+2 -2
View File
@@ -94,7 +94,7 @@ When prompted for connection details, provide:
| Field | Value |
|-------|-------|
| Data source type | `duckdb` |
| Database file path | `/data/jaffle_shop.duckdb` |
| Database folder path | `/data` (the folder containing `jaffle_shop.duckdb`) |
| Workspace path | `~/wren-workspace` |
| jaffle_shop directory | your absolute path to `jaffle_shop_duckdb/` |
@@ -153,7 +153,7 @@ In Claude Code, run each skill in sequence:
When prompted, enter:
- Data source type: `duckdb`
- Database file path: `/data/jaffle_shop.duckdb`
- Database folder path: `/data` (the folder containing `jaffle_shop.duckdb`)
Then save the MDL as a versioned YAML project:
+2 -2
View File
@@ -7,7 +7,7 @@
"skills": [
{
"name": "wren-connection-info",
"version": "1.1",
"version": "1.2",
"description": "Set up data source type and connection credentials for Wren Engine.",
"tags": [
"wren",
@@ -88,7 +88,7 @@
},
{
"name": "wren-quickstart",
"version": "1.0",
"version": "1.1",
"description": "End-to-end quickstart for Wren Engine — from zero to querying.",
"tags": [
"wren",
+2 -2
View File
@@ -1,9 +1,9 @@
{
"generate-mdl": "1.2",
"wren-connection-info": "1.1",
"wren-connection-info": "1.2",
"wren-project": "1.4",
"wren-sql": "1.0",
"wren-mcp-setup": "1.2",
"wren-quickstart": "1.0",
"wren-quickstart": "1.1",
"wren-usage": "1.0"
}
+18 -4
View File
@@ -4,12 +4,13 @@ description: Set up data source type and connection credentials for Wren Engine.
license: Apache-2.0
metadata:
author: wren-engine
version: "1.1"
version: "1.2"
---
# Wren Connection Info
Sets up the data source type and credentials before any workflow that queries a database.
Find the specification of the connection info format in the `model` section of [API reference](https://docs.getwren.ai/oss/wren_engine_api).
---
@@ -116,10 +117,23 @@ database: <database name>
sf_schema: <schema name>
```
### DuckDB
### File based (S3, Minio, GCS, local file)
For the object storage connectors (S3, Minio, GCS) and local file sources, use this format:
```
url: <path to .duckdb file>
format: <FILE_FORMAT> # e.g. "csv", "parquet"
url: <file path or bucket URL>
```
If credentials are needed (e.g. S3 access key and secret), include these fields as well:
```
access_key: <SECRET>
secret_key: <SECRET>
```
### DuckDB
It leverages the same connection info format as file-based sources, but with `format: duckdb` to indicate that it's a DuckDB data source rather than a generic file source.
```
format: duckdb
url: <path to folder containing .duckdb file>
```
### Athena
+19 -4
View File
@@ -5,7 +5,7 @@ compatibility: Requires Docker Desktop (or Docker Engine). No local database dri
license: Apache-2.0
metadata:
author: wren-engine
version: "1.0"
version: "1.1"
---
# Wren Quickstart
@@ -13,10 +13,10 @@ metadata:
## Version check
Silently fetch `https://raw.githubusercontent.com/Canner/wren-engine/main/skills/versions.json`.
Compare the `wren-quickstart` key with this skill's version (`1.0`).
Compare the `wren-quickstart` key with this skill's version (`1.1`).
If the remote version is newer, notify the user before proceeding:
> A newer version of the **wren-quickstart** skill is available (remote: X.Y, installed: 1.0).
> A newer version of the **wren-quickstart** skill is available (remote: X.Y, installed: 1.1).
> Update with:
> ```bash
> curl -fsSL https://raw.githubusercontent.com/Canner/wren-engine/main/skills/install.sh | bash -s -- --force wren-quickstart
@@ -34,12 +34,27 @@ This skill walks a user through setting up Wren Engine end-to-end — from creat
## Phase 1 — Create a workspace
### 1a — Set up Python virtual environment
Before creating the workspace, ensure a Python virtual environment is available. This is required if the user will run **ibis-server locally** (instead of relying solely on Docker). Skip this step if the user will use only the Dockerized ibis-server.
```bash
python3 -m venv .venv
source .venv/bin/activate # macOS / Linux
# .venv\Scripts\activate # Windows
pip install --upgrade pip
```
> **Tip:** Place the venv inside or adjacent to the workspace directory so it is easy to find. Avoid committing it to version control — add `.venv/` to `.gitignore`.
### 1b — Create a workspace directory
Create a dedicated workspace directory on the host machine. This directory will be mounted into the Docker container, so the container can read and write MDL files.
Ask the user where they want the workspace, or suggest a default:
```bash
mkdir -p ~/wren-workspace
mkdir -p ${PWD}/wren-workspace
```
Save the chosen path as `<WORKSPACE_PATH>` (absolute path, e.g. `/Users/me/wren-workspace`). All subsequent steps reference this path.