Skip to content

SparkSessionConfig

Defined in: spark-session.ts:121

Construction parameters for a SparkSession. Most users build a session via the runtime adapter’s builder (e.g. SparkSessionBuilder from @spark-connect-js/node); this config is what the builder hands to SparkSession._create internally.

optional arrowDecoder?: ArrowDecoderFn;

Defined in: spark-session.ts:132

Arrow IPC to Row[] decoder injected by the runtime adapter. If not provided, collect() and similar actions will throw at runtime.


optional arrowEncoder?: ArrowEncoderFn;

Defined in: spark-session.ts:139

Row[] to Arrow IPC encoder injected by the runtime adapter. If not provided, createDataFrame([...]) with plain rows will throw at runtime. Passing a Uint8Array still works without an encoder.


remote: string;

Defined in: spark-session.ts:123

Spark Connect endpoint, e.g. "sc://localhost:15002".


optional sessionId?: string;

Defined in: spark-session.ts:142

Optional session ID override for reattaching to an existing server-side session.


transport: Transport;

Defined in: spark-session.ts:126

Transport implementation injected by the runtime adapter.