Skip to content

Commit d570ef6

Browse files
claudespicelukekim
authored andcommitted
fix: Mark spark_remote parameter as Required in Spark connector docs
The spark_remote parameter is declared as .required() in the connector code (connector-spark/src/lib.rs), but the docs did not indicate this. Add "Required." to the spark_remote parameter description across vNext and all versioned docs (1.5.x-1.11.x).
1 parent 00758d0 commit d570ef6

8 files changed

Lines changed: 8 additions & 8 deletions

File tree

  • website
    • docs/components/data-connectors
    • versioned_docs
      • version-1.10.x/components/data-connectors
      • version-1.11.x/components/data-connectors
      • version-1.5.x/components/data-connectors
      • version-1.6.x/components/data-connectors
      • version-1.7.x/components/data-connectors
      • version-1.8.x/components/data-connectors
      • version-1.9.x/components/data-connectors

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Unquoted identifiers are normalized to lowercase. To reference a table with mixe
2424

2525
## Configuration
2626

27-
- `spark_remote`: A [spark remote](https://spark.apache.org/docs/latest/spark-connect-overview.html#set-sparkremote-environment-variable) connection URI. Refer to [spark connect client connection string](https://github.com/apache/spark/blob/master/connector/connect/docs/client-connection-string) for parameters in URI.
27+
- `spark_remote`: Required. A [spark remote](https://spark.apache.org/docs/latest/spark-connect-overview.html#set-sparkremote-environment-variable) connection URI. Refer to [spark connect client connection string](https://github.com/apache/spark/blob/master/connector/connect/docs/client-connection-string) for parameters in URI.
2828

2929
The dataset name cannot be a [reserved keyword](../../reference/spicepod/keywords).
3030

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ datasets:
2020
2121
## Configuration
2222
23-
- `spark_remote`: A [spark remote](https://spark.apache.org/docs/latest/spark-connect-overview.html#set-sparkremote-environment-variable) connection URI. Refer to [spark connect client connection string](https://github.com/apache/spark/blob/master/connector/connect/docs/client-connection-string) for parameters in URI.
23+
- `spark_remote`: Required. A [spark remote](https://spark.apache.org/docs/latest/spark-connect-overview.html#set-sparkremote-environment-variable) connection URI. Refer to [spark connect client connection string](https://github.com/apache/spark/blob/master/connector/connect/docs/client-connection-string) for parameters in URI.
2424

2525
The dataset name cannot be a [reserved keyword](../../reference/spicepod/keywords).
2626

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ datasets:
2020
2121
## Configuration
2222
23-
- `spark_remote`: A [spark remote](https://spark.apache.org/docs/latest/spark-connect-overview.html#set-sparkremote-environment-variable) connection URI. Refer to [spark connect client connection string](https://github.com/apache/spark/blob/master/connector/connect/docs/client-connection-string) for parameters in URI.
23+
- `spark_remote`: Required. A [spark remote](https://spark.apache.org/docs/latest/spark-connect-overview.html#set-sparkremote-environment-variable) connection URI. Refer to [spark connect client connection string](https://github.com/apache/spark/blob/master/connector/connect/docs/client-connection-string) for parameters in URI.
2424

2525
The dataset name cannot be a [reserved keyword](../../reference/spicepod/keywords).
2626

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ datasets:
2020
2121
## Configuration
2222
23-
- `spark_remote`: A [spark remote](https://spark.apache.org/docs/latest/spark-connect-overview.html#set-sparkremote-environment-variable) connection URI. Refer to [spark connect client connection string](https://github.com/apache/spark/blob/master/connector/connect/docs/client-connection-string.md) for parameters in URI.
23+
- `spark_remote`: Required. A [spark remote](https://spark.apache.org/docs/latest/spark-connect-overview.html#set-sparkremote-environment-variable) connection URI. Refer to [spark connect client connection string](https://github.com/apache/spark/blob/master/connector/connect/docs/client-connection-string.md) for parameters in URI.
2424

2525
The dataset name cannot be a [reserved keyword](../../reference/spicepod/keywords).
2626

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ datasets:
2020
2121
## Configuration
2222
23-
- `spark_remote`: A [spark remote](https://spark.apache.org/docs/latest/spark-connect-overview.html#set-sparkremote-environment-variable) connection URI. Refer to [spark connect client connection string](https://github.com/apache/spark/blob/master/connector/connect/docs/client-connection-string) for parameters in URI.
23+
- `spark_remote`: Required. A [spark remote](https://spark.apache.org/docs/latest/spark-connect-overview.html#set-sparkremote-environment-variable) connection URI. Refer to [spark connect client connection string](https://github.com/apache/spark/blob/master/connector/connect/docs/client-connection-string) for parameters in URI.
2424

2525
The dataset name cannot be a [reserved keyword](../../reference/spicepod/keywords).
2626

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ datasets:
2020
2121
## Configuration
2222
23-
- `spark_remote`: A [spark remote](https://spark.apache.org/docs/latest/spark-connect-overview.html#set-sparkremote-environment-variable) connection URI. Refer to [spark connect client connection string](https://github.com/apache/spark/blob/master/connector/connect/docs/client-connection-string) for parameters in URI.
23+
- `spark_remote`: Required. A [spark remote](https://spark.apache.org/docs/latest/spark-connect-overview.html#set-sparkremote-environment-variable) connection URI. Refer to [spark connect client connection string](https://github.com/apache/spark/blob/master/connector/connect/docs/client-connection-string) for parameters in URI.
2424

2525
The dataset name cannot be a [reserved keyword](../../reference/spicepod/keywords).
2626

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ datasets:
2020
2121
## Configuration
2222
23-
- `spark_remote`: A [spark remote](https://spark.apache.org/docs/latest/spark-connect-overview.html#set-sparkremote-environment-variable) connection URI. Refer to [spark connect client connection string](https://github.com/apache/spark/blob/master/connector/connect/docs/client-connection-string.md) for parameters in URI.
23+
- `spark_remote`: Required. A [spark remote](https://spark.apache.org/docs/latest/spark-connect-overview.html#set-sparkremote-environment-variable) connection URI. Refer to [spark connect client connection string](https://github.com/apache/spark/blob/master/connector/connect/docs/client-connection-string.md) for parameters in URI.
2424

2525
The dataset name cannot be a [reserved keyword](../../reference/spicepod/keywords.md).
2626

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ datasets:
2020
2121
## Configuration
2222
23-
- `spark_remote`: A [spark remote](https://spark.apache.org/docs/latest/spark-connect-overview.html#set-sparkremote-environment-variable) connection URI. Refer to [spark connect client connection string](https://github.com/apache/spark/blob/master/connector/connect/docs/client-connection-string.md) for parameters in URI.
23+
- `spark_remote`: Required. A [spark remote](https://spark.apache.org/docs/latest/spark-connect-overview.html#set-sparkremote-environment-variable) connection URI. Refer to [spark connect client connection string](https://github.com/apache/spark/blob/master/connector/connect/docs/client-connection-string.md) for parameters in URI.
2424

2525
The dataset name cannot be a [reserved keyword](../../reference/spicepod/keywords).
2626

0 commit comments

Comments
 (0)