Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 7 additions & 7 deletions website/docs/components/catalogs/ducklake.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Supported connection string formats:
| AWS S3 | `ducklake:s3://bucket/path/metadata.ducklake` |
| PostgreSQL | `ducklake:postgres:dbname=mydb host=localhost user=postgres password=secret` |

The connection string can also be provided via the `connection_string` parameter.
The connection string can also be provided via the `ducklake_connection_string` parameter.

## `name`

Expand Down Expand Up @@ -70,11 +70,11 @@ The `access` field controls what operations are allowed on the catalog:

## `params`

| Parameter Name | Description |
| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `connection_string` | The DuckLake metadata location (e.g., `s3://bucket/path/metadata.ducklake`). If omitted, the value from `from: ducklake:<connection_string>` is used. |
| `name` | The name to attach the DuckLake catalog as in DuckDB. Default: `ducklake`. |
| `open` | Path to an existing DuckDB file for persistent storage. If not provided, an in-memory DuckDB instance is used. |
| Parameter Name | Description |
| ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ducklake_connection_string` | The DuckLake metadata location (e.g., `s3://bucket/path/metadata.ducklake`). If omitted, the value from `from: ducklake:<connection_string>` is used. |
| `ducklake_name` | The name to attach the DuckLake catalog as in DuckDB. Default: `ducklake`. |
| `ducklake_open` | Path to an existing DuckDB file for persistent storage. If not provided, an in-memory DuckDB instance is used. |

## Authentication

Expand Down Expand Up @@ -115,7 +115,7 @@ catalogs:
- from: ducklake
name: my_lakehouse
params:
connection_string: "postgres:dbname=ducklake_catalog host=localhost user=postgres password=${secrets:PASSWORD}"
ducklake_connection_string: "postgres:dbname=ducklake_catalog host=localhost user=postgres password=${secrets:PASSWORD}"
```

### Read-write with DDL support
Expand Down
22 changes: 11 additions & 11 deletions website/docs/components/data-connectors/ducklake.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ datasets:
- from: ducklake:my_table
name: my_table
params:
connection_string: s3://my-bucket/path/metadata.ducklake
ducklake_connection_string: s3://my-bucket/path/metadata.ducklake
```

## Configuration
Expand All @@ -39,7 +39,7 @@ datasets:
- from: ducklake:customer
name: tpch_customer
params:
connection_string: s3://my-bucket/metadata.ducklake
ducklake_connection_string: s3://my-bucket/metadata.ducklake
```

```sql
Expand All @@ -50,11 +50,11 @@ The dataset name cannot be a [reserved keyword](../../reference/spicepod/keyword

### `params`

| Parameter Name | Description |
| ------------------- | -------------------------------------------------------------------------------------------------------------- |
| `connection_string` | **Required**. The DuckLake metadata location (e.g., `s3://bucket/path/metadata.ducklake`). |
| `name` | The name to attach the DuckLake catalog as in DuckDB. Default: `ducklake`. |
| `open` | Path to an existing DuckDB file for persistent storage. If not provided, an in-memory DuckDB instance is used. |
| Parameter Name | Description |
| ----------------------------- | -------------------------------------------------------------------------------------------------------------- |
| `ducklake_connection_string` | **Required**. The DuckLake metadata location (e.g., `s3://bucket/path/metadata.ducklake`). |
| `ducklake_name` | The name to attach the DuckLake catalog as in DuckDB. Default: `ducklake`. |
| `ducklake_open` | Path to an existing DuckDB file for persistent storage. If not provided, an in-memory DuckDB instance is used. |

### Connection string formats

Expand Down Expand Up @@ -95,7 +95,7 @@ datasets:
- from: ducklake:customer
name: customer
params:
connection_string: s3://my-bucket/lakehouse/metadata.ducklake
ducklake_connection_string: s3://my-bucket/lakehouse/metadata.ducklake
```

### Reading from a specific schema
Expand All @@ -105,7 +105,7 @@ datasets:
- from: ducklake:analytics.events
name: events
params:
connection_string: s3://my-bucket/metadata.ducklake
ducklake_connection_string: s3://my-bucket/metadata.ducklake
```

### PostgreSQL metadata backend
Expand All @@ -125,7 +125,7 @@ datasets:
- from: ducklake:customer
name: customer
params: &ducklake_params
connection_string: s3://my-bucket/metadata.ducklake
ducklake_connection_string: s3://my-bucket/metadata.ducklake
- from: ducklake:orders
name: orders
params: *ducklake_params
Expand All @@ -141,7 +141,7 @@ datasets:
- from: ducklake:customer
name: customer
params:
connection_string: s3://my-bucket/metadata.ducklake
ducklake_connection_string: s3://my-bucket/metadata.ducklake
acceleration:
enabled: true
engine: duckdb
Expand Down
2 changes: 1 addition & 1 deletion website/docs/components/data-connectors/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ Schema inference happens once, when the dataset is first registered. Some connec

| Connector | Parameter | Default | Description |
| ------------------------------------- | ---------------------------------- | ------- | --------------------------------------------------- |
| [Kafka](data-connectors/kafka) | `schema_infer_max_records` | 10 | Number of messages sampled to infer the JSON schema |
| [Kafka](data-connectors/kafka) | `schema_infer_max_records` | 1 | Number of messages sampled to infer the JSON schema |
| [DynamoDB](data-connectors/dynamodb) | `schema_infer_max_records` | 10 | Number of items sampled to infer the schema |
| [MongoDB](data-connectors/mongodb) | `mongodb_num_docs_to_infer_schema` | 400 | Number of documents sampled to infer the schema |
| [CSV files](../reference/file_format) | `csv_schema_infer_max_records` | 1000 | Number of rows sampled to infer the CSV schema |
Expand Down
1 change: 1 addition & 0 deletions website/docs/reference/spicepod/keywords.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ These keywords apply to all data connectors:
- `COUNT`
- `FALSE`
- `NULL`
- `TRUE`
- `END-EXEC`
- `LATERAL`
- `TABLE`
Expand Down
Loading