sys.sp_adddynamicsnapshot_job (Transact-SQL)

gäller för:SQL ServerAzure SQL Managed Instance

Skapar ett agentjobb som genererar en filtrerad datasnapshot för en publikation med parametriserade radfilter. Den här lagrade proceduren körs i Publisher i publikationsdatabasen. Denna lagrade procedur används av en administratör för att manuellt skapa filtrerade datasnapshotjobb för prenumeranter.

Note

För att ett filtrerat datasnapshot-jobb ska kunna skapas måste ett standardsnapshot-jobb för publikationen redan existera.

För mer information, se Skapa en ögonblicksbild för en sammanslagningspublikation med parameteriserade filter.

Transact-SQL syntaxkonventioner

Syntax

sys.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 ]
[ ; ]

Arguments

[ @publication = ] N'publicering'

Namnet på publikationen där det filtrerade datasnapshot-jobbet läggs till. @publication är sysname, utan standard.

[ @suser_sname = ] N'suser_sname'

Värdet som används vid skapandet av en filtrerad datasnapshot för en prenumeration som filtreras av värdet på SUSER_SNAME funktionen hos prenumeranten. @suser_sname är sysname, med standardvärdet .NULL @suser_sname bör vara det NULL om denna funktion inte används för att dynamiskt filtrera publikationen.

[ @host_name = ] N'host_name'

Värdet som används vid skapandet av en filtrerad datasnapshot för en prenumeration filtreras av värdet på HOST_NAME funktionen vid prenumeranten. @host_name är sysname, med standardvärdet .NULL @host_name bör vara det NULL om denna funktion inte används för att dynamiskt filtrera publikationen.

[ @dynamic_snapshot_jobname = ] N'dynamic_snapshot_jobname' OUTPUT

Namnet på det filtrerade datasnapshot-jobbet som skapas. @dynamic_snapshot_jobname är en OUTPUT parameter av typen sysname. Om det anges måste @dynamic_snapshot_jobname ha ett unikt jobb hos distributören. Om det inte specificeras genereras ett jobbnamn automatiskt i resultatuppsättningen, där namnet skapas enligt följande:

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

Note

När du genererar namnet på det dynamiska snapshot-jobbet kan du kapa namnet på det vanliga snapshot-jobbet.

[ @dynamic_snapshot_jobid = ] 'dynamic_snapshot_jobid' UTGÅNG

En identifierare för det filtrerade datasnapshot-jobbet som skapades. @dynamic_snapshot_jobid är en OUTPUT parameter av typen unikidentifier, med standardvärdet .NULL

[ @frequency_type = ] frequency_type

Specificerar hur ofta det filtrerade datasnapshotjobbet schemaliseras. @frequency_type är int, och kan vara ett av dessa värden.

Value Description
1 En gång
2 (standardinställning) På begäran
4 Daglig
8 En gång i veckan
16 Monthly
32 Månadssläkting
64 Automatisk start
128 Återkommande

[ @frequency_interval = ] frequency_interval

Perioden, mätt i dagar, då det filtrerade datasnapshot-jobbet körs. @frequency_interval är int, och beror på värdet av @frequency_type.

Värdet av @frequency_type Effekt på @frequency_interval
1 (standardinställning) @frequency_interval används inte.
4 Var @frequency_interval dag.
8 @frequency_interval är en eller flera av följande (kombinerat med en | (Bitwise OR) Logisk operator):

1 = Söndag
2 = Måndag
4 = Tisdag
8 = Onsdag
16 = Torsdag
32 = Fredag
64 = Lördag
16 På den @frequency_interval dagen i månaden.
32 @frequency_interval är ett av följande alternativ:

1 = Söndag
2 = Måndag
3 = Tisdag
4 = Onsdag
5 = Torsdag
6 = Fredag
7 = Lördag
8 = Dag
9 = Vardag
10 = Helgdag
64 @frequency_interval används inte.
128 @frequency_interval används inte.

[ @frequency_subday = ] frequency_subday

Specificerar enheterna för @frequency_subday_interval. @frequency_subday är int, och kan vara ett av dessa värden.

Value Description
1 (standardinställning) En gång
2 Second
4 Minut
8 Timme

[ @frequency_subday_interval = ] frequency_subday_interval

Antalet @frequency_subday perioder som inträffar mellan varje körning av jobbet. @frequency_subday_interval är int, med standardvärdet .1

[ @frequency_relative_interval = ] frequency_relative_interval

Förekomsten av det filtrerade datasnapshot-jobbet varje månad. Denna parameter används när @frequency_type sätts till 32 (månatlig relativ). @frequency_relative_interval är int, och kan vara ett av dessa värden.

Value Description
1 (standardinställning) First
2 Second
4 Third
8 Fourth
16 Sist

[ @frequency_recurrence_factor = ] frequency_recurrence_factor

Upprepningsfaktorn som används av @frequency_type. @frequency_recurrence_factor är int, med standardvärdet .1

[ @active_start_date = ] active_start_date

Datumet då det filtrerade datasnapshot-jobbet först schemaläggs och formateras som yyyyMMdd. @active_start_date är int, med standardvärdet .0

[ @active_end_date = ] active_end_date

Datumet då det filtrerade datasnapshot-jobbet slutar schemaläggas och formateras som yyyyMMdd. @active_end_date är int, med standardvärdet .0

[ @active_start_time_of_day = ] active_start_time_of_day

Den tid på dygnet då det filtrerade datasnapshot-jobbet först schemaläggs och formateras som HHmmss. @active_start_time_of_day är int, med standardvärdet .0

[ @active_end_time_of_day = ] active_end_time_of_day

Den tid på dagen då det filtrerade datasnapshot-jobbet slutar schemaläggas är formaterat som HHmmss. @active_end_time_of_day är int, med standardvärdet .0

Resultatuppsättning

Kolumnnamn Datatyp Description
id int Identifierar det filtrerade datasnapshot-jobbet i MSdynamicsnapshotjobs-systemtabellen .
dynamic_snapshot_jobname sysname Namnet på det filtrerade datasnapshot-jobbet.
dynamic_snapshot_jobid uniqueidentifier Identifierar unikt SQL Server Agent-jobbet hos distributören.

Returnera kodvärden

0 (lyckades) eller 1 (fel).

Remarks

sp_adddynamicsnapshot_job används vid sammanslagningsreplikering för publikationer som använder ett parameteriserat filter.

Examples

-- 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

Permissions

Endast medlemmar av sysadmin-rollen med fast server eller db_owner fast databasroll kan köra sp_adddynamicsnapshot_job.