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.

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

Update docs v011.1 fit and finish #207

Merged
merged 3 commits into from
Apr 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion spiceaidocs/docs/cli/reference/add.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Add"
title: "add"
sidebar_label: "add"
pagination_prev: null
pagination_next: null
Expand Down
2 changes: 1 addition & 1 deletion spiceaidocs/docs/cli/reference/refresh.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Refresh"
title: "refresh"
sidebar_label: "refresh"
pagination_prev: null
pagination_next: null
Expand Down
4 changes: 2 additions & 2 deletions spiceaidocs/docs/data-accelerators/duckdb.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
- 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]
- `SELECT ['1992-09-20 11:30:00.123456789', 'epoch'::TIMESTAMP]`
- Unsupported:
- `SELECT [['duck', 'goose', 'heron'], ['frog', 'toad']]`
- `SELECT {'x': 1, 'y': 2, 'z': 3}`
Expand Down
16 changes: 8 additions & 8 deletions spiceaidocs/docs/data-connectors/flightsql.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -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": "<flight_username>", "password": "<flight_password>"}')
```
Expand Down
2 changes: 1 addition & 1 deletion spiceaidocs/docs/data-connectors/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down