sp_addarticle (Transact-SQL)

Область применения: SQL Server Управляемый экземпляр SQL Azure

Создает статью и добавляет ее в публикацию. Эта хранимая процедура выполняется на издателе в базе данных публикации.

Соглашения о синтаксисе Transact-SQL

Синтаксис

sp_addarticle
    [ @publication = ] N'publication'
    , [ @article = ] N'article'
    [ , [ @source_table = ] N'source_table' ]
    [ , [ @destination_table = ] N'destination_table' ]
    [ , [ @vertical_partition = ] N'vertical_partition' ]
    [ , [ @type = ] N'type' ]
    [ , [ @filter = ] N'filter' ]
    [ , [ @sync_object = ] N'sync_object' ]
    [ , [ @ins_cmd = ] N'ins_cmd' ]
    [ , [ @del_cmd = ] N'del_cmd' ]
    [ , [ @upd_cmd = ] N'upd_cmd' ]
    [ , [ @creation_script = ] N'creation_script' ]
    [ , [ @description = ] N'description' ]
    [ , [ @pre_creation_cmd = ] N'pre_creation_cmd' ]
    [ , [ @filter_clause = ] N'filter_clause' ]
    [ , [ @schema_option = ] schema_option ]
    [ , [ @destination_owner = ] N'destination_owner' ]
    [ , [ @status = ] status ]
    [ , [ @source_owner = ] N'source_owner' ]
    [ , [ @sync_object_owner = ] N'sync_object_owner' ]
    [ , [ @filter_owner = ] N'filter_owner' ]
    [ , [ @source_object = ] N'source_object' ]
    [ , [ @artid = ] artid OUTPUT ]
    [ , [ @auto_identity_range = ] N'auto_identity_range' ]
    [ , [ @pub_identity_range = ] pub_identity_range ]
    [ , [ @identity_range = ] identity_range ]
    [ , [ @threshold = ] threshold ]
    [ , [ @force_invalidate_snapshot = ] force_invalidate_snapshot ]
    [ , [ @use_default_datatypes = ] use_default_datatypes ]
    [ , [ @identityrangemanagementoption = ] N'identityrangemanagementoption' ]
    [ , [ @publisher = ] N'publisher' ]
    [ , [ @fire_triggers_on_snapshot = ] N'fire_triggers_on_snapshot' ]
[ ; ]

Аргументы

[ @publication = ] N'publication'

Имя публикации, содержащей статью. В базе данных это имя должно быть уникальным. @publication — sysname без значения по умолчанию.

[ @article = ] N'article'

Имя статьи. Имя должно быть уникальным в пределах публикации. @article — sysname без значения по умолчанию.

[ @source_table = ] N'source_table'

Этот параметр не рекомендуется; вместо этого используйте @source_object . @source_table — nvarchar(386) с значением по умолчаниюNULL. @source_table не поддерживается для издателей Oracle.

[ @destination_table = ] N'destination_table'

Имя целевой таблицы (подписки), если отличается от @source_table или хранимой процедуры. @destination_table — sysname( значение по умолчанию NULL). Если задано значение NULL, это означает, что @source_table равно @destination_table.

[ @vertical_partition = ] N'vertical_partition'

Включает и выключает фильтрацию столбцов в статье таблицы. @vertical_partition — nchar(5) с значением по умолчаниюfalse.

• false указывает, что вертикальная фильтрация отсутствует и публикует все столбцы.

• true очищает все столбцы, кроме объявленного первичного ключа, столбцов, допускающих значение NULL, без значений по умолчанию и уникальных ключевых столбцов. Столбцы добавляются с помощью sp_articlecolumn.

[ @type = ] N'type'

Тип статьи. @type — sysname, значение по умолчанию NULLи может быть одним из следующих значений.

[ @filter = ] N'filter'

Хранимая процедура (созданная с помощью FOR REPLICATION), используемая для горизонтальной фильтрации таблицы. @filter — nvarchar(386) с значением по умолчаниюNULL. Чтобы создать представление и фильтрацию хранимой процедуры, необходимо запустить sp_articleview и sp_articlefilter вручную. Если нет NULL, процедура фильтра не создается (предполагается, что хранимая процедура создается вручную).

