sp_update_jobstep (Transact-SQL)

  • 项目

适用于：SQL ServerAzure SQL 托管实例

更改用于在SQL Server 代理服务中执行自动化活动的作业中的步骤的设置。

Transact-SQL 语法约定

语法

sp_update_jobstep
    [ [ @job_id = ] 'job_id' ]
    [ , [ @job_name = ] N'job_name' ]
    , [ @step_id = ] step_id
    [ , [ @step_name = ] N'step_name' ]
    [ , [ @subsystem = ] N'subsystem' ]
    [ , [ @command = ] N'command' ]
    [ , [ @additional_parameters = ] N'additional_parameters' ]
    [ , [ @cmdexec_success_code = ] cmdexec_success_code ]
    [ , [ @on_success_action = ] on_success_action ]
    [ , [ @on_success_step_id = ] on_success_step_id ]
    [ , [ @on_fail_action = ] on_fail_action ]
    [ , [ @on_fail_step_id = ] on_fail_step_id ]
    [ , [ @server = ] N'server' ]
    [ , [ @database_name = ] N'database_name' ]
    [ , [ @database_user_name = ] N'database_user_name' ]
    [ , [ @retry_attempts = ] retry_attempts ]
    [ , [ @retry_interval = ] retry_interval ]
    [ , [ @os_run_priority = ] os_run_priority ]
    [ , [ @output_file_name = ] N'output_file_name' ]
    [ , [ @flags = ] flags ]
    [ , [ @proxy_id = ] proxy_id ]
    [ , [ @proxy_name = ] N'proxy_name' ]
[ ; ]

参数

[ @job_id = ] 'job_id'

步骤所属的作业的标识号。 @job_id是 uniqueidentifier，默认值为 NULL.

必须指定@job_id或@job_name，但不能指定这两者。

[ @job_name = ] N'job_name'

步骤所属的作业的名称。 @job_name为 sysname，默认值为 NULL.

必须指定@job_id或@job_name，但不能指定这两者。

[ @step_id = ] step_id

要修改的作业步骤的标识号。 @step_id为 int，无默认值。 无法更改此数字。

[ @step_name = ] N'step_name'

步骤的新名称。 @step_name为 sysname，默认值为 NULL.

[ @subsystem = ] N'subsystem'

SQL Server 代理用于执行@command的子系统。 @subsystem为 nvarchar（40），默认值为 NULL.

[ @command = ] N'command'

要通过 @subsystem执行的命令。 @command为 nvarchar（max），默认值为 NULL.

[ @additional_parameters = ] N'additional_parameters'

标识为仅供参考。 不支持。 不保证以后的兼容性。

[ @cmdexec_success_code = ] cmdexec_success_code

CmdExec 子系统命令返回的值，指示该命令已成功执行。 @cmdexec_success_code为 int，默认值为 NULL.

[ @on_success_action = ] on_success_action

步骤成功时执行的操作。 @on_success_action 是 tinyint，默认值 NULL为 ，可以是这些值之一。

值 说明（操作）
1 成功退出
2 失败后退出
3 转到下一步
4 转到步骤 @on_success_step_id

[ @on_success_step_id = ] on_success_step_id

此作业中要执行的步骤的标识号（如果步骤成功且@on_success_action）。4 @on_success_step_id为 int，默认值为 NULL.

[ @on_fail_action = ] on_fail_action

步骤失败时执行的操作。 @on_fail_action是 tinyint，可以有这些值之一。

值 说明（操作）
1 成功退出
2 失败后退出
3 转到下一步
4 转到步骤 @on_fail_step_id

[ @on_fail_step_id = ] on_fail_step_id

如果步骤失败并且@on_fail_action为4，则此作业中要执行的步骤的标识号。 @on_fail_step_id为 int，默认值为 NULL.

[ @server = ] N'server'

标识为仅供参考。 不支持。 不保证以后的兼容性。

[ @database_name = ] N'database_name'

要在其中执行 Transact-SQL 步骤的数据库的名称。 @database_name为 sysname，默认值为 NULL. 不允许括在括号 （[]） 中的名称。

[ @database_user_name = ] N'database_user_name'

执行 Transact-SQL 步骤时要使用的数据库用户的名称。 @database_user_name为 sysname，默认值为 NULL.

[ @retry_attempts = ] retry_attempts

该步骤失败时要进行的重试次数。 @retry_attempts为 int，默认值为 NULL.

[ @retry_interval = ] retry_interval

两次重试之间的间隔时间（分钟）。 @retry_interval为 int，默认值为 NULL.

[ @os_run_priority = ] os_run_priority

标识为仅供参考。 不支持。 不保证以后的兼容性。

[ @output_file_name = ] N'output_file_name'

用于保存该步骤输出的文件的名称。 @output_file_name为 nvarchar（200），默认值为 NULL. 此参数仅在 Transact-SQL 或 CmdExec 子系统中运行的命令有效。

若要将@output_file_name设置回NULL，必须将@output_file_name设置为空字符串或空白字符字符串，但不能使用该CHAR(32)函数。

例如，按如下所示将此参数设置为空字符串：

@output_file_name = ' '

[ @flags = ] 标志

控制行为的选项。 @flags为 int，默认值为 NULL.

值 说明
0（默认值） 覆盖输出文件
2 追加到输出文件
4 将 Transact-SQL 作业步骤输出写入步骤历史记录
8 将日志写入表（覆盖现有的历史记录）
16 将日志写入表（追加到现有的历史记录）

[ @proxy_id = ] proxy_id

作业步骤作为代理运行时，代理的 ID 号。 @proxy_id为 int，默认值为 NULL. 如果未指定@proxy_id，则未指定@proxy_name，并且未指定@database_user_name，则作业步骤将作为SQL Server 代理的服务帐户运行。

[ @proxy_name = ] N'proxy_name'

作业步骤作为代理运行时，代理的名称。 @proxy_name为 sysname，默认值为 NULL. 如果未指定@proxy_id，则未指定@proxy_name，并且未指定@database_user_name，则作业步骤将作为SQL Server 代理的服务帐户运行。

返回代码值

0（成功）或 1（失败）。

注解

sp_update_jobstep 必须从 msdb 数据库运行。

更新作业步骤将增加作业的版本号。

此存储过程与用于Azure SQL 数据库的 Azure 弹性作业服务的类似对象共享名称sp_update_jobstep。 有关弹性作业版本的信息，请参阅jobs.sp_update_jobstep（Azure 弹性作业）（Transact-SQL）。

权限

此存储过程由 db_owner 角色拥有。 你可以为任何用户授予 EXECUTE 权限，但这些权限可能会在 SQL Server 升级期间被重写。

其他用户必须被授予数据库中以下SQL Server 代理固定数据库角色msdb之一：

  • SQLAgentUserRole
  • SQLAgentReaderRole
  • SQLAgentOperatorRole

有关这些角色的权限的详细信息，请参阅 SQL Server 代理固定数据库角色。

只有 sysadmin 的成员才能更新其他用户拥有的作业的作业步骤。

如果作业步骤需要访问代理，则该作业步骤的创建者必须拥有对该作业步骤的代理的访问权限。 除 Transact-SQL 之外的所有子系统都需要一个代理帐户。 sysadmin 的成员有权访问所有代理，并且可以使用代理的SQL Server 代理服务帐户。

示例

下面的示例更改 Weekly Sales Data Backup 作业的第一步的重试次数。 运行此示例后，重试次数为 10。

USE msdb;
GO

EXEC dbo.sp_update_jobstep
    @job_name = N'Weekly Sales Data Backup',
    @step_id = 1,
    @retry_attempts = 10;
GO

相关内容