Skip to content

Commit b3eb37a

Browse files
claudespicelukekim
authored andcommitted
fix: Mark flightsql_endpoint parameter as Required in FlightSQL connector docs
The flightsql_endpoint parameter is enforced as required at runtime (returns MissingParameter error if absent), but the docs did not indicate this. Other parameters in the same table explicitly say "Optional." -- this adds "Required." to the endpoint description for consistency, across vNext and all versioned docs (1.5.x-1.11.x).
1 parent b94825d commit b3eb37a

8 files changed

Lines changed: 8 additions & 8 deletions

File tree

website/docs/components/data-connectors/flightsql.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ The dataset name. This will be used as the table name within Spice. The dataset
3636

3737
| Parameter name | Description |
3838
| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
39-
| `flightsql_endpoint` | The Apache Flight endpoint used to connect to the Flight SQL server. |
39+
| `flightsql_endpoint` | Required. The Apache Flight endpoint used to connect to the Flight SQL server. |
4040
| `flightsql_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)). |
4141
| `flightsql_password` | Optional. The password to use in the underlying Apache flight Handshake Request to authenticate to the server. Use the [secret replacement syntax](../secret-stores/) to load the password from a secret store, e.g. `${secrets:my_flightsql_pass}`. |
4242
| `flightsql_tls_ca_certificate_file` | Optional. Path to a CA certificate file (PEM format) to use for TLS verification instead of system certificates. |

website/versioned_docs/version-1.10.x/components/data-connectors/flightsql.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The dataset name. This will be used as the table name within Spice. The dataset
3232

3333
| Parameter name | Description |
3434
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
35-
| `flightsql_endpoint` | The Apache Flight endpoint used to connect to the Flight SQL server. |
35+
| `flightsql_endpoint` | Required. The Apache Flight endpoint used to connect to the Flight SQL server. |
3636
| `flightsql_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)). |
3737
| `flightsql_password` | Optional. The password to use in the underlying Apache flight Handshake Request to authenticate to the server. Use the [secret replacement syntax](../secret-stores) to load the password from a secret store, e.g. `${secrets:my_flightsql_pass}`. |
3838

website/versioned_docs/version-1.11.x/components/data-connectors/flightsql.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The dataset name. This will be used as the table name within Spice. The dataset
3232

3333
| Parameter name | Description |
3434
| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
35-
| `flightsql_endpoint` | The Apache Flight endpoint used to connect to the Flight SQL server. |
35+
| `flightsql_endpoint` | Required. The Apache Flight endpoint used to connect to the Flight SQL server. |
3636
| `flightsql_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)). |
3737
| `flightsql_password` | Optional. The password to use in the underlying Apache flight Handshake Request to authenticate to the server. Use the [secret replacement syntax](../secret-stores/) to load the password from a secret store, e.g. `${secrets:my_flightsql_pass}`. |
3838
| `flightsql_tls_ca_certificate_file` | Optional. Path to a CA certificate file (PEM format) to use for TLS verification instead of system certificates. |

website/versioned_docs/version-1.5.x/components/data-connectors/flightsql.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The dataset name. This will be used as the table name within Spice. The dataset
3232

3333
| Parameter name | Description |
3434
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
35-
| `flightsql_endpoint` | The Apache Flight endpoint used to connect to the Flight SQL server. |
35+
| `flightsql_endpoint` | Required. The Apache Flight endpoint used to connect to the Flight SQL server. |
3636
| `flightsql_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)). |
3737
| `flightsql_password` | Optional. The password to use in the underlying Apache flight Handshake Request to authenticate to the server. Use the [secret replacement syntax](../secret-stores) to load the password from a secret store, e.g. `${secrets:my_flightsql_pass}`. |
3838

website/versioned_docs/version-1.6.x/components/data-connectors/flightsql.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The dataset name. This will be used as the table name within Spice. The dataset
3232

3333
| Parameter name | Description |
3434
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
35-
| `flightsql_endpoint` | The Apache Flight endpoint used to connect to the Flight SQL server. |
35+
| `flightsql_endpoint` | Required. The Apache Flight endpoint used to connect to the Flight SQL server. |
3636
| `flightsql_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)). |
3737
| `flightsql_password` | Optional. The password to use in the underlying Apache flight Handshake Request to authenticate to the server. Use the [secret replacement syntax](../secret-stores) to load the password from a secret store, e.g. `${secrets:my_flightsql_pass}`. |
3838

website/versioned_docs/version-1.7.x/components/data-connectors/flightsql.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The dataset name. This will be used as the table name within Spice. The dataset
3232

3333
| Parameter name | Description |
3434
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
35-
| `flightsql_endpoint` | The Apache Flight endpoint used to connect to the Flight SQL server. |
35+
| `flightsql_endpoint` | Required. The Apache Flight endpoint used to connect to the Flight SQL server. |
3636
| `flightsql_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)). |
3737
| `flightsql_password` | Optional. The password to use in the underlying Apache flight Handshake Request to authenticate to the server. Use the [secret replacement syntax](../secret-stores) to load the password from a secret store, e.g. `${secrets:my_flightsql_pass}`. |
3838

website/versioned_docs/version-1.8.x/components/data-connectors/flightsql.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The dataset name. This will be used as the table name within Spice. The dataset
3232

3333
| Parameter name | Description |
3434
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
35-
| `flightsql_endpoint` | The Apache Flight endpoint used to connect to the Flight SQL server. |
35+
| `flightsql_endpoint` | Required. The Apache Flight endpoint used to connect to the Flight SQL server. |
3636
| `flightsql_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)). |
3737
| `flightsql_password` | Optional. The password to use in the underlying Apache flight Handshake Request to authenticate to the server. Use the [secret replacement syntax](../secret-stores/index.md) to load the password from a secret store, e.g. `${secrets:my_flightsql_pass}`. |
3838

website/versioned_docs/version-1.9.x/components/data-connectors/flightsql.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The dataset name. This will be used as the table name within Spice. The dataset
3232

3333
| Parameter name | Description |
3434
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
35-
| `flightsql_endpoint` | The Apache Flight endpoint used to connect to the Flight SQL server. |
35+
| `flightsql_endpoint` | Required. The Apache Flight endpoint used to connect to the Flight SQL server. |
3636
| `flightsql_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)). |
3737
| `flightsql_password` | Optional. The password to use in the underlying Apache flight Handshake Request to authenticate to the server. Use the [secret replacement syntax](../secret-stores) to load the password from a secret store, e.g. `${secrets:my_flightsql_pass}`. |
3838

0 commit comments

Comments
 (0)