Skip to content

Commit 8ed9578

Browse files
authored
docs: Fix DuckLake param prefixes, Kafka default, and missing keyword (#1442)
1 parent 26f42e4 commit 8ed9578

4 files changed

Lines changed: 20 additions & 19 deletions

File tree

website/docs/components/catalogs/ducklake.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Supported connection string formats:
4040
| AWS S3 | `ducklake:s3://bucket/path/metadata.ducklake` |
4141
| PostgreSQL | `ducklake:postgres:dbname=mydb host=localhost user=postgres password=secret` |
4242

43-
The connection string can also be provided via the `connection_string` parameter.
43+
The connection string can also be provided via the `ducklake_connection_string` parameter.
4444

4545
## `name`
4646

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

7171
## `params`
7272

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

7979
## Authentication
8080

@@ -115,7 +115,7 @@ catalogs:
115115
- from: ducklake
116116
name: my_lakehouse
117117
params:
118-
connection_string: "postgres:dbname=ducklake_catalog host=localhost user=postgres password=${secrets:PASSWORD}"
118+
ducklake_connection_string: "postgres:dbname=ducklake_catalog host=localhost user=postgres password=${secrets:PASSWORD}"
119119
```
120120

121121
### Read-write with DDL support

website/docs/components/data-connectors/ducklake.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ datasets:
1616
- from: ducklake:my_table
1717
name: my_table
1818
params:
19-
connection_string: s3://my-bucket/path/metadata.ducklake
19+
ducklake_connection_string: s3://my-bucket/path/metadata.ducklake
2020
```
2121
2222
## Configuration
@@ -39,7 +39,7 @@ datasets:
3939
- from: ducklake:customer
4040
name: tpch_customer
4141
params:
42-
connection_string: s3://my-bucket/metadata.ducklake
42+
ducklake_connection_string: s3://my-bucket/metadata.ducklake
4343
```
4444

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

5151
### `params`
5252

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

5959
### Connection string formats
6060

@@ -95,7 +95,7 @@ datasets:
9595
- from: ducklake:customer
9696
name: customer
9797
params:
98-
connection_string: s3://my-bucket/lakehouse/metadata.ducklake
98+
ducklake_connection_string: s3://my-bucket/lakehouse/metadata.ducklake
9999
```
100100

101101
### Reading from a specific schema
@@ -105,7 +105,7 @@ datasets:
105105
- from: ducklake:analytics.events
106106
name: events
107107
params:
108-
connection_string: s3://my-bucket/metadata.ducklake
108+
ducklake_connection_string: s3://my-bucket/metadata.ducklake
109109
```
110110

111111
### PostgreSQL metadata backend
@@ -125,7 +125,7 @@ datasets:
125125
- from: ducklake:customer
126126
name: customer
127127
params: &ducklake_params
128-
connection_string: s3://my-bucket/metadata.ducklake
128+
ducklake_connection_string: s3://my-bucket/metadata.ducklake
129129
- from: ducklake:orders
130130
name: orders
131131
params: *ducklake_params
@@ -141,7 +141,7 @@ datasets:
141141
- from: ducklake:customer
142142
name: customer
143143
params:
144-
connection_string: s3://my-bucket/metadata.ducklake
144+
ducklake_connection_string: s3://my-bucket/metadata.ducklake
145145
acceleration:
146146
enabled: true
147147
engine: duckdb

website/docs/components/data-connectors/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ Schema inference happens once, when the dataset is first registered. Some connec
274274

275275
| Connector | Parameter | Default | Description |
276276
| ------------------------------------- | ---------------------------------- | ------- | --------------------------------------------------- |
277-
| [Kafka](data-connectors/kafka) | `schema_infer_max_records` | 10 | Number of messages sampled to infer the JSON schema |
277+
| [Kafka](data-connectors/kafka) | `schema_infer_max_records` | 1 | Number of messages sampled to infer the JSON schema |
278278
| [DynamoDB](data-connectors/dynamodb) | `schema_infer_max_records` | 10 | Number of items sampled to infer the schema |
279279
| [MongoDB](data-connectors/mongodb) | `mongodb_num_docs_to_infer_schema` | 400 | Number of documents sampled to infer the schema |
280280
| [CSV files](../reference/file_format) | `csv_schema_infer_max_records` | 1000 | Number of rows sampled to infer the CSV schema |

website/docs/reference/spicepod/keywords.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ These keywords apply to all data connectors:
1717
- `COUNT`
1818
- `FALSE`
1919
- `NULL`
20+
- `TRUE`
2021
- `END-EXEC`
2122
- `LATERAL`
2223
- `TABLE`

0 commit comments

Comments
 (0)