SparkSession | @azure/synapse-spark

Class representing a SparkSession.

Hierarchy

SparkSession

Index

Constructors

constructor

Methods

Object literals

type

Constructors

constructor

new SparkSession(client: SparkClient): SparkSession

- Defined in operations/sparkSession.ts:26
Initialize a new instance of the class SparkSession class.

Parameters
- client: SparkClient
  
  Reference to the service client
Returns SparkSession

Methods

cancelSparkSession

cancelSparkSession(sessionId: number, options?: coreHttp.OperationOptions): Promise<coreHttp.RestResponse>

- Defined in operations/sparkSession.ts:140
Cancels a running spark session.

Parameters
- sessionId: number
  
  Identifier for the session.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<coreHttp.RestResponse>

cancelSparkStatement

cancelSparkStatement(sessionId: number, statementId: number, options?: coreHttp.OperationOptions): Promise<SparkSessionCancelSparkStatementResponse>

- Defined in operations/sparkSession.ts:317
Kill a statement within a session.

Parameters
- sessionId: number
  
  Identifier for the session.
- statementId: number
  
  Identifier for the statement.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<SparkSessionCancelSparkStatementResponse>

createSparkSession

createSparkSession(sparkSessionOptions: SparkSessionOptions, options?: SparkSessionCreateSparkSessionOptionalParams): Promise<SparkSessionCreateSparkSessionResponse>

- Defined in operations/sparkSession.ts:72
Create new spark session.

Parameters
- sparkSessionOptions: SparkSessionOptions
  
  Livy compatible batch job request payload.
- Optional options: SparkSessionCreateSparkSessionOptionalParams
  
  The options parameters.
Returns Promise<SparkSessionCreateSparkSessionResponse>

createSparkStatement

createSparkStatement(sessionId: number, sparkStatementOptions: SparkStatementOptions, options?: coreHttp.OperationOptions): Promise<SparkSessionCreateSparkStatementResponse>

- Defined in operations/sparkSession.ts:243
Create statement within a spark session.

Parameters
- sessionId: number
  
  Identifier for the session.
- sparkStatementOptions: SparkStatementOptions
  
  Livy compatible batch job request payload.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<SparkSessionCreateSparkStatementResponse>

getSparkSession

getSparkSession(sessionId: number, options?: SparkSessionGetSparkSessionOptionalParams): Promise<SparkSessionGetSparkSessionResponse>

- Defined in operations/sparkSession.ts:106
Gets a single spark session.

Parameters
- sessionId: number
  
  Identifier for the session.
- Optional options: SparkSessionGetSparkSessionOptionalParams
  
  The options parameters.
Returns Promise<SparkSessionGetSparkSessionResponse>

getSparkSessions

getSparkSessions(options?: SparkSessionGetSparkSessionsOptionalParams): Promise<SparkSessionGetSparkSessionsResponse>

- Defined in operations/sparkSession.ts:40
List all spark sessions which are running under a particular spark pool.

Parameters
- Optional options: SparkSessionGetSparkSessionsOptionalParams
  
  The options parameters.
Returns Promise<SparkSessionGetSparkSessionsResponse>

getSparkStatement

getSparkStatement(sessionId: number, statementId: number, options?: coreHttp.OperationOptions): Promise<SparkSessionGetSparkStatementResponse>

- Defined in operations/sparkSession.ts:280
Gets a single statement within a spark session.

Parameters
- sessionId: number
  
  Identifier for the session.
- statementId: number
  
  Identifier for the statement.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<SparkSessionGetSparkStatementResponse>

getSparkStatements

getSparkStatements(sessionId: number, options?: coreHttp.OperationOptions): Promise<SparkSessionGetSparkStatementsResponse>

- Defined in operations/sparkSession.ts:208
Gets a list of statements within a spark session.

Parameters
- sessionId: number
  
  Identifier for the session.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<SparkSessionGetSparkStatementsResponse>

resetSparkSessionTimeout

resetSparkSessionTimeout(sessionId: number, options?: coreHttp.OperationOptions): Promise<coreHttp.RestResponse>

