From 586d5500598265bd7425dd32b9719c80b2e7dab9 Mon Sep 17 00:00:00 2001 From: jeadie Date: Tue, 26 Mar 2024 08:39:06 +1100 Subject: [PATCH] add basic flightSQL connector docs --- .../content/en/data-connectors/_index.md | 1 + .../content/en/data-connectors/flightsql.md | 29 +++++++++++++++++++ spiceaidocs/content/en/data-connectors/s3.md | 2 +- 3 files changed, 31 insertions(+), 1 deletion(-) create mode 100644 spiceaidocs/content/en/data-connectors/flightsql.md diff --git a/spiceaidocs/content/en/data-connectors/_index.md b/spiceaidocs/content/en/data-connectors/_index.md index 6784823d..c88f3534 100644 --- a/spiceaidocs/content/en/data-connectors/_index.md +++ b/spiceaidocs/content/en/data-connectors/_index.md @@ -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` | ❌ | diff --git a/spiceaidocs/content/en/data-connectors/flightsql.md b/spiceaidocs/content/en/data-connectors/flightsql.md new file mode 100644 index 00000000..dc9cf0e8 --- /dev/null +++ b/spiceaidocs/content/en/data-connectors/flightsql.md @@ -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]({{}}) 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 +``` \ No newline at end of file diff --git a/spiceaidocs/content/en/data-connectors/s3.md b/spiceaidocs/content/en/data-connectors/s3.md index 2dd4e298..eeeeb6ae 100644 --- a/spiceaidocs/content/en/data-connectors/s3.md +++ b/spiceaidocs/content/en/data-connectors/s3.md @@ -16,7 +16,7 @@ S3 as a connector for federated SQL query across Parquet files stored in S3, or Check [Secrets 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)