Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Clarify DuckDB type limitations #633

Merged
merged 3 commits into from
Nov 13, 2024
+21 −7
Merged

docs: Clarify DuckDB type limitations #633

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0b24fd7
docs: Clarify DuckDB type limitations
peasee Nov 13, 2024
fddc787
docs: Clarify supported structs format
peasee Nov 13, 2024
9d5c31a
docs: Remove federation limitation that does not apply to DuckDB conn…
peasee Nov 13, 2024
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
13 changes: 6 additions & 7 deletions spiceaidocs/docs/components/data-accelerators/duckdb.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,18 +36,17 @@ datasets:

:::warning[Limitations]

- The DuckDB accelerator does not support schemas with [field types](https://duckdb.org/docs/sql/data_types/overview): nested arrays/lists, UTF8/string arrays/lists, boolean arrays/lists, structs, nested structs or map fields. For example:
- The DuckDB accelerator does not support nested lists, or structs with nested structs/lists [field types](https://duckdb.org/docs/sql/data_types/overview). For example:
- Supported:
- `SELECT [1, 2, 3];`
- `SELECT ['1992-09-20 11:30:00.123456789', 'epoch'::TIMESTAMP]`
- `SELECT {'x': 1, 'y': 2, 'z': 3}`
- Unsupported:
- `SELECT [['duck', 'goose', 'heron'], ['frog', 'toad']]`
- `SELECT {'x': 1, 'y': 2, 'z': 3}`
- `SELECT {'x': [1, 2, 3]}`
- The DuckDB accelerator does not support enum, dictionary, or map [field types](https://duckdb.org/docs/sql/data_types/overview). For example:
- Unsupported:
- `SELECT MAP(['key1', 'key2', 'key3'], [10, 20, 30])`
- `SELECT ['duck', 'goose', 'heron'];`
- `SELECT [true, false];`
- The DuckDB accelerator does not support `Decimal256` (76 digits), as it exceeds DuckDB's maximum Decimal width of 38 digits.
- Updating a dataset with DuckDB acceleration while the Spice Runtime is running (hot-reload) will cause DuckDB accelerator query federation to disable until the Runtime is restarted.
- Updating a dataset with DuckDB acceleration while the Spice Runtime is running (hot-reload) will cause the DuckDB accelerator query federation to disable until the Runtime is restarted.

:::

Expand Down
15 changes: 15 additions & 0 deletions spiceaidocs/docs/components/data-connectors/duckdb.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,3 +83,18 @@ SELECT * FROM 'todos.json';
-- As a DuckDB function
SELECT * FROM read_json('todos.json');
```

:::warning[Limitations]

- The DuckDB connector does not support nested lists, or structs with nested structs/lists [field types](https://duckdb.org/docs/sql/data_types/overview). For example:
- Supported:
- `SELECT {'x': 1, 'y': 2, 'z': 3}`
- Unsupported:
- `SELECT [['duck', 'goose', 'heron'], ['frog', 'toad']]`
- `SELECT {'x': [1, 2, 3]}`
- The DuckDB connector does not support enum, dictionary, or map [field types](https://duckdb.org/docs/sql/data_types/overview). For example:
- Unsupported:
- `SELECT MAP(['key1', 'key2', 'key3'], [10, 20, 30])`
- The DuckDB connector does not support `Decimal256` (76 digits), as it exceeds DuckDB's maximum Decimal width of 38 digits.

:::