Skip to content

Commit

Permalink
add basic flightSQL connector docs (#129)
Browse files Browse the repository at this point in the history
  • Loading branch information
Jeadie authored Mar 25, 2024
1 parent 76214ab commit 0ab3161
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 1 deletion.
1 change: 1 addition & 0 deletions spiceaidocs/content/en/data-connectors/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Currently supported Data Connectors include:
| `spiceai` | Spice.ai | Alpha | Arrow Flight | `append`, `full` ||
| `s3` | S3 | Alpha | Parquet | `full` ||
| `dremio` | Dremio | Alpha | Arrow Flight SQL | `full` ||
| `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` ||
29 changes: 29 additions & 0 deletions spiceaidocs/content/en/data-connectors/flightsql.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
type: docs
title: 'FlightSQL Data Connector'
linkTitle: 'FlightSql Data Connector'
description: 'FlightSQL Data Connector Documentation'
---

Connect to any FlightSQL 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.

## `auth`

Check [Secrets Stores]({{<ref "secret-stores">}}) for details on how to configure.

Attributes:
- `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)).

## Example

```yaml
- from: flightsql:my_catalog.good_schemas.cool_dataset
name: cool_dataset
params:
endpoint: http://127.0.0.1:50051
```
2 changes: 1 addition & 1 deletion spiceaidocs/content/en/data-connectors/s3.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ S3 as a connector for federated SQL query across Parquet files stored in S3, or

Check [Secrets Stores]({{<ref "secret-stores">}}).

Required attribbutes:
Required attributes:

- `key`: The access key authorised to access the S3 data (e.g. `AWS_ACCESS_KEY_ID` for AWS)
- `secret`The secret key authorised to access the S3 data (e.g. `AWS_SECRET_ACCESS_KEY` for AWS)
Expand Down

0 comments on commit 0ab3161

Please sign in to comment.