SqlScriptOperations interface

Package:

@azure/synapse-artifacts

Interface representing a SqlScriptOperations.

Methods

beginCreateOrUpdateSqlScript(string, SqlScriptResource, SqlScriptCreateOrUpdateSqlScriptOptionalParams)	Creates or updates a Sql Script.
beginCreateOrUpdateSqlScriptAndWait(string, SqlScriptResource, SqlScriptCreateOrUpdateSqlScriptOptionalParams)	Creates or updates a Sql Script.
beginDeleteSqlScript(string, SqlScriptDeleteSqlScriptOptionalParams)	Deletes a Sql Script.
beginDeleteSqlScriptAndWait(string, SqlScriptDeleteSqlScriptOptionalParams)	Deletes a Sql Script.
beginRenameSqlScript(string, ArtifactRenameRequest, SqlScriptRenameSqlScriptOptionalParams)	Renames a sqlScript.
beginRenameSqlScriptAndWait(string, ArtifactRenameRequest, SqlScriptRenameSqlScriptOptionalParams)	Renames a sqlScript.
getSqlScript(string, SqlScriptGetSqlScriptOptionalParams)	Gets a sql script.
listSqlScriptsByWorkspace(SqlScriptGetSqlScriptsByWorkspaceOptionalParams)	Lists sql scripts.

Method Details

beginCreateOrUpdateSqlScript(string, SqlScriptResource, SqlScriptCreateOrUpdateSqlScriptOptionalParams)

Creates or updates a Sql Script.

function beginCreateOrUpdateSqlScript(sqlScriptName: string, sqlScript: SqlScriptResource, options?: SqlScriptCreateOrUpdateSqlScriptOptionalParams): Promise<SimplePollerLike<OperationState<SqlScriptResource>, SqlScriptResource>>

Parameters

sqlScriptName

string

The sql script name.

sqlScript

SqlScriptResource

Sql Script resource definition.

options

SqlScriptCreateOrUpdateSqlScriptOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<SqlScriptResource>, SqlScriptResource>>

beginCreateOrUpdateSqlScriptAndWait(string, SqlScriptResource, SqlScriptCreateOrUpdateSqlScriptOptionalParams)

Creates or updates a Sql Script.

function beginCreateOrUpdateSqlScriptAndWait(sqlScriptName: string, sqlScript: SqlScriptResource, options?: SqlScriptCreateOrUpdateSqlScriptOptionalParams): Promise<SqlScriptResource>

Parameters

sqlScriptName

string

The sql script name.

sqlScript

SqlScriptResource

Sql Script resource definition.

options

SqlScriptCreateOrUpdateSqlScriptOptionalParams

The options parameters.

Returns

Promise<SqlScriptResource>

beginDeleteSqlScript(string, SqlScriptDeleteSqlScriptOptionalParams)

Deletes a Sql Script.

function beginDeleteSqlScript(sqlScriptName: string, options?: SqlScriptDeleteSqlScriptOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

sqlScriptName

string

The sql script name.

options

SqlScriptDeleteSqlScriptOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteSqlScriptAndWait(string, SqlScriptDeleteSqlScriptOptionalParams)

Deletes a Sql Script.

function beginDeleteSqlScriptAndWait(sqlScriptName: string, options?: SqlScriptDeleteSqlScriptOptionalParams): Promise<void>

Parameters

sqlScriptName

string

The sql script name.

options

SqlScriptDeleteSqlScriptOptionalParams

The options parameters.

Returns

Promise<void>

beginRenameSqlScript(string, ArtifactRenameRequest, SqlScriptRenameSqlScriptOptionalParams)

Renames a sqlScript.

function beginRenameSqlScript(sqlScriptName: string, request: ArtifactRenameRequest, options?: SqlScriptRenameSqlScriptOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

sqlScriptName

string

The sql script name.

request

ArtifactRenameRequest

proposed new name.

options

SqlScriptRenameSqlScriptOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginRenameSqlScriptAndWait(string, ArtifactRenameRequest, SqlScriptRenameSqlScriptOptionalParams)

Renames a sqlScript.

function beginRenameSqlScriptAndWait(sqlScriptName: string, request: ArtifactRenameRequest, options?: SqlScriptRenameSqlScriptOptionalParams): Promise<void>

Parameters

sqlScriptName

string

The sql script name.

request

ArtifactRenameRequest

proposed new name.

options

SqlScriptRenameSqlScriptOptionalParams

The options parameters.

Returns

Promise<void>

getSqlScript(string, SqlScriptGetSqlScriptOptionalParams)

Gets a sql script.

function getSqlScript(sqlScriptName: string, options?: SqlScriptGetSqlScriptOptionalParams): Promise<SqlScriptResource>

Parameters

sqlScriptName

string

The sql script name.

options

SqlScriptGetSqlScriptOptionalParams

The options parameters.

Returns

Promise<SqlScriptResource>

listSqlScriptsByWorkspace(SqlScriptGetSqlScriptsByWorkspaceOptionalParams)

Lists sql scripts.

function listSqlScriptsByWorkspace(options?: SqlScriptGetSqlScriptsByWorkspaceOptionalParams): PagedAsyncIterableIterator<SqlScriptResource, SqlScriptResource[], PageSettings>

Parameters

options

SqlScriptGetSqlScriptsByWorkspaceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SqlScriptResource, SqlScriptResource[], PageSettings>