[ @sync_object = ] N'sync_object'

Имя таблицы или представления, используемого для создания файла данных, используемого для представления моментального снимка для этой статьи. @sync_object — nvarchar(386) с значением по умолчаниюNULL. Если NULLвызывается sp_articleview для автоматического создания представления, используемого для создания выходного файла. Это происходит после добавления столбцов с sp_articlecolumn. Если нет NULL, представление не создается (предполагается, что представление создается вручную).

[ @ins_cmd = ] N'ins_cmd'

Тип команды репликации, используемый при репликации вставок для этой статьи. @ins_cmd — nvarchar(255) и может быть одним из следующих значений.

Дополнительные сведения см. в статьях о транзакциях. Укажите способ распространения изменений.

[ @del_cmd = ] N'del_cmd'

Тип команды репликации, используемый при репликации удаления для этой статьи. @del_cmd — nvarchar(255) и может быть одним из следующих значений.

Дополнительные сведения см. в статьях о транзакциях. Укажите способ распространения изменений.

[ @upd_cmd = ] N'upd_cmd'

Тип команды репликации, используемый при репликации обновлений для этой статьи. @upd_cmd — nvarchar(255) и может быть одним из следующих значений.

[ @creation_script = ] N'creation_script'

Путь и имя необязательного сценария схемы статьи, используемого для создания статьи в базе данных подписки. @creation_script — nvarchar(255) с значением по умолчаниюNULL.

[ @description = ] N'description'

Описательная запись статьи. @description имеет значение nvarchar(255) с значением по умолчаниюNULL.

[ @pre_creation_cmd = ] N'pre_creation_cmd'

Этот аргумент определяет действия, которые системе следует выполнить, если она обнаружит на стороне подписчика существующий объект с тем же именем, при применении моментального снимка к данной статье. @pre_creation_cmd — nvarchar(10) и может быть одним из следующих значений.

[ @filter_clause = ] N'filter_clause'

Предложение ограничения (WHERE), определяющее горизонтальный фильтр. При вводе предложения ограничения опустите ключевое слово WHERE. @filter_clause — nvarchar(max), с значением по умолчаниюNULL. Дополнительные сведения см. в статье Фильтрация опубликованных данных.

[ @schema_option = ] schema_option

Битовая маска параметра создания схемы для данной статьи. @schema_option является varbinary(8), по умолчанию NULLи может быть | (битовое ИЛИ) продукт одного или нескольких из следующих значений:

¹ Не поддерживается для издателей Oracle.

Не все значения @schema_option допустимы для каждого типа репликации и типа статьи. В таблице "Допустимые параметры схемы" в разделе "Примечания" показаны допустимые параметры схемы, которые можно выбрать на основе сочетания типа статьи и типа репликации.

[ @destination_owner = ] N'destination_owner'

Имя владельца целевого объекта. @destination_owner — sysname с значением по умолчаниюNULL. Если @destination_owner не указан, владелец указывается автоматически на основе следующих правил:

Для поддержки подписчиков, отличных от SQL Server, необходимо @destination_ownerNULL.

[ @status = ] состояние

Указывает, активна ли статья, и позволяет задать дополнительные параметры распространения изменений. @status крошечный, и может быть | (битовое ИЛИ) продукт одного или нескольких из этих значений.

Например, активная статья с параметризованными операторами будет иметь значение 17 в этом столбце. Значение 0 означает, что статья неактивна, а дополнительные свойства не определены.

[ @source_owner = ] N'source_owner'

Владелец исходного объекта. @source_owner — sysname с значением по умолчаниюNULL. @source_owner необходимо указать для издателей Oracle.

[ @sync_object_owner = ] N'sync_object_owner'

Владелец представления, определяющего опубликованную статью. @sync_object_owner имеет имя sysname с значением по умолчаниюNULL.

[ @filter_owner = ] N'filter_owner'

Владелец фильтра. @filter_owner — sysname с значением по умолчаниюNULL.

[ @source_object = ] N'source_object'

