sp_add_jobschedule (Transact-SQL)

Cria uma agenda para um trabalho.

Ícone de vínculo de tópicoConvenções de sintaxe Transact-SQL

Sintaxe

sp_add_jobschedule [ @job_id = ] job_id, | [ @job_name = ] 'job_name', [ @name = ] 'name'
     [ , [ @enabled = ] enabled_flag ]
     [ , [ @freq_type = ] frequency_type ]
     [ , [ @freq_interval = ] frequency_interval ]
     [ , [ @freq_subday_type = ] frequency_subday_type ]
     [ , [ @freq_subday_interval = ] frequency_subday_interval ]
     [ , [ @freq_relative_interval = ] frequency_relative_interval ]
     [ , [ @freq_recurrence_factor = ] frequency_recurrence_factor ]
     [ , [ @active_start_date = ] active_start_date ]
     [ , [ @active_end_date = ] active_end_date ]
     [ , [ @active_start_time = ] active_start_time ]
     [ , [ @active_end_time = ] active_end_time ]
     [ , [ @schedule_id = ] schedule_id OUTPUT ]

Argumentos

  • [ @job_id= ] job_id
    Número de identificação do trabalho ao qual a agenda é adicionada. job_id é uniqueidentifier, sem padrão.

  • [ @job_name= ] 'job_name'
    Nome do trabalho para o qual a agenda será adicionada. job_name é nvarchar(128), sem padrão.

    ObservaçãoObservação

    É necessário especificar job_id ou job_name, mas não é possível especificar ambos ao mesmo tempo.

  • [ @name= ] 'name'
    Nome da agenda. name é nvarchar(128), sem padrão.

  • [ @enabled= ] enabled_flag
    Indica o estado atual da agenda. enabled_flag é tinyint, sendo que o padrão é 1 (habilitado). Se 0, a agenda não está habilitada. Se a agenda estiver desabilitada, o trabalho não será executado.

  • [ @freq_type= ] frequency_type
    Valor que indica se o trabalho deve ser executado. frequency_type é int, sendo que o padrão é 0 e pode ser um destes valores:

    Valor

    Descrição

    1

    Uma vez

    4

    Diariamente

    8

    Semanalmente

    16

    Mensalmente

    32

    Mensalmente, relativo ao frequency_interval.

    64

    Executar ao iniciar o serviço do Agente do SQL Server.

    128

    Executar quando o computador estiver ocioso.

  • [ @freq_interval= ] frequency_interval
    Dia em que o trabalho é executado. frequency_interval é int, sendo que o padrão é 0 e depende do valor de frequency_type, conforme indicado na tabela a seguir:

    Valor

    Efeito

    1 (uma vez)

    frequency_interval não é usado.

    4 (diariamente)

    Todos os dias do frequency_interval.

    8 (semanalmente).

    frequency_interval é um ou mais dos seguintes (combinado com um operador lógico OR):

    1 = Domingo

    2 = Segunda-feira

    4 = Terça-feira

    8 = Quarta-feira

    16 = Quinta-feira

    32 = Sexta-feira

    64 = Sábado

    16 (mensalmente)

    No dia do mês do frequency_interval.

    32 (mensal relativo)

    frequency_interval é um dos seguintes:

    1 = Domingo

    2 = Segunda-feira

    3 = Terça-feira

    4 = Quarta-feira

    5 = Quinta-feira

    6 = Sexta-feira

    7 = Sábado

    8 = Dia

    9 = Dia útil

    10 = Dia do fim de semana

    64 (ao iniciar o serviço do Agente do SQL Server)

    frequency_interval não é usado.

    128

    frequency_interval não é usado.

  • [ @freq_subday_type= ] frequency_subday_type
    Especifica as unidades do frequency_subday_interval. frequency_subday_type é int, sem padrão, e pode ser um destes valores:

    Valor

    Descrição (unidade)

    0x1

    Na hora especificada

    0x4

    Minutos

    0x8

    Horas

  • [ @freq_subday_interval= ] frequency_subday_interval
    Número de períodos de frequency_subday_type que devem ocorrer entre cada execução do trabalho. frequency_subday_interval é int, sendo que o padrão é 0.

  • [ @freq_relative_interval= ] frequency_relative_interval
    Define ainda mais o frequency_interval se frequency_type for definido como 32 (mensal relativo).

    frequency_relative_interval é int, sem padrão, e pode ser um destes valores:

    Valor

    Descrição (unidade)

    1

    First

    2

    Segundo

    4

    Terceiro

    8

    Quarto

    16

    Last

    frequency_relative_interval indica a ocorrência do intervalo. Por exemplo, se frequency_relative_interval for definido como 2, frequency_type for definido como 32 e frequency_interval como 3, o trabalho programado deve ocorrer na segunda terça-feira de cada mês.

  • [ @freq_recurrence_factor= ] frequency_recurrence_factor
    Número de semanas ou meses entre a execução agendada do trabalho. frequency_recurrence_factor será usado somente se frequency_type for definido como 8, 16 ou 32. frequency_recurrence_factor é int, com o padrão de 0.

  • [ @active_start_date= ] active_start_date
    Data de início da execução do trabalho. active_start_date é int, sem padrão. A data é formatada como DDMMAAAA. Se active_start_date estiver definido, a data deverá ser maior ou igual a 01011990.

    Depois que a agenda estiver criada, reveja a data de início e confirme se essa é a data correta. Para obter mais informações, consulte a seção "Agendando datas de início" em Criando e anexando agendas a trabalhos.

  • [ @active_end_date= ] active_end_date
    Data na qual a execução do trabalho pode parar. active_end_date é int, sem padrão. A data é formatada como DDMMAAAA.

  • [ @active_start_time= ] active_start_time
    Hora em qualquer dia entre active_start_date e active_end_date para começar execução do trabalho. active_start_time é int, sem padrão. A hora é formatada como HHMMSS em um relógio de 24 horas.

  • [ **@active_end_time=**active_end_time
    Hora em qualquer dia entre active_start_date e active_end_date para encerrar a execução do trabalho. active_end_time é int, sem padrão. A hora é formatada como HHMMSS em um relógio de 24 horas.

  • [ @schedule_id=schedule_idOUTPUT
    Número de identificação de agenda atribuído à agenda se ela for criada com sucesso. schedule_id é uma variável de saída do tipo int, sem padrão.

  • [ @schedule_uid= ] schedule_uidOUTPUT
    Um identificador exclusivo da agenda. schedule_uid é uma variável do tipo uniqueidentifier.

Valores de código de retorno

0 (êxito) ou 1 (falha)

Conjuntos de resultados

Nenhum

Comentários

As agendas de trabalho podem ser gerenciadas independentemente dos trabalhos. Para adicionar uma agenda para um trabalho, use sp_add_schedule para criá-la e sp_attach_schedule para anexá-la a um trabalho.

Permissões

Por padrão, os membros da função de servidor fixa sysadmin podem executar este procedimento armazenado. Deve ser concedida a outros usuários uma das seguintes funções de banco de dados fixas do SQL Server Agent no banco de dados msdb:

  • SQLAgentUserRole

  • SQLAgentReaderRole

  • SQLAgentOperatorRole

Para obter detalhes sobre as permissões dessas funções, consulte Funções de banco de dados fixas do SQL Server Agent.