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

Add basic flightSQL connector docs #129

Merged
merged 1 commit into from
Mar 25, 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
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
Loading