Объект базы данных, который будет опубликован. @source_object — sysname с значением по умолчаниюNULL. Если @source_table есть NULL, @source_object не может быть NULL. @source_object следует использовать вместо @source_table. Дополнительные сведения о типах объектов, которые можно опубликовать с помощью моментального снимка или репликации транзакций, см. в разделе "Публикация данных и объектов базы данных".

[ @artid = ] artid OUTPUT

Идентификатор статьи новой статьи. @artid — это параметр OUTPUT типа int.

[ @auto_identity_range = ] N'auto_identity_range'

Включает и отключает автоматическую обработку диапазона удостоверений в публикации во время его создания. @auto_identity_range — nvarchar(5) и может быть одним из следующих значений:

[ @pub_identity_range = ] pub_identity_range

Определяет размер диапазона на издателе, если в статье задано значение auto или @identityrangemanagementoption @auto_identity_range задано значение true. @pub_identity_range является bigint, с значением по умолчаниюNULL. @pub_identity_range не поддерживается для издателей Oracle.

[ @identity_range = ] identity_range

Определяет размер диапазона на подписчике, если в статье задано значение auto или @identityrangemanagementoption @auto_identity_range задано значение true. @identity_range имеет большой размер с значением по умолчаниюNULL. Используется при значении true @auto_identity_range. @identity_range не поддерживается для издателей Oracle.

[ @threshold = ] пороговое значение

Процентное значение, определяющее, когда агентом распространителя выделяется новый диапазон идентификаторов. Если используется процент значений, указанных в @threshold, агент распространения создает новый диапазон удостоверений. @threshold имеет значение int с значением по умолчаниюNULL. Используется, если для @identityrangemanagementoption задано значение auto или @auto_identity_range задано значение true. @threshold не поддерживается для издателей Oracle.

[ @force_invalidate_snapshot = ] force_invalidate_snapshot

Подтверждает, что действие, выполняемое этой хранимой процедурой, может недействительным существующего моментального снимка. @force_invalidate_snapshot бит с значением по умолчанию0.

• 0 указывает, что добавление статьи не приводит к недопустимому моментальному снимку. Если же хранимая процедура определяет, что изменение требует создания нового моментального снимка, возникает ошибка и изменение не выполняется.

• 1 указывает, что добавление статьи может привести к недопустимому моментальному снимку, и если подписки существуют, требующие создания нового моментального снимка, дает разрешение на создание существующего моментального снимка как устаревшего и создания нового моментального снимка.

[ @use_default_datatypes = ] use_default_datatypes

Используются ли сопоставления типов данных столбцов по умолчанию при публикации статьи из издателя Oracle. @use_default_datatypes бит с значением по умолчанию1.

• 1 = используются сопоставления столбцов статей по умолчанию. Сопоставления типов данных по умолчанию можно отобразить, выполнив sp_getdefaultdatatypemapping.

• 0 = настраиваемые сопоставления столбцов статей определены, поэтому sp_articleview не вызывается sp_addarticle.

Если задано 0значение @use_default_datatypes, необходимо выполнить sp_changearticlecolumndatatype один раз для каждого сопоставления столбцов, изменяемого по умолчанию. После определения всех настраиваемых сопоставлений столбцов необходимо выполнить sp_articleview.

[ @identityrangemanagementoption = ] N'identityrangemanagementoption'

Указывает способ управления диапазоном идентификаторов для статьи. @identityrangemanagementoption — nvarchar(10) и может быть одним из следующих значений.

Для обратной совместимости при значении @identityrangemanagementoption проверяется значение @auto_identity_rangeNULL. Однако если значение @identityrangemanagementoption не NULLравно, то значение @auto_identity_range игнорируется.

Дополнительные сведения см. в статье Репликация столбцов идентификаторов.

[ @publisher = ] N'publisher'

Указывает издатель, отличный от SQL Server. @publisher — sysname с значением по умолчаниюNULL.

@publisher не следует использовать при добавлении статьи в издатель SQL Server.

[ @fire_triggers_on_snapshot = ] N'fire_triggers_on_snapshot'

