SparkSession class

パッケージ:: @azure/synapse

SparkSession を表すクラス。

コンストラクター

SparkSession を作成します。

メソッド

create(string, string, ExtendedLivySessionRequest, ServiceCallback<ExtendedLivySessionResponse>)
create(string, string, ExtendedLivySessionRequest, SparkSessionCreateOptionalParams)	新しい Spark セッションを作成します。
create(string, string, ExtendedLivySessionRequest, SparkSessionCreateOptionalParams, ServiceCallback<ExtendedLivySessionResponse>)
createStatement(string, string, number, LivyStatementRequestBody, RequestOptionsBase)	Spark セッション内にステートメントを作成します。
createStatement(string, string, number, LivyStatementRequestBody, RequestOptionsBase, ServiceCallback<LivyStatementResponseBody>)
createStatement(string, string, number, LivyStatementRequestBody, ServiceCallback<LivyStatementResponseBody>)
deleteMethod(string, string, number, RequestOptionsBase)	実行中の Spark セッションを取り消します。
deleteMethod(string, string, number, RequestOptionsBase, ServiceCallback<void>)
deleteMethod(string, string, number, ServiceCallback<void>)
deleteStatement(string, string, number, number, RequestOptionsBase)	セッション内のステートメントを強制終了します。
deleteStatement(string, string, number, number, RequestOptionsBase, ServiceCallback<LivyStatementCancellationResponse>)
deleteStatement(string, string, number, number, ServiceCallback<LivyStatementCancellationResponse>)
get(string, string, number, ServiceCallback<ExtendedLivySessionResponse>)
get(string, string, number, SparkSessionGetOptionalParams)	1 つの Spark セッションを取得します。
get(string, string, number, SparkSessionGetOptionalParams, ServiceCallback<ExtendedLivySessionResponse>)
getStatement(string, string, number, number, RequestOptionsBase)	Spark セッション内の 1 つのステートメントを取得します。
getStatement(string, string, number, number, RequestOptionsBase, ServiceCallback<LivyStatementResponseBody>)
getStatement(string, string, number, number, ServiceCallback<LivyStatementResponseBody>)
list(string, string, ServiceCallback<ExtendedLivyListSessionResponse>)
list(string, string, SparkSessionListOptionalParams)	特定の Spark プールで実行されているすべての Spark セッションを一覧表示します。
list(string, string, SparkSessionListOptionalParams, ServiceCallback<ExtendedLivyListSessionResponse>)
listStatements(string, string, number, RequestOptionsBase)	Spark セッション内のステートメントの一覧を取得します。
listStatements(string, string, number, RequestOptionsBase, ServiceCallback<LivyStatementsResponseBody>)
listStatements(string, string, number, ServiceCallback<LivyStatementsResponseBody>)
resetTimeout(string, string, number, RequestOptionsBase)	セッションタイムアウトをリセットするために、キープアライブ呼び出しを現在のセッションに送信します。
resetTimeout(string, string, number, RequestOptionsBase, ServiceCallback<void>)
resetTimeout(string, string, number, ServiceCallback<void>)

コンストラクターの詳細

SparkSession(SynapseClientContext)

SparkSession を作成します。

new SparkSession(client: SynapseClientContext)

パラメーター

client: SynapseClientContext

サービスクライアントへの参照。

メソッドの詳細

create(string, string, ExtendedLivySessionRequest, ServiceCallback<ExtendedLivySessionResponse>)

function create(workspaceName: string, sparkPoolName: string, livyRequest: ExtendedLivySessionRequest, callback: ServiceCallback<ExtendedLivySessionResponse>)

パラメーター

workspaceName: string

操作を実行するワークスペースの名前。

sparkPoolName: string

Spark プールの名前。 "ondemand" は ondemand プールを対象とします。

livyRequest: ExtendedLivySessionRequest

Livy 互換のバッチジョブ要求ペイロード。

callback: ServiceCallback<ExtendedLivySessionResponse>

コールバック

create(string, string, ExtendedLivySessionRequest, SparkSessionCreateOptionalParams)

新しい Spark セッションを作成します。

