sp_articleview (Transact-SQL)
Creates the view that defines the published article when a table is filtered vertically or horizontally. This view is used as the filtered source of the schema and data for the destination tables. Only unsubscribed articles can be modified by this stored procedure. This stored procedure is executed at the Publisher on the publication database.
.gif "Topic link icon")
Syntax
sp_articleview [ @publication = ] 'publication'
, [ @article = ] 'article'
[ , [ @view_name = ] 'view_name']
[ , [ @filter_clause = ] 'filter_clause']
[ , [ @change_active = ] change_active ]
[ , [ @force_invalidate_snapshot = ] force_invalidate_snapshot ]
[ , [ @force_reinit_subscription = ] force_reinit_subscription ]
[ , [ @publisher = ] 'publisher' ]
[ , [ @refreshsynctranprocs = ] refreshsynctranprocs ]
[ , [ @internal = ] internal ]
Arguments
[ @publication=] 'publication'
Is the name of the publication that contains the article. publication is sysname, with no default.[ @article=] 'article'
Is the name of the article. article is sysname, with no default.[ @view_name=] 'view_name'
Is the name of the view that defines the published article. view_name is nvarchar(386), with a default of NULL.[ @filter_clause=] 'filter_clause'
Is a restriction (WHERE) clause that defines a horizontal filter. When entering the restriction clause, omit the WHERE keyword. filter_clause is ntext, with a default of NULL.[ @change_active = ] change_active
Allows modifying the columns in publications that have subscriptions. change_active is an int, with a default of 0. If 0, columns are not changed. If 1, views can be created or re-created on active articles that have subscriptions.[ @force_invalidate_snapshot = ] force_invalidate_snapshot
Acknowledges that the action taken by this stored procedure may invalidate an existing snapshot. force_invalidate_snapshot is a bit, with a default of 0.0 specifies that changes to the article do not cause the snapshot to be invalid. If the stored procedure detects that the change does require a new snapshot, an error occurs and no changes are made.
1 specifies that changes to the article may cause the snapshot to be invalid, and if there are existing subscriptions that would require a new snapshot, gives permission for the existing snapshot to be marked as obsolete and a new snapshot generated.
[ @force_reinit_subscription = ] force_reinit_subscription
Acknowledges that the action taken by this stored procedure may require existing subscriptions to be reinitialized. force_reinit_subscription is a bit with a default of 0.0 specifies that changes to the article do not cause the subscription to be reinitialized. If the stored procedure detects that the change would require subscriptions to be reinitialized, an error occurs and no changes are made.
1 specifies that changes to the article causes existing subscription to be reinitialized, and gives permission for the subscription reinitialization to occur.
[ @publisher= ] 'publisher'
Specifies a non-Microsoft SQL Server publisher. publisher is sysname, with a default of NULL.Note
publisher should not be used when publishing from a SQL Server Publisher.
[ @refreshsynctranprocs = ] refreshsynctranprocs
Is if the stored procedures used to synchronize replication are automatically recreated. refreshsynctranprocs is bit, with a default of 1.1 means that the stored procedures are re-created.
0 means that the stored procedures are not re-created.
[ @internal= ] internal
Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.
Return Code Values
0 (success) or 1 (failure)
Remarks
sp_articleview creates the view that defines the published article and inserts the ID of this view in the sync_objid column of the sysarticles (Transact-SQL) table, and inserts the text of the restriction clause in the filter_clause column. If all columns are replicated and there is no filter_clause, the sync_objid in the sysarticles (Transact-SQL) table is set to the ID of the base table, and the use of sp_articleview is not required.
To publish a vertically filtered table (that is, to filter columns) first run sp_addarticle with no sync_object parameter, run sp_articlecolumn (Transact-SQL) once for each column to be replicated (defining the vertical filter), and then run sp_articleview to create the view that defines the published article.
To publish a horizontally filtered table (that is, to filter rows), run sp_addarticle (Transact-SQL) with no filter parameter. Run sp_articlefilter (Transact-SQL), providing all parameters including filter_clause. Then run sp_articleview, providing all parameters including the identical filter_clause.
To publish a vertically and horizontally filtered table, run sp_addarticle (Transact-SQL) with no sync_object or filter parameters. Run sp_articlecolumn (Transact-SQL) once for each column to be replicated, and then run sp_articlefilter (Transact-SQL) and sp_articleview.
If the article already has a view that defines the published article, sp_articleview drops the existing view and creates a new one automatically. If the view was created manually (type in sysarticles (Transact-SQL) is 5), the existing view is not dropped.
If you create a custom filter stored procedure and a view that defines the published article manually, do not run sp_articleview. Instead, provide these as the filter and sync_object parameters to sp_addarticle (Transact-SQL), along with the appropriate type value.
Example
DECLARE @publication AS sysname;
DECLARE @table AS sysname;
DECLARE @filterclause AS nvarchar(500);
DECLARE @filtername AS nvarchar(386);
DECLARE @schemaowner AS sysname;
SET @publication = N'AdvWorksProductTran';
SET @table = N'Product';
SET @filterclause = N'[DiscontinuedDate] IS NULL';
SET @filtername = N'filter_out_discontinued';
SET @schemaowner = N'Production';
-- Add a horizontally and vertically filtered article for the Product table.
-- Manually set @schema_option to ensure that the Production schema
-- is generated at the Subscriber (0x8000000).
EXEC sp_addarticle
@publication = @publication,
@article = @table,
@source_object = @table,
@source_owner = @schemaowner,
@schema_option = 0x80030F3,
@vertical_partition = N'true',
@type = N'logbased',
@filter_clause = @filterclause;
-- (Optional) Manually call the stored procedure to create the
-- horizontal filtering stored procedure. Since the type is
-- 'logbased', this stored procedures is executed automatically.
EXEC sp_articlefilter
@publication = @publication,
@article = @table,
@filter_clause = @filterclause,
@filter_name = @filtername;
-- Add all columns to the article.
EXEC sp_articlecolumn
@publication = @publication,
@article = @table;
-- Remove the DaysToManufacture column from the article
EXEC sp_articlecolumn
@publication = @publication,
@article = @table,
@column = N'DaysToManufacture',
@operation = N'drop';
-- (Optional) Manually call the stored procedure to create the
-- vertical filtering view. Since the type is 'logbased',
-- this stored procedures is executed automatically.
EXEC sp_articleview
@publication = @publication,
@article = @table,
@filter_clause = @filterclause;
GO
Permissions
Only members of the sysadmin fixed server role or db_owner fixed database role can execute sp_articleview.
See Also