diff --git a/connector/connect/common/src/main/scala/org/apache/spark/sql/connect/client/SparkConnectClientParser.scala b/connector/connect/common/src/main/scala/org/apache/spark/sql/connect/client/SparkConnectClientParser.scala index f873e1045bfcd..cfb5823ee43e0 100644 --- a/connector/connect/common/src/main/scala/org/apache/spark/sql/connect/client/SparkConnectClientParser.scala +++ b/connector/connect/common/src/main/scala/org/apache/spark/sql/connect/client/SparkConnectClientParser.scala @@ -24,6 +24,7 @@ import scala.annotation.tailrec */ private[sql] object SparkConnectClientParser { + // scalastyle:off line.size.limit /** * @return * usage string. @@ -34,12 +35,15 @@ private[sql] object SparkConnectClientParser { | --remote REMOTE URI of the Spark Connect Server to connect to. | --host HOST Host where the Spark Connect Server is running. | --port PORT Port where the Spark Connect Server is running. - | --enable-ssl Connect to the server using SSL. + | --use_ssl Connect to the server using SSL. | --token TOKEN Token to use for authentication. | --user_id USER_ID Id of the user connecting. | --user_name USER_NAME Name of the user connecting. + | --user_agent USER_AGENT The User-Agent Client information (only intended for logging purposes by the server). + | --session_id SESSION_ID Session Id of the user connecting. | --option KEY=VALUE Key-value pair that is used to further configure the session. """.stripMargin + // scalastyle:on line.size.limit /** * Parse the command line and configure the builder. diff --git a/docs/spark-connect-overview.md b/docs/spark-connect-overview.md index 1cd70a57b6cb7..7a085df86c8de 100644 --- a/docs/spark-connect-overview.md +++ b/docs/spark-connect-overview.md @@ -279,7 +279,7 @@ The customizations may also be passed in through CLI arguments as shown below: spark-connect-repl --host myhost.com --port 443 --token ABCDEFG {% endhighlight %} -The supported list of CLI arguments may be found [here](https://github.com/apache/spark/blob/master/connector/connect/client/jvm/src/main/scala/org/apache/spark/sql/connect/client/SparkConnectClientParser.scala#L48). +The supported list of CLI arguments may be found [here](https://github.com/apache/spark/blob/master/connector/connect/common/src/main/scala/org/apache/spark/sql/connect/client/SparkConnectClientParser.scala#L48). #### Configure programmatically with a connection string