sp_addarticle (Transact-SQL)

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

Cria um artigo e adiciona-o a uma publicação. Esse procedimento armazenado é executado no Publicador, no banco de dados publicador.

Convenções de sintaxe de Transact-SQL

Sintaxe

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' ]
[ ; ]

Argumentos

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

O nome da publicação que contém o artigo. O nome deve ser exclusivo no banco de dados. @publication é sysname, sem padrão.

@article [ = ] N'artigo'

O nome do artigo. O nome deve ser exclusivo na publicação. @article é sysname, sem padrão.

@source_table [ = ] N'source_table'

Esse parâmetro foi preterido; em vez disso, use @source_object em vez disso. @source_table é nvarchar(386), com um padrão de NULL. @source_table não é compatível com o Oracle Publishers.

@destination_table [ = ] N'destination_table'

O nome da tabela de destino (assinatura), se diferente de @source_table ou do procedimento armazenado. @destination_table é sysname, com um padrão de NULL. Se definido como NULL, isso significa que @source_table é igual a @destination_table.

@vertical_partition [ = ] N'vertical_partition'

Habilita e desabilita a filtragem de coluna em um artigo de tabela. @vertical_partition é nchar(5), com um padrão de false.

• false indica que não há filtragem vertical e publica todas as colunas.

• true Limpa todas as colunas, exceto a chave primária declarada, colunas anuláveis sem padrão e colunas de chave exclusivas. As colunas são adicionadas usando sp_articlecolumn.

@type [ = ] N'tipo'

O tipo de artigo. @type é sysname, com um padrão de NULL, e pode ser um dos seguintes valores.

@filter [ = ] N'filtro'

O procedimento armazenado (criado com FOR REPLICATION) usado para filtrar a tabela horizontalmente. @filter é nvarchar(386), com um padrão de NULL. Você deve executar sp_articleview e sp_articlefilter manualmente para criar o procedimento armazenado de exibição e filtro. Caso contrário NULL, o procedimento de filtro não é criado (pressupõe que o procedimento armazenado seja criado manualmente).

@sync_object [ = ] N'sync_object'

O nome da tabela ou exibição usada para produzir o arquivo de dados usado para representar o instantâneo deste artigo. @sync_object é nvarchar(386), com um padrão de NULL. Se NULL, sp_articleview for chamado para criar automaticamente a exibição usada para gerar o arquivo de saída. Isso ocorre depois de adicionar quaisquer colunas com sp_articlecolumn. Caso contrário NULL, um modo de exibição não será criado (pressupõe que o modo de exibição seja criado manualmente).

@ins_cmd [ = ] N'ins_cmd'

O tipo de comando de replicação usado ao replicar inserções para este artigo. @ins_cmd é nvarchar(255) e pode ser um dos seguintes valores.

Para obter mais informações, consulte Artigos transacionais - Especificar como as alterações são propagadas.

@del_cmd [ = ] N'del_cmd'

O tipo de comando de replicação usado ao replicar exclusões para este artigo. @del_cmd é nvarchar(255) e pode ser um dos seguintes valores.

Para obter mais informações, consulte Artigos transacionais - Especificar como as alterações são propagadas.

@upd_cmd [ = ] N'upd_cmd'

O tipo de comando de replicação usado ao replicar atualizações para este artigo. @upd_cmd é nvarchar(255) e pode ser um dos seguintes valores.

@creation_script [ = ] N'creation_script'

O caminho e o nome de um script de esquema de artigo opcional usado para criar o artigo no banco de dados de assinatura. @creation_script é nvarchar(255), com um padrão de NULL.

@description [ = ] N'descrição'

Uma entrada descritiva para o artigo. @description é nvarchar(255), com um padrão de NULL.

@pre_creation_cmd [ = ] N'pre_creation_cmd'

Especifica o que o sistema deve fazer se detectar um objeto existente com o mesmo nome no assinante, ao aplicar o instantâneo para esse artigo: @pre_creation_cmd é nvarchar(10) e pode ser um dos seguintes valores.

@filter_clause [ = ] N'filter_clause'

Uma cláusula de restrição (WHERE) que define um filtro horizontal. Ao inserir a cláusula de restrição, omita a palavra-chave WHERE. @filter_clause é nvarchar(max), com um padrão de NULL. Para obter mais informações, consulte Filter Published Data (Filtrar dados publicados).

@schema_option [ = ] schema_option

Uma máscara de bits da opção de geração de esquema para o artigo fornecido. @schema_option é varbinary(8), com um padrão de NULL, e pode ser o | (Bit a bit OU) produto de um ou mais destes valores:

1 Não suportado para editores Oracle.

Nem todos os valores @schema_option são válidos para cada tipo de replicação e tipo de artigo. A tabela Opções de esquema válidas na seção Comentários mostra as opções de esquema válidas que podem ser escolhidas com base na combinação do tipo de artigo e do tipo de replicação.

