-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add basic flightSQL connector docs (#129)
- Loading branch information
Showing
3 changed files
with
31 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters