sp_adddynamicsnapshot_job (Transact-SQL)

Aplica-se a: SQL Server Instância Gerenciada de SQL do Azure

Cria um trabalho de agente que gera um instantâneo de dados filtrado para uma publicação com filtros de linha com parâmetros. Esse procedimento armazenado é executado no Publicador, no banco de dados publicador. Esse procedimento armazenado é usado por um administrador para criar trabalhos de instantâneo de dados manualmente filtrados para Assinantes.

Observação

Para que um trabalho de instantâneo de dados filtrados seja criado, um trabalho de instantâneo padrão para a publicação deve existir.

Para obter mais informações, consulte Criar um instantâneo para uma publicação de mesclagem com filtros com parâmetros.

Convenções de sintaxe de Transact-SQL

Sintaxe

sp_adddynamicsnapshot_job
    [ @publication = ] N'publication'
    [ , [ @suser_sname = ] N'suser_sname' ]
    [ , [ @host_name = ] N'host_name' ]
    [ , [ @dynamic_snapshot_jobname = ] N'dynamic_snapshot_jobname' OUTPUT ]
    [ , [ @dynamic_snapshot_jobid = ] 'dynamic_snapshot_jobid' OUTPUT ]
    [ , [ @frequency_type = ] frequency_type ]
    [ , [ @frequency_interval = ] frequency_interval ]
    [ , [ @frequency_subday = ] frequency_subday ]
    [ , [ @frequency_subday_interval = ] frequency_subday_interval ]
    [ , [ @frequency_relative_interval = ] frequency_relative_interval ]
    [ , [ @frequency_recurrence_factor = ] frequency_recurrence_factor ]
    [ , [ @active_start_date = ] active_start_date ]
    [ , [ @active_end_date = ] active_end_date ]
    [ , [ @active_start_time_of_day = ] active_start_time_of_day ]
    [ , [ @active_end_time_of_day = ] active_end_time_of_day ]
[ ; ]

Argumentos

@publication [ = ] N'publicação'

O nome da publicação à qual o trabalho de instantâneo de dados filtrados está sendo adicionado. @publication é sysname, sem padrão.

@suser_sname [ = ] N'suser_sname'

O valor usado ao criar um instantâneo de dados filtrado para uma assinatura que é filtrada pelo valor da função SUSER_SNAME no Assinante. @suser_sname é sysname, com um padrão de NULL. @suser_sname deve ser NULL se essa função não for usada para filtrar dinamicamente a publicação.

@host_name [ = ] N'host_name'

O valor usado ao criar um instantâneo de dados filtrado para uma assinatura que é filtrada pelo valor da função HOST_NAME no Assinante. @host_name é sysname, com um padrão de NULL. host_name deve ser NULL se essa função não for usada para filtrar dinamicamente a publicação.

@dynamic_snapshot_jobname [ = ] SAÍDA N'dynamic_snapshot_jobname'

O nome do trabalho de instantâneo de dados filtrado criado. @dynamic_snapshot_jobname é um parâmetro OUTPUT do tipo sysname. Se especificado, @dynamic_snapshot_jobname deve resolver para um trabalho exclusivo no Distribuidor. Se não for especificado, um nome de tarefa será gerado automaticamente no conjunto de resultados, onde o nome é criado da seguinte maneira:

'dyn_' + <name of the standard snapshot job> + <GUID>

Observação

Ao gerar o nome do trabalho de instantâneo dinâmico, você pode truncar o nome do trabalho de instantâneo padrão.

@dynamic_snapshot_jobid [ = ] 'dynamic_snapshot_jobid' SAÍDA

Um identificador para o trabalho de instantâneo de dados filtrados criado. @dynamic_snapshot_jobid é um parâmetro OUTPUT do tipo uniqueidentifier, com um padrão de NULL.

@frequency_type [ = ] frequency_type

Especifica a frequência com que o trabalho de instantâneo de dados filtrados é agendado. @frequency_type é int e pode ser um desses valores.

Valor Descrição
1 Uma vez
2 (padrão) Sob demanda
4 Diário
8 Semanal
16 Mensal
32 Relativo ao mês
64 Iniciar automaticamente
128 Recorrente

@frequency_interval [ = ] frequency_interval

O período, medido em dias, em que o trabalho de instantâneo de dados filtrados é executado. @frequency_interval é int e depende do valor de @frequency_type.

Valor do @frequency_type Efeito na @frequency_interval
1 (padrão) @frequency_interval não é usado.
4 A cada @frequency_interval dias.
8 @frequency_interval é um ou mais dos seguintes (combinados com um | (OU bit a bit) operador lógico):

1 = Domingo
2 = Segunda-feira
4 = Terça-feira
8 = Quarta-feira
16 = Quinta-feira
32 = Sexta-feira
64 = Sábado
16 No @frequency_interval dia do mês.
32 @frequency_interval é uma das seguintes opções:

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 da semana
10 = Dia de fim de semana
64 @frequency_interval não é usado.
128 @frequency_interval não é usado.

@frequency_subday [ = ] frequency_subday

Especifica as unidades para @frequency_subday_interval. @frequency_subday é int e pode ser um desses valores.

Valor Descrição
1 (padrão) Uma vez
2 Second
4 Minuto
8 Hora

@frequency_subday_interval [ = ] frequency_subday_interval

O número de períodos de frequency_subday que ocorrem entre cada execução do trabalho. @frequency_subday_interval é int, com um padrão de 1.

@frequency_relative_interval [ = ] frequency_relative_interval

A ocorrência do trabalho de instantâneo de dados filtrados em cada mês. Esse parâmetro é usado quando @frequency_type é definido como 32 (relativo mensal). @frequency_relative_interval é int e pode ser um desses valores.

Valor Descrição
1 (padrão) Primeiro
2 Segundo
4 Terceiro
8 Quarto
16 Last

@frequency_recurrence_factor [ = ] frequency_recurrence_factor

O fator de recorrência usado por frequency_type. @frequency_recurrence_factor é int, com um padrão de 1.

@active_start_date [ = ] active_start_date

A data em que o trabalho de instantâneo de dados filtrado é agendado pela primeira vez, formatado como yyyyMMdd. @active_start_date é int, com um padrão de 0.

@active_end_date [ = ] active_end_date

A data em que o trabalho de instantâneo de dados filtrado deixa de ser agendado, formatado como yyyyMMdd. @active_end_date é int, com um padrão de 0.

@active_start_time_of_day [ = ] active_start_time_of_day

A hora do dia em que o trabalho de instantâneo de dados filtrado é agendado pela primeira vez, formatado como HHmmss. @active_start_time_of_day é int, com um padrão de 0.

@active_end_time_of_day [ = ] active_end_time_of_day

A hora do dia em que o trabalho de instantâneo de dados filtrado deixa de ser agendado, formatado como HHmmss. @active_end_time_of_day é int, com um padrão de 0.

Conjunto de resultados

Nome da coluna Tipo de dados Descrição
id int Identifica o trabalho de instantâneo de dados filtrados na tabela do sistema MSdynamicsnapshotjobs .
dynamic_snapshot_jobname sysname Nome do trabalho de instantâneo de dados filtrado.
dynamic_snapshot_jobid uniqueidentifier Identifica exclusivamente o trabalho do SQL Server Agent no Distribuidor.

Valores do código de retorno

0 (sucesso) ou 1 (falha).

Comentários

sp_adddynamicsnapshot_job é usado na replicação de mesclagem para publicações que usam um filtro com parâmetros.

Exemplos

-- To avoid storing the login and password in the script file, the value 
-- is passed into SQLCMD as a scripting variable. For information about 
-- how to use scripting variables on the command line and in SQL Server
-- Management Studio, see the "Executing Replication Scripts" section in
-- the topic "Programming Replication Using System Stored Procedures".

--Add a new merge publication.
DECLARE @publicationdb AS sysname;
DECLARE @publication AS sysname;
DECLARE @table1 AS sysname;
DECLARE @table2 AS sysname;
DECLARE @filter AS sysname;
DECLARE @schema_hr AS sysname;
DECLARE @schema_sales AS sysname;

SET @publicationdb = N'AdventureWorks2022';
SET @publication = N'AdvWorksSalesPersonMerge';
SET @table1 = N'Employee';
SET @table2 = N'SalesPerson';
SET @filter = N'SalesPerson_Employee';
SET @schema_hr = N'HumanResources';
SET @schema_sales = N'Sales';

USE [AdventureWorks2022];

-- Enable AdventureWorks2022 for merge replication.
EXEC sp_replicationdboption
  @dbname = @publicationdb,
  @optname = N'merge publish',
  @value = N'true';  

-- Create new merge publication.  
EXEC sp_addmergepublication 
  @publication = @publication, 
  @description = N'Merge publication of AdventureWorks2022.', 
  @allow_subscriber_initiated_snapshot = N'false';

-- Create a new snapshot job for the publication, using the 
-- default schedule. Pass credentials at runtime using 
-- sqlcmd scripting variables.
EXEC sp_addpublication_snapshot 
  @publication = @publication, 
  @job_login = $(Login), 
  @job_password = $(password);

-- Add an article for the Employee table, 
-- which is horizontally partitioned using 
-- a parameterized row filter.
EXEC sp_addmergearticle 
  @publication = @publication, 
  @article = @table1, 
  @source_owner = @schema_hr, 
  @source_object = @table1, 
  @type = N'table', 
  @description = 'contains employee information', 
  @subset_filterclause = N'[LoginID] = HOST_NAME()';

-- Add an article for the SalesPerson table, 
-- which is partitioned based on a join filter.
EXEC sp_addmergearticle 
  @publication = @publication, 
  @article = @table2, 
  @source_owner = @schema_sales, 
  @source_object = @table2, 
  @type = N'table', 
  @description = 'contains customer information';

-- Add a join filter between the two articles.
EXEC sp_addmergefilter 
  @publication = @publication, 
  @article = @table1, 
  @filtername = @filter, 
  @join_articlename = @table2, 
  @join_filterclause = N'[Employee].[BusinessEntityID] = [SalesPerson].[SalesPersonID]', 
  @join_unique_key = 1, 
  @filter_type = 1;
GO

-- Start the snapshot agent job.
DECLARE @publication AS sysname;
SET @publication = N'AdvWorksSalesPersonMerge';

EXEC sp_startpublication_snapshot 
  @publication = @publication;
GO

PRINT '*** Waiting for the initial snapshot.';
GO

-- Create a temporary table to store the filtered data snapshot 
-- job information.
CREATE TABLE #temp (id int,
    job_name sysname,
    job_id uniqueidentifier,
    dynamic_filter_login sysname NULL,
    dynamic_filter_hostname sysname NULL,
    dynamic_snapshot_location nvarchar(255),
    frequency_type int, 
    frequency_interval int, 
    frequency_subday_type int,
    frequency_subday_interval int, 
    frequency_relative_interval int, 
    frequency_recurrence_factor int, 
    active_start_date int, 
    active_end_date int, 
    active_start_time int, 
    active_end_time int
)

-- Create each snapshot for a partition 
-- The initial snapshot must already be generated.
DECLARE @publication AS sysname;
DECLARE @jobname AS sysname
DECLARE @hostname AS sysname
SET @publication = N'AdvWorksSalesPersonMerge';
SET @hostname = N'adventure-works\Fernando';

WHILE NOT EXISTS(SELECT * FROM sysmergepublications 
    WHERE [name] = @publication 
    AND snapshot_ready = 1)
BEGIN
    WAITFOR DELAY '00:00:05'
END

-- Create a data partition by overriding HOST_NAME().
EXEC sp_addmergepartition 
  @publication = @publication,
  @host_name = @hostname;

-- Create the filtered data snapshot job, and use the returned 
-- information to start the job.
EXEC sp_adddynamicsnapshot_job 
  @publication = @publication,
  @host_name = @hostname;

INSERT INTO #temp (id, job_name, job_id, dynamic_filter_login,
    dynamic_filter_hostname, dynamic_snapshot_location,
    frequency_type,	frequency_interval, frequency_subday_type,
    frequency_subday_interval, frequency_relative_interval, 
    frequency_recurrence_factor, active_start_date,	active_end_date, 
    active_start_time,active_end_time)
EXEC sp_helpdynamicsnapshot_job;

SELECT @jobname = (SELECT DISTINCT job_name FROM #temp WHERE dynamic_filter_hostname = @hostname);

EXEC msdb..sp_start_job @job_name = @jobname;
DROP TABLE #temp;
GO

Permissões

Somente membros da função de servidor fixa sysadmin ou da função de banco de dados fixa db_owner podem executar sp_adddynamicsnapshot_jobo .