SparkConnectClient

org.apache.spark.sql.connect.client.SparkConnectClient
See theSparkConnectClient companion class

Attributes

Companion
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Type members

Classlikes

class Builder(var configuration: Configuration)

Fluent builder for a SparkConnectClient.

Fluent builder for a SparkConnectClient.

Attributes

Supertypes
class Object
trait Matchable
class Any
case class Configuration(host: String, port: Int, useSsl: Boolean, token: Option[String], userId: Option[String], userName: Option[String], userAgent: String, sessionId: Option[String], metadata: Map[String, String], maxInboundMessageSize: Int, useReattachableExecute: Boolean, retryPolicies: Seq[RetryPolicy], rpcDeadlines: RpcDeadlines, maxRetryExceptionElapsedTime: FiniteDuration, grpcKeepAliveEnabled: Boolean, grpcKeepAliveTimeMs: Long, grpcKeepAliveTimeoutMs: Long, grpcKeepAliveWithoutCalls: Boolean)

Immutable connection configuration. Construct via Builder or Builder.connectionString.

Immutable connection configuration. Construct via Builder or Builder.connectionString.

The keepalive settings make the client send HTTP/2 PINGs so a connection that silently died (e.g. a NAT gateway dropped it) fails with UNAVAILABLE instead of hanging; they default to Apache Spark 4.3's values (enabled, 60s, 20s, also without calls).

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Configuration

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type

Value members

Concrete methods

def builder(): Builder
def getOperationId(error: Throwable): Option[String]

Returns the Spark Connect operation id of the execution that raised error, if the error was raised by an ExecutePlan call of this client (e.g. to pass to interruptOperation or SparkConnectClient.getOperationStatuses).

Returns the Spark Connect operation id of the execution that raised error, if the error was raised by an ExecutePlan call of this client (e.g. to pass to interruptOperation or SparkConnectClient.getOperationStatuses).

Attributes