function create(workspaceName: string, sparkPoolName: string, livyRequest: ExtendedLivySessionRequest, options?: SparkSessionCreateOptionalParams): Promise<SparkSessionCreateResponse>

パラメーター

workspaceName: string

操作を実行するワークスペースの名前。

sparkPoolName: string

Spark プールの名前。 "ondemand" は ondemand プールを対象とします。

livyRequest: ExtendedLivySessionRequest

Livy 互換のバッチジョブ要求ペイロード。

options: SparkSessionCreateOptionalParams

省略可能なパラメーター

戻り値

Promise<SparkSessionCreateResponse>

Promise<Models.SparkSessionCreateResponseです。>

create(string, string, ExtendedLivySessionRequest, SparkSessionCreateOptionalParams, ServiceCallback<ExtendedLivySessionResponse>)

function create(workspaceName: string, sparkPoolName: string, livyRequest: ExtendedLivySessionRequest, options: SparkSessionCreateOptionalParams, callback: ServiceCallback<ExtendedLivySessionResponse>)

パラメーター

workspaceName: string

操作を実行するワークスペースの名前。

sparkPoolName: string

Spark プールの名前。 "ondemand" は ondemand プールを対象とします。

livyRequest: ExtendedLivySessionRequest

Livy 互換のバッチジョブ要求ペイロード。

options: SparkSessionCreateOptionalParams

省略可能なパラメーター

callback: ServiceCallback<ExtendedLivySessionResponse>

コールバック

createStatement(string, string, number, LivyStatementRequestBody, RequestOptionsBase)

Spark セッション内にステートメントを作成します。

function createStatement(workspaceName: string, sparkPoolName: string, sessionId: number, livyRequest: LivyStatementRequestBody, options?: RequestOptionsBase): Promise<SparkSessionCreateStatementResponse>

パラメーター

workspaceName: string

操作を実行するワークスペースの名前。

sparkPoolName: string

Spark プールの名前。 "ondemand" は ondemand プールを対象とします。

sessionId: number

セッションの識別子。

livyRequest: LivyStatementRequestBody

Livy 互換のバッチジョブ要求ペイロード。

options: RequestOptionsBase

省略可能なパラメーター

戻り値

Promise<SparkSessionCreateStatementResponse>

Promise<Models.SparkSessionCreateStatementResponse応答>

createStatement(string, string, number, LivyStatementRequestBody, RequestOptionsBase, ServiceCallback<LivyStatementResponseBody>)

function createStatement(workspaceName: string, sparkPoolName: string, sessionId: number, livyRequest: LivyStatementRequestBody, options: RequestOptionsBase, callback: ServiceCallback<LivyStatementResponseBody>)

パラメーター

workspaceName: string

操作を実行するワークスペースの名前。

sparkPoolName: string

Spark プールの名前。 "ondemand" は ondemand プールを対象とします。

sessionId: number

セッションの識別子。

livyRequest: LivyStatementRequestBody

Livy 互換のバッチジョブ要求ペイロード。

options: RequestOptionsBase

省略可能なパラメーター

callback: ServiceCallback<LivyStatementResponseBody>

コールバック

createStatement(string, string, number, LivyStatementRequestBody, ServiceCallback<LivyStatementResponseBody>)

function createStatement(workspaceName: string, sparkPoolName: string, sessionId: number, livyRequest: LivyStatementRequestBody, callback: ServiceCallback<LivyStatementResponseBody>)

パラメーター

workspaceName: string

操作を実行するワークスペースの名前。

sparkPoolName: string

Spark プールの名前。 "ondemand" は ondemand プールを対象とします。

sessionId: number

セッションの識別子。

livyRequest: LivyStatementRequestBody

Livy 互換のバッチジョブ要求ペイロード。

callback: ServiceCallback<LivyStatementResponseBody>

コールバック

deleteMethod(string, string, number, RequestOptionsBase)

実行中の Spark セッションを取り消します。

function deleteMethod(workspaceName: string, sparkPoolName: string, sessionId: number, options?: RequestOptionsBase): Promise<RestResponse>

パラメーター

workspaceName: string

操作を実行するワークスペースの名前。

sparkPoolName: string