@destination_owner [ = ] N'destination_owner'

O nome do proprietário do objeto de destino. @destination_owner é sysname, com um padrão de NULL. Quando @destination_owner não é especificado, o proprietário é especificado automaticamente com base nas seguintes regras:

Para oferecer suporte a Assinantes que não sejam do SQL Server, @destination_owner deve ser NULL.

@status [ = ] status

Especifica se o artigo está ativo e opções adicionais sobre como as alterações são propagadas. @status é minúsculo, e pode ser o | (Bit a bit OU) produto de um ou mais desses valores.

Por exemplo, um artigo ativo usando instruções parametrizadas teria um valor de 17 nesta coluna. Um valor de 0 significa que o artigo está inativo e nenhuma propriedade adicional é definida.

@source_owner [ = ] N'source_owner'

O proprietário do objeto de origem. @source_owner é sysname, com um padrão de NULL. @source_owner deve ser especificado para Editores Oracle.

@sync_object_owner [ = ] N'sync_object_owner'

O proprietário do modo de exibição que define o artigo publicado. @sync_object_owner é sysname, com um padrão de NULL.

@filter_owner [ = ] N'filter_owner'

O proprietário do filtro. @filter_owner é sysname, com um padrão de NULL.

@source_object [ = ] N'source_object'

O objeto de banco de dados a ser publicado. @source_object é sysname, com um padrão de NULL. Se @source_table é NULL, @source_object não pode ser NULL. @source_object deve ser usado em vez de @source_table. Para obter mais informações sobre os tipos de objetos que podem ser publicados usando instantâneo ou replicação transacional, consulte Publicar dados e objetos de banco de dados.

@artid [ = ] SAÍDA artid

O ID do artigo do novo artigo. @artid é um parâmetro OUTPUT do tipo int.

@auto_identity_range [ = ] N'auto_identity_range'

Habilita e desabilita o tratamento automático do intervalo de identidades em uma publicação no momento em que ela é criada. @auto_identity_range é nvarchar(5) e pode ser um dos seguintes valores:

@pub_identity_range [ = ] pub_identity_range

Controla o tamanho do intervalo no Publisher se o artigo tiver @identityrangemanagementoption definido como automático ou @auto_identity_range definido como true. @pub_identity_range é bigint, com um padrão de NULL. @pub_identity_range não é compatível com o Oracle Publishers.

@identity_range [ = ] identity_range

Controla o tamanho do intervalo no Assinante se o artigo tiver @identityrangemanagementoption definido como automático ou @auto_identity_range definido como true. @identity_range é bigint, com um padrão de NULL. Usado quando @auto_identity_range é definido como true. @identity_range não é compatível com o Oracle Publishers.

@threshold [ = ] limiar

Valor percentual para controle quando o Distribution Agent atribuir um novo intervalo de identidade. Quando a porcentagem de valores especificada em @threshold é usada, o Agente de Distribuição cria um novo intervalo de identidade. @threshold é int, com um padrão de NULL. Usado quando @identityrangemanagementoption está definido como automático ou @auto_identity_range está definido como true. @threshold não é compatível com o Oracle Publishers.

@force_invalidate_snapshot [ = ] force_invalidate_snapshot

Reconhece que a ação executada por esse procedimento armazenado pode invalidar um snapshot existente. @force_invalidate_snapshot é bit, com um padrão de 0.

• 0 especifica que a adição de um artigo não faz com que o instantâneo seja inválido. Se o procedimento armazenado detectar que a alteração exige um novo instantâneo, ocorrerá um erro e nenhuma alteração será feita.

• 1 Especifica que a adição de um artigo pode fazer com que o snapshot seja inválido e, se existirem assinaturas que exijam um novo snapshot, dá permissão para que o snapshot existente seja marcado como obsoleto e um novo snapshot seja gerado.

@use_default_datatypes [ = ] use_default_datatypes

Se os mapeamentos de tipo de dados de coluna padrão são usados ao publicar um artigo de um Oracle Publisher. @use_default_datatypes é bit, com um padrão de 1.

• 1 = os mapeamentos de coluna de artigo padrão são usados. Os mapeamentos de tipo de dados padrão podem ser exibidos executando sp_getdefaultdatatypemapping.

• 0 = mapeamentos de coluna de artigo personalizados são definidos e, portanto , sp_articleview não é chamado por sp_addarticle.

Quando @use_default_datatypes é definido como 0, você deve executar sp_changearticlecolumndatatype uma vez para cada mapeamento de coluna que está sendo alterado do padrão. Depois que todos os mapeamentos de coluna personalizados tiverem sido definidos, você deverá executá sp_articleview.

