Skip to content

Commit 2f2b68f

Browse files
claudespicelukekim
authored andcommitted
docs(datasets): document schema_inference depth field
1 parent aaac752 commit 2f2b68f

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

website/docs/reference/spicepod/datasets.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -251,6 +251,23 @@ Not all connectors support specifying an `unsupported_type_action`. When specifi
251251

252252
:::
253253

254+
## `schema_inference`
255+
256+
Optional. Controls the depth of source-schema inference. Applies to all refresh modes. Supported values:
257+
258+
- `standard` - Default. Infer the base column schema (names, types, nullability) from the source, exactly as before. No primary-key, secondary-index, or sort/clustering-column detection is performed.
259+
- `extended` - In addition to the base column schema, auto-detect the source's primary key, secondary indexes, and sort/clustering columns and apply them to any acceleration settings left unset. Only connectors that emit inferred-schema metadata are affected — currently the [PostgreSQL](../../components/data-connectors/postgres) and [MongoDB](../../components/data-connectors/mongodb) connectors; other connectors treat `extended` as a no-op.
260+
261+
```yaml
262+
datasets:
263+
- from: postgres:public.events
264+
name: events
265+
schema_inference: extended
266+
acceleration:
267+
engine: cayenne
268+
mode: file
269+
```
270+
254271
## `ready_state`
255272

256273
Supports one of three values (defaults to `on_load`):

0 commit comments

Comments
 (0)