Spark プールの名前。 "ondemand" は ondemand プールを対象とします。

sessionId: number

セッションの識別子。

options: RequestOptionsBase

省略可能なパラメーター

戻り値

Promise<RestResponse>

Promise<msRest.RestResponse応答>

deleteMethod(string, string, number, RequestOptionsBase, ServiceCallback<void>)

function deleteMethod(workspaceName: string, sparkPoolName: string, sessionId: number, options: RequestOptionsBase, callback: ServiceCallback<void>)

パラメーター

workspaceName: string

操作を実行するワークスペースの名前。

sparkPoolName: string

Spark プールの名前。 "ondemand" は ondemand プールを対象とします。

sessionId: number

セッションの識別子。

options: RequestOptionsBase

省略可能なパラメーター

callback: ServiceCallback<void>

コールバック

deleteMethod(string, string, number, ServiceCallback<void>)

function deleteMethod(workspaceName: string, sparkPoolName: string, sessionId: number, callback: ServiceCallback<void>)

パラメーター

workspaceName: string

操作を実行するワークスペースの名前。

sparkPoolName: string

Spark プールの名前。 "ondemand" は ondemand プールを対象とします。

sessionId: number

セッションの識別子。

callback: ServiceCallback<void>

コールバック

deleteStatement(string, string, number, number, RequestOptionsBase)

セッション内のステートメントを強制終了します。

function deleteStatement(workspaceName: string, sparkPoolName: string, sessionId: number, statementId: number, options?: RequestOptionsBase): Promise<SparkSessionDeleteStatementResponse>

パラメーター

workspaceName: string

操作を実行するワークスペースの名前。

sparkPoolName: string

Spark プールの名前。 "ondemand" は ondemand プールを対象とします。

sessionId: number

セッションの識別子。

statementId: number

ステートメントの識別子。

options: RequestOptionsBase

省略可能なパラメーター

戻り値

Promise<SparkSessionDeleteStatementResponse>

Promise<Models.SparkSessionDeleteStatementResponse応答>

deleteStatement(string, string, number, number, RequestOptionsBase, ServiceCallback<LivyStatementCancellationResponse>)

function deleteStatement(workspaceName: string, sparkPoolName: string, sessionId: number, statementId: number, options: RequestOptionsBase, callback: ServiceCallback<LivyStatementCancellationResponse>)

パラメーター

workspaceName: string

操作を実行するワークスペースの名前。

sparkPoolName: string

Spark プールの名前。 "ondemand" は ondemand プールを対象とします。

sessionId: number

セッションの識別子。

statementId: number

ステートメントの識別子。

options: RequestOptionsBase

省略可能なパラメーター

callback: ServiceCallback<LivyStatementCancellationResponse>

コールバック

deleteStatement(string, string, number, number, ServiceCallback<LivyStatementCancellationResponse>)

function deleteStatement(workspaceName: string, sparkPoolName: string, sessionId: number, statementId: number, callback: ServiceCallback<LivyStatementCancellationResponse>)

パラメーター

workspaceName: string

操作を実行するワークスペースの名前。

sparkPoolName: string

Spark プールの名前。 "ondemand" は ondemand プールを対象とします。

sessionId: number

セッションの識別子。

statementId: number

ステートメントの識別子。

callback: ServiceCallback<LivyStatementCancellationResponse>

コールバック

get(string, string, number, ServiceCallback<ExtendedLivySessionResponse>)

function get(workspaceName: string, sparkPoolName: string, sessionId: number, callback: ServiceCallback<ExtendedLivySessionResponse>)

パラメーター

workspaceName: string

操作を実行するワークスペースの名前。

sparkPoolName: string

Spark プールの名前。 "ondemand" は ondemand プールを対象とします。

sessionId: number

セッションの識別子。

callback: ServiceCallback<ExtendedLivySessionResponse>

コールバック

get(string, string, number, SparkSessionGetOptionalParams)

1 つの Spark セッションを取得します。

function get(workspaceName: string, sparkPoolName: string, sessionId: number, options?: SparkSessionGetOptionalParams): Promise<SparkSessionGetResponse>