@identityrangemanagementoption [ = ] N'identityrangemanagementoption'

Especifica como o gerenciamento de intervalo de identidade é tratado para o artigo. @identityrangemanagementoption é nvarchar(10) e pode ser um dos seguintes valores.

Para compatibilidade com versões anteriores, quando o valor de @identityrangemanagementoption é , o valor de @auto_identity_range é NULLverificado. No entanto, quando o valor de @identityrangemanagementoption não NULLé , o valor de @auto_identity_range é ignorado.

Para obter mais informações, consulte Replicar colunas de identidade.

@publisher [ = ] N'editor'

Especifica um Publicador que não seja do SQL Server. @publisher é sysname, com um padrão de NULL.

@publisher não deve ser usado ao adicionar um artigo a um SQL Server Publisher.

@fire_triggers_on_snapshot [ = ] N'fire_triggers_on_snapshot'

Se os gatilhos de usuário replicados forem executados quando o snapshot inicial for aplicado. @fire_triggers_on_snapshot é nvarchar(5), com um padrão de false. true significa que os disparos do usuário em uma tabela replicada são executados quando o snapshot é aplicado. Para que os gatilhos sejam replicados, o valor bitmask de @schema_option deve incluir o valor 0x100.

Valores do código de retorno

0 (sucesso) ou 1 (falha).

Comentários

sp_addarticle é usado na replicação de snapshot ou replicação transacional.

Por padrão, a replicação não publica nenhuma coluna na tabela de origem quando o tipo de dados de coluna não é suportado pela replicação. Se você precisar publicar essa coluna, deverá executar sp_articlecolumn para adicionar a coluna.

Ao adicionar um artigo a uma publicação que oferece suporte à replicação transacional não hierárquica, as seguintes restrições se aplicam:

• Devem ser especificadas instruções parametrizadas para todos os artigos com base em log. Você deve incluir 16 no @status valor.

• O nome e proprietário da tabela de destino devem corresponder à tabela de origem.

• O artigo não pode ser filtrado horizontal ou verticalmente.

• Não há suporte para o gerenciamento automático do intervalo de identidades. Você deve especificar um valor de manual para @identityrangemanagementoption.

• Se existir uma coluna de carimbo de data/hora na tabela, você deverá incluir 0x08 no @schema_option para replicar a coluna como carimbo de data/hora.

• Um valor de SQL não pode ser especificado para @ins_cmd, @upd_cmd e @del_cmd.

Para obter mais informações, consulte Ponto a ponto - replicação transacional.

Quando você publicar objetos, suas definições são copiadas aos Assinantes. Se você estiver publicando um objeto de banco de dados que depende de um ou mais outros objetos, deverá publicar todos os objetos referenciados. Por exemplo, se você publicar uma exibição que depende de uma tabela, terá de publicar a tabela também.

Se @vertical_partition estiver definido como true, sp_addarticle adiará a criação do modo de exibição até que sp_articleview seja chamado (após o último sp_articlecolumn ser adicionado).

Se a publicação permitir a atualização de assinaturas e a tabela publicada não tiver uma coluna uniqueidentifier, sp_addarticle adicionará uma coluna uniqueidentifier à tabela automaticamente.

Ao replicar para um assinante que não seja uma instância do SQL Server (replicação heterogênea), somente instruções Transact-SQL têm suporte para INSERTcomandos , UPDATEe DELETE .

Quando o Agente de Leitor de Log estiver em execução, adicionar um artigo a uma publicação ponto a ponto poderá causar um deadlock entre o Agente de Leitor de Log e o processo que adiciona o artigo. Para evitar esse problema, antes de adicionar um artigo a uma publicação ponto a ponto, use o Replication Monitor para interromper o agente leitor de log no nó em que você está adicionando o artigo. Reinicie o Agente de Leitor de Log depois de adicionar o artigo.

Ao definir @del_cmd ou NONE@ins_cmd para NONE, a propagação de comandos também pode ser afetada pelo não envio desses UPDATE comandos quando ocorre uma atualização limitada. (Uma atualização limitada é o tipo de UPDATE instrução do editor que replica como um DELETE/INSERT par no assinante.)

Opções de esquema padrão

Esta tabela descreve o valor padrão definido pela replicação se @schema_options não for especificado pelo usuário, em que esse valor depende do tipo de replicação (mostrado na parte superior) e do tipo de artigo (mostrado na primeira coluna).

Opções de esquema válidas

Esta tabela descreve os valores permitidos de @schema_option com base no tipo de replicação (mostrado na parte superior) e no tipo de artigo (mostrado abaixo na primeira coluna).

Exemplos

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

Permissões

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

Conteúdo relacionado

• Defina um Artigo
• 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)
• Procedimentos armazenados de replicação (Transact-SQL)
• Publicar dados e objetos de banco de dados