- Defined in operations/sparkSession.ts:174
Sends a keep alive call to the current session to reset the session timeout.

Parameters
- sessionId: number
  
  Identifier for the session.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<coreHttp.RestResponse>

Object literals

type

type: object

className

className: string = "SparkSession"

name

modelProperties

modelProperties: object

appId

appId: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "appId"

type

type: object

name

appInfo

appInfo: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "appInfo"

type

type: object

name

value

value: object

type

type: object

name

artifactId

artifactId: object

serializedName

serializedName: string = "artifactId"

type

type: object

name

errors

errors: object

serializedName

serializedName: string = "errorInfo"

type

type: object

name

element

element: object

type

type: object

className

className: string = "SparkServiceError"

name

id

id: object

required

required: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

jobType

jobType: object

serializedName

serializedName: string = "jobType"

type

type: object

name

livyInfo

livyInfo: object

serializedName

serializedName: string = "livyInfo"

type

type: object

className

className: string = "SparkSessionState"

name

logLines

logLines: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "log"

type

type: object

name

element

element: object

type

type: object

name

name

serializedName

serializedName: string = "name"

type

type: object

name

plugin

plugin: object

serializedName

serializedName: string = "pluginInfo"

type

type: object

className

className: string = "SparkServicePlugin"

name

result

result: object

serializedName

serializedName: string = "result"

type

type: object

name

scheduler

scheduler: object

serializedName

serializedName: string = "schedulerInfo"

type

type: object

className

className: string = "SparkScheduler"

name

sparkPoolName

sparkPoolName: object

serializedName

serializedName: string = "sparkPoolName"

type

type: object

name

state

state: object

serializedName

serializedName: string = "state"

type

type: object

name

submitterId

submitterId: object

serializedName

serializedName: string = "submitterId"

type

type: object

name

submitterName

submitterName: object

serializedName

serializedName: string = "submitterName"

type

type: object

name

serializedName

serializedName: string = "tags"

type

type: object

name

value

value: object

type

type: object

name

workspaceName

workspaceName: object

serializedName

serializedName: string = "workspaceName"

type

type: object

name

Hierarchy

Index

Constructors

Methods

Object literals

Constructors

constructor

Parameters

client: SparkClient

Returns SparkSession

Methods

cancelSparkSession

Parameters

sessionId: number

Optional options: coreHttp.OperationOptions

Returns Promise<coreHttp.RestResponse>

cancelSparkStatement

Parameters

sessionId: number

statementId: number

Optional options: coreHttp.OperationOptions

Returns Promise<SparkSessionCancelSparkStatementResponse>

createSparkSession

Parameters

sparkSessionOptions: SparkSessionOptions

Optional options: SparkSessionCreateSparkSessionOptionalParams

Returns Promise<SparkSessionCreateSparkSessionResponse>

createSparkStatement

Parameters

sessionId: number

sparkStatementOptions: SparkStatementOptions

Optional options: coreHttp.OperationOptions

Returns Promise<SparkSessionCreateSparkStatementResponse>

getSparkSession

Parameters

sessionId: number

Optional options: SparkSessionGetSparkSessionOptionalParams

Returns Promise<SparkSessionGetSparkSessionResponse>

getSparkSessions

Parameters

Optional options: SparkSessionGetSparkSessionsOptionalParams

Returns Promise<SparkSessionGetSparkSessionsResponse>

getSparkStatement

Parameters

sessionId: number

statementId: number

Optional options: coreHttp.OperationOptions

Returns Promise<SparkSessionGetSparkStatementResponse>

getSparkStatements

Parameters

sessionId: number

Optional options: coreHttp.OperationOptions

Returns Promise<SparkSessionGetSparkStatementsResponse>

resetSparkSessionTimeout

Parameters

sessionId: number

Optional options: coreHttp.OperationOptions

Returns Promise<coreHttp.RestResponse>

Object literals

type

className

name

modelProperties

appId

nullable

serializedName

type

name

appInfo

nullable

serializedName

type

name

value

type

name

artifactId

serializedName

type

name