パラメーター

workspaceName: string

操作を実行するワークスペースの名前。

sparkPoolName: string

Spark プールの名前。 "ondemand" は ondemand プールを対象とします。

sessionId: number

セッションの識別子。

options: SparkSessionGetOptionalParams

省略可能なパラメーター

戻り値

Promise<SparkSessionGetResponse>

Promise<Models.SparkSessionGetResponse>

get(string, string, number, SparkSessionGetOptionalParams, ServiceCallback<ExtendedLivySessionResponse>)

function get(workspaceName: string, sparkPoolName: string, sessionId: number, options: SparkSessionGetOptionalParams, callback: ServiceCallback<ExtendedLivySessionResponse>)

パラメーター

workspaceName: string

操作を実行するワークスペースの名前。

sparkPoolName: string

Spark プールの名前。 "ondemand" は ondemand プールを対象とします。

sessionId: number

セッションの識別子。

options: SparkSessionGetOptionalParams

省略可能なパラメーター

callback: ServiceCallback<ExtendedLivySessionResponse>

コールバック

getStatement(string, string, number, number, RequestOptionsBase)

Spark セッション内の 1 つのステートメントを取得します。

function getStatement(workspaceName: string, sparkPoolName: string, sessionId: number, statementId: number, options?: RequestOptionsBase): Promise<SparkSessionGetStatementResponse>

パラメーター

workspaceName: string

操作を実行するワークスペースの名前。

sparkPoolName: string

Spark プールの名前。 "ondemand" は ondemand プールを対象とします。

sessionId: number

セッションの識別子。

statementId: number

ステートメントの識別子。

options: RequestOptionsBase

省略可能なパラメーター

戻り値

Promise<SparkSessionGetStatementResponse>

Promise<Models.SparkSessionGetStatementResponse応答>

getStatement(string, string, number, number, RequestOptionsBase, ServiceCallback<LivyStatementResponseBody>)

function getStatement(workspaceName: string, sparkPoolName: string, sessionId: number, statementId: number, options: RequestOptionsBase, callback: ServiceCallback<LivyStatementResponseBody>)

パラメーター

workspaceName: string

操作を実行するワークスペースの名前。

sparkPoolName: string

Spark プールの名前。 "ondemand" は ondemand プールを対象とします。

sessionId: number

セッションの識別子。

statementId: number

ステートメントの識別子。

options: RequestOptionsBase

省略可能なパラメーター

callback: ServiceCallback<LivyStatementResponseBody>

コールバック

getStatement(string, string, number, number, ServiceCallback<LivyStatementResponseBody>)

function getStatement(workspaceName: string, sparkPoolName: string, sessionId: number, statementId: number, callback: ServiceCallback<LivyStatementResponseBody>)

パラメーター

workspaceName: string

操作を実行するワークスペースの名前。

sparkPoolName: string

Spark プールの名前。 "ondemand" は ondemand プールを対象とします。

sessionId: number

セッションの識別子。

statementId: number

ステートメントの識別子。

callback: ServiceCallback<LivyStatementResponseBody>

コールバック

list(string, string, ServiceCallback<ExtendedLivyListSessionResponse>)

function list(workspaceName: string, sparkPoolName: string, callback: ServiceCallback<ExtendedLivyListSessionResponse>)

パラメーター

workspaceName: string

操作を実行するワークスペースの名前。

sparkPoolName: string

Spark プールの名前。 "ondemand" は ondemand プールを対象とします。

callback: ServiceCallback<ExtendedLivyListSessionResponse>

コールバック

list(string, string, SparkSessionListOptionalParams)

特定の Spark プールで実行されているすべての Spark セッションを一覧表示します。

function list(workspaceName: string, sparkPoolName: string, options?: SparkSessionListOptionalParams): Promise<SparkSessionListResponse>

パラメーター

workspaceName: string

操作を実行するワークスペースの名前。

sparkPoolName: string

Spark プールの名前。 "ondemand" は ondemand プールを対象とします。

options: SparkSessionListOptionalParams

省略可能なパラメーター

戻り値

Promise<SparkSessionListResponse>

Promise<Models.SparkSessionListResponse応答>