Если реплицированные триггеры пользователя выполняются при применении начального моментального снимка. @fire_triggers_on_snapshot — nvarchar(5) с значением по умолчаниюfalse. true означает, что триггеры пользователя в реплицированной таблице выполняются при применении моментального снимка. Чтобы реплицируемые триггеры реплицировались, значение битовой маски @schema_option должно содержать значение 0x100.

Значения кода возврата

0 (успешно) или 1 (сбой).

Замечания

sp_addarticle используется в репликации моментальных снимков или репликации транзакций.

По умолчанию репликация не публикует столбцы в исходной таблице, если тип данных столбца не поддерживается репликацией. Если необходимо опубликовать такой столбец, необходимо выполнить sp_articlecolumn , чтобы добавить столбец.

При добавлении статьи в публикацию, поддерживающую одноранговую репликацию транзакций, существуют следующие ограничения.

• Для всех статей, создаваемых на основе журналов, должны быть указаны параметризованные инструкции. Необходимо включить 16 в значение @status .

• Имя и владелец целевой таблицы должны соответствовать имени и владельцу исходной таблицы.

• Статью нельзя фильтровать по горизонтали или по вертикали.

• Автоматическое управление диапазонами удостоверений не поддерживается. Необходимо указать значение вручную для @identityrangemanagementoption.

• Если столбец метки времени существует в таблице, необходимо включить 0x08 в @schema_option для репликации столбца в виде метки времени.

• Значение SQL невозможно указать для @ins_cmd, @upd_cmd и @del_cmd.

Дополнительные сведения см. в разделе одноранговая репликация транзакций.

При публикации объектов их определения копируются на подписчики. Если вы публикуете объект базы данных, который зависит от одного или нескольких других объектов, необходимо опубликовать все объекты, на которые ссылается ссылка. Например, при публикации представления, зависящего от таблицы, необходимо также опубликовать и таблицу.

Если @vertical_partition задано значение true, sp_addarticle отложит создание представления до вызова sp_articleview (после последнего sp_articlecolumn).

Если публикация позволяет обновлять подписки и опубликованную таблицу не имеет уникального столбцаidentifier, sp_addarticle добавляет столбец uniqueidentifier в таблицу автоматически.

При репликации на подписчик, который не является экземпляром SQL Server (разнородная репликация), для команд UPDATEи DELETE команд поддерживаются INSERTтолько инструкции Transact-SQL.

Когда агент чтения журнала запущен, добавление статьи к одноранговой публикации может привести к взаимоблокировке между агентом чтения журнала и процессом, который добавляет статью. Чтобы избежать этой проблемы, прежде чем добавлять статью в одноранговую публикацию, используйте монитор репликации для остановки агента чтения журналов на узле, где вы добавляете статью. Перезапустите агент чтения журнала после добавления статьи.

При настройке @del_cmd в NONE или @ins_cmd NONE UPDATE распространение команд также может повлиять на распространение команд, не отправляя эти команды при возникновении ограниченного обновления. (Привязанное обновление является типом UPDATE оператора издателя, который реплицируется в виде DELETE/INSERT пары на подписчике.)

Параметры схемы по умолчанию

В этой таблице описывается значение по умолчанию, заданное репликацией, если @schema_options не указан пользователем, где это значение зависит от типа репликации (показанная в верхней части) и типа статьи (показанная вниз по первому столбцу).

Допустимые параметры схемы

В этой таблице описываются допустимые значения @schema_option на основе типа репликации (показанного в верхней части) и типа статьи (показанного вниз по первому столбцу).

Примеры

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

Разрешения

Могут выполняться только члены предопределенных ролей сервера sysadmin или db_owner предопределенных ролей базы данных.sp_addarticle

Связанный контент

• Определение статьи
• sp_articlecolumn (Transact-SQL)
• sp_articlefilter (Transact-SQL)
• sp_articleview (Transact-SQL)
• sp_changearticle (Transact-SQL)
• sp_droparticle (Transact-SQL)
• sp_helparticle (Transact-SQL)
• sp_helparticlecolumns (Transact-SQL)
• Хранимые процедуры репликации (Transact-SQL)
• Публикация данных и объектов базы данных