From 6a835b415612f0f87089db5b93fe738eeb7d6bc7 Mon Sep 17 00:00:00 2001 From: Aurash Behbahani Date: Mon, 22 Apr 2024 14:40:56 -0700 Subject: [PATCH 1/3] updating links and formatting --- spiceaidocs/docs/data-accelerators/duckdb.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/spiceaidocs/docs/data-accelerators/duckdb.md b/spiceaidocs/docs/data-accelerators/duckdb.md index bb90e0f4..145596ac 100644 --- a/spiceaidocs/docs/data-accelerators/duckdb.md +++ b/spiceaidocs/docs/data-accelerators/duckdb.md @@ -31,10 +31,10 @@ datasets: ``` ## Limitations -- Does not support schemas with [field types](https://duckdb.org/docs/sql/data_types): nested arrays/lists, UTF8/string arrays/lists, structs or map fields. For example: +- 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: - `SELECT [1, 2, 3];` - - `SELECT ['1992-09-20 11:30:00.123456789', 'epoch'::TIMESTAMP] + - `SELECT ['1992-09-20 11:30:00.123456789', 'epoch'::TIMESTAMP]` - Unsupported: - `SELECT [['duck', 'goose', 'heron'], ['frog', 'toad']]` - `SELECT {'x': 1, 'y': 2, 'z': 3}` From b9975e22efc35931ba4385a01f180393ac4f56aa Mon Sep 17 00:00:00 2001 From: Aurash Behbahani Date: Mon, 22 Apr 2024 14:45:56 -0700 Subject: [PATCH 2/3] formatting --- spiceaidocs/docs/data-accelerators/duckdb.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/spiceaidocs/docs/data-accelerators/duckdb.md b/spiceaidocs/docs/data-accelerators/duckdb.md index 145596ac..a37ab606 100644 --- a/spiceaidocs/docs/data-accelerators/duckdb.md +++ b/spiceaidocs/docs/data-accelerators/duckdb.md @@ -30,8 +30,8 @@ datasets: duckdb_file: /my/chosen/location/duckdb.db ``` -## Limitations -- 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: +:::warning[Current 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: - `SELECT [1, 2, 3];` - `SELECT ['1992-09-20 11:30:00.123456789', 'epoch'::TIMESTAMP]` @@ -40,3 +40,4 @@ datasets: - `SELECT {'x': 1, 'y': 2, 'z': 3}` - `SELECT MAP(['key1', 'key2', 'key3'], [10, 20, 30])` - `SELECT ['duck', 'goose', 'heron'];` +::: \ No newline at end of file From 889fc1c311d616a18927937e5357f97c716711f0 Mon Sep 17 00:00:00 2001 From: Aurash Behbahani Date: Mon, 22 Apr 2024 15:01:49 -0700 Subject: [PATCH 3/3] format. Fit and Finish --- spiceaidocs/docs/cli/reference/add.md | 2 +- spiceaidocs/docs/cli/reference/refresh.md | 2 +- spiceaidocs/docs/data-accelerators/duckdb.md | 3 +-- spiceaidocs/docs/data-connectors/flightsql.md | 16 ++++++++-------- spiceaidocs/docs/data-connectors/index.md | 2 +- 5 files changed, 12 insertions(+), 13 deletions(-) diff --git a/spiceaidocs/docs/cli/reference/add.md b/spiceaidocs/docs/cli/reference/add.md index 29a766e7..30a35a4c 100644 --- a/spiceaidocs/docs/cli/reference/add.md +++ b/spiceaidocs/docs/cli/reference/add.md @@ -1,5 +1,5 @@ --- -title: "Add" +title: "add" sidebar_label: "add" pagination_prev: null pagination_next: null diff --git a/spiceaidocs/docs/cli/reference/refresh.md b/spiceaidocs/docs/cli/reference/refresh.md index b70621ba..d48b9931 100644 --- a/spiceaidocs/docs/cli/reference/refresh.md +++ b/spiceaidocs/docs/cli/reference/refresh.md @@ -1,5 +1,5 @@ --- -title: "Refresh" +title: "refresh" sidebar_label: "refresh" pagination_prev: null pagination_next: null diff --git a/spiceaidocs/docs/data-accelerators/duckdb.md b/spiceaidocs/docs/data-accelerators/duckdb.md index a37ab606..4061e755 100644 --- a/spiceaidocs/docs/data-accelerators/duckdb.md +++ b/spiceaidocs/docs/data-accelerators/duckdb.md @@ -30,7 +30,7 @@ datasets: duckdb_file: /my/chosen/location/duckdb.db ``` -:::warning[Current Limitations] +## 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: - `SELECT [1, 2, 3];` @@ -40,4 +40,3 @@ datasets: - `SELECT {'x': 1, 'y': 2, 'z': 3}` - `SELECT MAP(['key1', 'key2', 'key3'], [10, 20, 30])` - `SELECT ['duck', 'goose', 'heron'];` -::: \ No newline at end of file diff --git a/spiceaidocs/docs/data-connectors/flightsql.md b/spiceaidocs/docs/data-connectors/flightsql.md index 40b01799..789606c2 100644 --- a/spiceaidocs/docs/data-connectors/flightsql.md +++ b/spiceaidocs/docs/data-connectors/flightsql.md @@ -1,26 +1,26 @@ --- -title: 'FlightSQL Data Connector' -sidebar_label: 'FlightSql Data Connector' -description: 'FlightSQL Data Connector Documentation' +title: 'Flight SQL Data Connector' +sidebar_label: 'Flight SQL Data Connector' +description: 'Flight SQL Data Connector Documentation' --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Connect to any FlightSQL compatible server (e.g. Influx 3.0, CnosDB, other Spice runtimes!) as a connector for federated SQL queries. +Connect to any Flight SQL compatible server (e.g. Influx 3.0, CnosDB, other Spice runtimes!) as a connector for federated SQL queries. ## `params` -- `endpoint`: The Apache Flight endpoint used to connect to the FlightSQL server. +- `endpoint`: The Apache Flight endpoint used to connect to the Flight SQL server. ## Auth -Username and password credentials can be specified to connect to the FlightSQL server: +Username and password credentials can be specified to connect to the Flight SQL server: - `username` (optional): The username to use in the underlying Apache flight Handshake Request to authenticate to the server (see [reference](https://arrow.apache.org/docs/format/Flight.html#authentication)). - `password` (optional): The password to use in the underlying Apache flight Handshake Request to authenticate to the server (see [reference](https://arrow.apache.org/docs/format/Flight.html#authentication)). -By default FlightSQL connector will look for a secret named `flightsql` with keys `username` and `password`. +By default Flight SQL connector will look for a secret named `flightsql` with keys `username` and `password`. Check [Secrets Stores](/secret-stores) for more details. @@ -71,7 +71,7 @@ Check [Secrets Stores](/secret-stores) for more details. Add new keychain entry (macOS), with user and password in JSON string ```bash - security add-generic-password -l "FlightSQL Secret" \ + security add-generic-password -l "Flight SQL Secret" \ -a spiced -s spice_secret_flightsql \ -w $(echo -n '{"username": "", "password": ""}') ``` diff --git a/spiceaidocs/docs/data-connectors/index.md b/spiceaidocs/docs/data-connectors/index.md index aef19a05..d194b1f1 100644 --- a/spiceaidocs/docs/data-connectors/index.md +++ b/spiceaidocs/docs/data-connectors/index.md @@ -21,7 +21,7 @@ Currently supported Data Connectors include: | `flightsql` | FlightSQL | Alpha | Arrow Flight SQL | `full` | ❌ | | `snowflake` | Snowflake | Coming soon! | Arrow Flight SQL | `full` | ❌ | | `bigquery` | BigQuery | Coming soon! | Arrow Flight SQL | `full` | ❌ | -| `mysql` | MySQL | Coming soon! | | `full` | ❌ | +| `mysql` | MySQL | Alpha | | `full` | ❌ | ## Data Connector Docs