list(string, string, SparkSessionListOptionalParams, ServiceCallback<ExtendedLivyListSessionResponse>)

function list(workspaceName: string, sparkPoolName: string, options: SparkSessionListOptionalParams, callback: ServiceCallback<ExtendedLivyListSessionResponse>)

パラメーター

workspaceName: string

操作を実行するワークスペースの名前。

sparkPoolName: string

Spark プールの名前。 "ondemand" は ondemand プールを対象とします。

options: SparkSessionListOptionalParams

省略可能なパラメーター

callback: ServiceCallback<ExtendedLivyListSessionResponse>

コールバック

listStatements(string, string, number, RequestOptionsBase)

Spark セッション内のステートメントの一覧を取得します。

function listStatements(workspaceName: string, sparkPoolName: string, sessionId: number, options?: RequestOptionsBase): Promise<SparkSessionListStatementsResponse>

パラメーター

workspaceName: string

操作を実行するワークスペースの名前。

sparkPoolName: string

Spark プールの名前。 "ondemand" は ondemand プールを対象とします。

sessionId: number

セッションの識別子。

options: RequestOptionsBase

省略可能なパラメーター

戻り値

Promise<SparkSessionListStatementsResponse>

Promise<Models.SparkSessionListStatementsResponse応答>

listStatements(string, string, number, RequestOptionsBase, ServiceCallback<LivyStatementsResponseBody>)

function listStatements(workspaceName: string, sparkPoolName: string, sessionId: number, options: RequestOptionsBase, callback: ServiceCallback<LivyStatementsResponseBody>)

パラメーター

workspaceName: string

操作を実行するワークスペースの名前。

sparkPoolName: string

Spark プールの名前。 "ondemand" は ondemand プールを対象とします。

sessionId: number

セッションの識別子。

options: RequestOptionsBase

省略可能なパラメーター

callback: ServiceCallback<LivyStatementsResponseBody>

コールバック

listStatements(string, string, number, ServiceCallback<LivyStatementsResponseBody>)

function listStatements(workspaceName: string, sparkPoolName: string, sessionId: number, callback: ServiceCallback<LivyStatementsResponseBody>)

パラメーター

workspaceName: string

操作を実行するワークスペースの名前。

sparkPoolName: string

Spark プールの名前。 "ondemand" は ondemand プールを対象とします。

sessionId: number

セッションの識別子。

callback: ServiceCallback<LivyStatementsResponseBody>

コールバック

resetTimeout(string, string, number, RequestOptionsBase)

セッションタイムアウトをリセットするために、キープアライブ呼び出しを現在のセッションに送信します。

function resetTimeout(workspaceName: string, sparkPoolName: string, sessionId: number, options?: RequestOptionsBase): Promise<RestResponse>

パラメーター

workspaceName: string

操作を実行するワークスペースの名前。

sparkPoolName: string

Spark プールの名前。 "ondemand" は ondemand プールを対象とします。

sessionId: number

セッションの識別子。

options: RequestOptionsBase

省略可能なパラメーター

戻り値

Promise<RestResponse>

Promise<msRest.RestResponse応答>

resetTimeout(string, string, number, RequestOptionsBase, ServiceCallback<void>)

function resetTimeout(workspaceName: string, sparkPoolName: string, sessionId: number, options: RequestOptionsBase, callback: ServiceCallback<void>)

パラメーター

workspaceName: string

操作を実行するワークスペースの名前。

sparkPoolName: string

Spark プールの名前。 "ondemand" は ondemand プールを対象とします。

sessionId: number

セッションの識別子。

options: RequestOptionsBase

省略可能なパラメーター

callback: ServiceCallback<void>

コールバック

resetTimeout(string, string, number, ServiceCallback<void>)

function resetTimeout(workspaceName: string, sparkPoolName: string, sessionId: number, callback: ServiceCallback<void>)

パラメーター

workspaceName: string

操作を実行するワークスペースの名前。

sparkPoolName: string

Spark プールの名前。 "ondemand" は ondemand プールを対象とします。

sessionId: number

セッションの識別子。

callback: ServiceCallback<void>

コールバック