Class AnalyzePlanResponseHandler

Handles responses from AnalyzePlanRequest operations.

Remarks

This class wraps AnalyzePlanResponse and provides type-safe access to different analysis result types using discriminated unions. It validates the result type before accessing specific values.

Example

const handler = new AnalyzePlanResponseHandler(response);
const schema = handler.schema; // Type-safe access
const explain = handler.explain; // Throws if not explain result

Index

Constructors

constructor

new AnalyzePlanResponseHandler(
response: AnalyzePlanResponse,
): AnalyzePlanResponseHandler
Parameters
- response: AnalyzePlanResponse
Returns AnalyzePlanResponseHandler
- Defined in src/org/apache/spark/sql/proto/AnalyzePlanResponeHandler.ts:66

Properties

`Readonly`response

response: AnalyzePlanResponse

core

sessionId

get sessionId(): string
Returns the session ID for this response.

Returns string
The session identifier
- Defined in src/org/apache/spark/sql/proto/AnalyzePlanResponeHandler.ts:77

serverSideSessionId

get serverSideSessionId(): string
Returns the server-side session ID.

Returns string
The server-side session identifier
- Defined in src/org/apache/spark/sql/proto/AnalyzePlanResponeHandler.ts:87

result

get result(): AnalyzeResultType
Returns the raw result structure.

Returns AnalyzeResultType
The result discriminated union
- Defined in src/org/apache/spark/sql/proto/AnalyzePlanResponeHandler.ts:97

result

schema

get schema(): DataType
Returns the schema data type from the analysis result.

Returns DataType
The DataType representing the schema

Throws
Error if the result type is not schema or if schema is undefined
- Defined in src/org/apache/spark/sql/proto/AnalyzePlanResponeHandler.ts:108

explain

get explain(): string
Returns the explain string from the analysis result.

Returns string
The explain plan string

Throws
Error if the result type is not explain
- Defined in src/org/apache/spark/sql/proto/AnalyzePlanResponeHandler.ts:127

treeString

get treeString(): string
Returns the tree string representation of the plan.

Returns string
The tree structure as a string

Throws
Error if the result type is not treeString
- Defined in src/org/apache/spark/sql/proto/AnalyzePlanResponeHandler.ts:141

isLocal

get isLocal(): boolean
Returns whether the DataFrame can be executed locally.

Returns boolean
True if the DataFrame can run locally

Throws
Error if the result type is not isLocal
- Defined in src/org/apache/spark/sql/proto/AnalyzePlanResponeHandler.ts:155

isStreaming

get isStreaming(): boolean
Returns whether the DataFrame is a streaming DataFrame.

Returns boolean
True if this is a streaming DataFrame

Throws
Error if the result type is not isStreaming
- Defined in src/org/apache/spark/sql/proto/AnalyzePlanResponeHandler.ts:169

version

get version(): string
Returns the Spark version string.

Returns string
The Spark version

Throws
Error if the result type is not sparkVersion
- Defined in src/org/apache/spark/sql/proto/AnalyzePlanResponeHandler.ts:183

inputFiles

get inputFiles(): string[]
Returns the list of input files for the DataFrame.

Returns string[]
Array of input file paths

Throws
Error if the result type is not inputFiles
- Defined in src/org/apache/spark/sql/proto/AnalyzePlanResponeHandler.ts:197

sameSemantics

get sameSemantics(): boolean
Returns whether two DataFrames have the same semantics.

Returns boolean
True if the DataFrames have the same semantics

Throws
Error if the result type is not sameSemantics
- Defined in src/org/apache/spark/sql/proto/AnalyzePlanResponeHandler.ts:211

semanticHash

get semanticHash(): number
Returns the semantic hash of the DataFrame.

Returns number
The semantic hash value

Throws
Error if the result type is not semanticHash
- Defined in src/org/apache/spark/sql/proto/AnalyzePlanResponeHandler.ts:225

persist

get persist(): boolean
Returns the result of a persist operation.

Returns boolean
True if persist was successful

Throws
Error if the result type is not persist
- Defined in src/org/apache/spark/sql/proto/AnalyzePlanResponeHandler.ts:239

unpersist

get unpersist(): boolean
Returns the result of an unpersist operation.

Returns boolean
True if unpersist was successful

Throws
Error if the result type is not unpersist
- Defined in src/org/apache/spark/sql/proto/AnalyzePlanResponeHandler.ts:253

getStorageLevel

get getStorageLevel(): StorageLevel
Returns the storage level of the DataFrame.

Returns StorageLevel
The StorageLevel configuration

Throws
Error if the result type is not getStorageLevel
- Defined in src/org/apache/spark/sql/proto/AnalyzePlanResponeHandler.ts:267

Class AnalyzePlanResponseHandler

Remarks

Example

Index

Constructors

Properties

core

result

Constructors

constructor

Parameters

Returns AnalyzePlanResponseHandler

Properties

Readonlyresponse

core

sessionId

Returns string

serverSideSessionId

Returns string

result

Returns AnalyzeResultType

result

schema

Returns DataType

Throws

explain

Returns string

Throws

treeString

Returns string

Throws

isLocal

Returns boolean

Throws

isStreaming

Returns boolean

Throws

version

Returns string

Throws

inputFiles

Returns string[]

Throws

sameSemantics

Returns boolean

Throws

semanticHash

Returns number

Throws

persist

Returns boolean

Throws

unpersist

Returns boolean

Throws

getStorageLevel

Returns StorageLevel

Throws

Settings

On This Page

`Readonly`response