Skip to content

Commit

Permalink
Make the limitations sections consistent (#245)
Browse files Browse the repository at this point in the history
  • Loading branch information
digadeesh authored May 15, 2024
1 parent 0a7622b commit 07b6d92
Show file tree
Hide file tree
Showing 9 changed files with 21 additions and 16 deletions.
3 changes: 2 additions & 1 deletion spiceaidocs/docs/data-accelerators/duckdb.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ datasets:
duckdb_file: /my/chosen/location/duckdb.db
```

## Limitations
:::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, structs or map fields. For example:
- Supported:
Expand All @@ -45,3 +45,4 @@ datasets:
- `SELECT {'x': 1, 'y': 2, 'z': 3}`
- `SELECT MAP(['key1', 'key2', 'key3'], [10, 20, 30])`
- `SELECT ['duck', 'goose', 'heron'];`
:::
4 changes: 2 additions & 2 deletions spiceaidocs/docs/data-connectors/s3.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,6 @@ Create a dataset named `taxi_trips` from a public S3 folder.
name: taxi_trips
```

## Limitations

:::warning[Limitations]
- Only S3 authentication using `aws_access_key_id` and `aws_secret_access_key` is currently supported. Please [submit an issue](https://github.com/spiceai/spiceai/issues/new?template=feature_request.md) if you would like to see support for other authentication methods.
:::
3 changes: 2 additions & 1 deletion spiceaidocs/docs/data-connectors/snowflake.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,7 @@ datasets:
snowflake_role: accountadmin
```

## Limitations
:::warning[Limitations]
1. Account identifier does not support the [Legacy account locator in a region format](https://docs.snowflake.com/en/user-guide/admin-account-identifier#format-2-legacy-account-locator-in-a-region). Use [Snowflake preferred name in organization format](https://docs.snowflake.com/en/user-guide/admin-account-identifier#format-1-preferred-account-name-in-your-organization).
1. The connector supports password-based and [key-pair](https://docs.snowflake.com/en/user-guide/key-pair-auth) authentication.
:::
5 changes: 3 additions & 2 deletions spiceaidocs/docs/data-connectors/spiceai.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,11 @@ Secrets will be automatically conifgured by using the `spice login` command and
refresh_mode: append
```
## Limitations
:::warning[Limitations]
`refresh_mode: append` is supported for the following datasets:
* eth.recent_blocks
* eth.recent_transactions
* eth.recent_traces

All other datasets need to be configured with `refresh_mode: full`.
All other datasets need to be configured with `refresh_mode: full`.
:::
4 changes: 2 additions & 2 deletions spiceaidocs/docs/features/data-ingestion/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,6 @@ datasets:

SMART data will be available in the `smart_attribute_raw_value` dataset in Spice.ai OSS and replicated to the `coolorg.smart.drive_stats` dataset in Spice.ai Cloud.

## Limitations

:::warning[Limitations]
- Only Spice.ai replication is supported for now.
:::
4 changes: 2 additions & 2 deletions spiceaidocs/docs/features/federated-queries/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,8 +180,8 @@ While the query in step 8 successfully returned results from federated remote da

To improve query performance, step 9 demonstrates the same query executed against locally materialized and accelerated datasets using [Data Accelerators](/data-accelerators/index.md), resulting in significant performance gains.

### Limitations

:::warning[Limitations]
- **Query Optimization:** Filter/Join/Aggregation pushdown is not supported, potentially leading to suboptimal query plan.
- **Query Performance:** Without acceleration, federated queries will be slower than local queries due to network latency and data transfer.
- **Query Capabilities:** Not all SQL features and data types are supported across all data sources. More complex data type queries may not work as expected.
:::
5 changes: 3 additions & 2 deletions spiceaidocs/docs/machine-learning/inference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,9 @@ Where:
}
```

## Limitations
:::warning[Limitations]
- Univariate predictions only
- Multiple covariates
- Covariate and output variate must have a fixed time frequency.
- No support for discrete or exogenous variables.
- No support for discrete or exogenous variables.
:::
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,6 @@ The `from` key follows the following regex format:
5. **Revision (Optional):** A colon (`:`) followed by the git-like revision identifier (`revision`).


### Limitations
- ONNX format support only
:::warning[Limitations]
- ONNX format support only
:::
4 changes: 2 additions & 2 deletions spiceaidocs/docs/reference/spicepod/datasets.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ Optional. The format of the `time_column`. The following values are supported:
- `unix_millis` - Unix timestamp in milliseconds.
- `ISO8601` - [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.

:::warning[Current Limitations]
:::warning[Limitations]
- String-based columns are assumed to be ISO8601 format.
:::

Expand Down Expand Up @@ -155,7 +155,7 @@ Optional. Filters the data fetched from the source to be stored in the accelerat

Must be of the form `SELECT * FROM {name} WHERE {refresh_filter}`. `{name}` is the dataset name declared above, `{refresh_filter}` is any SQL expression that can be used to filter the data, i.e. `WHERE city = 'Seattle'` to reduce the working set of data that is accelerated within Spice from the data source.

:::warning[Current Limitations]
:::warning[Limitations]
- The refresh SQL only supports filtering data from the current dataset - joining across other datasets is not supported.
- Selecting a subset of columns isn't supported - the refresh SQL needs to start with `SELECT * FROM {name}`.
- Queries for data that have been filtered out will not fall back to querying against the federated table.
Expand Down

0 comments on commit 07b6d92

Please sign in to comment.