sp_helparticle (Transact-SQL)

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

Exibe informações sobre um artigo. Esse procedimento armazenado é executado no Publicador, no banco de dados publicador. Para Editores Oracle, esse procedimento armazenado é executado no Distribuidor, em qualquer banco de dados.

Convenções de sintaxe de Transact-SQL

Sintaxe

sp_helparticle
    [ @publication = ] N'publication'
    [ , [ @article = ] N'article' ]
    [ , [ @returnfilter = ] returnfilter ]
    [ , [ @publisher = ] N'publisher' ]
    [ , [ @found = ] found OUTPUT ]
[ ; ]

Argumentos

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

O nome da publicação. @publication é sysname, sem padrão.

@article [ = ] N'artigo'

O nome de um artigo na publicação. @article é sysname, com um padrão de %. Se @article não for fornecido, as informações sobre todos os artigos da publicação especificada serão retornadas.

@returnfilter [ = ] returnfilter

Especifica se a cláusula de filtro deve ser retornada. @returnfilter é bit, com um padrão de , que retorna a cláusula de 1filtro.

@publisher [ = ] N'editor'

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

@publisher não deve ser especificado ao solicitar informações sobre um artigo publicado por um Publicador do SQL Server.

@found [ = ] encontrado SAÍDA

Identificado apenas para fins informativos. Não há suporte. A compatibilidade futura não está garantida.

Conjunto de resultados

Nome da coluna Tipo de dados Descrição
article id int ID do artigo.
article name sysname Nome do artigo.
base object Nvarchar(257) Nome da tabela subjacente representado pelo artigo ou procedimento armazenado.
destination object sysname Nome da tabela de destino (assinatura).
synchronization object Nvarchar(257) Nome da exibição que define o artigo publicado.
type smallint O tipo de artigo:

1 = Baseado em log.
3 = Baseado em log com filtro manual.
5 = Baseado em log com visualização manual.
7 = Baseado em log com filtro manual e visualização manual.
8 = Execução de procedimento armazenado.
24 = Execução de procedimento armazenado serializável.
32 = Procedimento armazenado (somente esquema).
64 = Exibir (somente esquema).
96 = Função agregada (somente esquema).
128 = Função (somente esquema).
257 = Exibição indexada baseada em log.
259 = Exibição indexada baseada em log com filtro manual.
261 = Exibição indexada baseada em log com exibição manual.
263 = Exibição indexada baseada em log com filtro manual e exibição manual.
320 = Exibição indexada (somente esquema).
status tinyint Pode ser o resultado & (E bit a bit) de uma ou mais ou destas propriedades do artigo:

0x00 = Identificado apenas para fins informativos. Não há suporte. A compatibilidade futura não está garantida.
0x01 = O artigo está ativo.
0x08 = Inclua o nome da coluna nas instruções de inserção.
0x16 = Use instruções parametrizadas.
0x32 = Use instruções parametrizadas e inclua o nome da coluna nas instruções de inserção.
filter Nvarchar(257) Procedimento armazenado usado para filtrar a tabela horizontalmente. Esse procedimento armazenado deve ser criado usando a FOR REPLICATION cláusula.
description nvarchar(255) Entrada descritiva para o artigo.
insert_command nvarchar(255) O tipo de comando de replicação usado ao replicar inserções com artigos de tabela. 1
update_command nvarchar(255) O tipo de comando de replicação usado ao replicar atualizações com artigos de tabela. 1
delete_command nvarchar(255) O tipo de comando de replicação usado ao replicar exclusões com artigos de tabela. 1
creation script path nvarchar(255) Caminho e nome de um script de esquema de artigo usados para criar tabelas de destino.
vertical partition bit É se o particionamento vertical está habilitado para o artigo; onde um valor de 1 significa que o particionamento vertical está habilitado.
pre_creation_cmd tinyint Comando de pré-criação para DROP TABLE, DELETE TABLE, ou TRUNCATE TABLE.
filter_clause ntext Cláusula WHERE especificando filtragem horizontal.
schema_option binary(8) Bitmap da opção de geração de esquema para o artigo determinado. Para obter uma lista completa de schema_option valores, consulte sp_addarticle.
dest_owner sysname Nome do proprietário do objeto de destino.
source_owner sysname Proprietário do objeto de origem.
unqua_source_object sysname Nome do objeto de origem, sem o nome do proprietário.
sync_object_owner sysname Proprietário da exibição que define o artigo publicado.
unqualified_sync_object sysname Nome da exibição que define o artigo publicado, sem o nome do proprietário.
filter_owner sysname Proprietário do filtro.
unqua_filter sysname Nome do filtro, sem o nome do proprietário.
auto_identity_range int Sinalizador que indica se o tratamento de um intervalo de identidade automático foi ativado na publicação no momento em que foi criado. 1 significa que o intervalo de identidade automático está habilitado; 0 significa que está desativado.
publisher_identity_range int Tamanho do intervalo do intervalo de identidade no Publicador, se o artigo tiver identityrangemanagementoption sido definido como auto auto_identity_range ou definido como true.
identity_range bigint Tamanho do intervalo do intervalo de identidade no Assinante se o artigo tiver identityrangemanagementoption definido como auto auto_identity_range ou definido como true.
threshold bigint Valor de porcentagem que indica quando o Distribution Agent atribui um novo intervalo de identidade.
identityrangemanagementoption int Indica o gerenciamento de intervalo de identidade tratado para o artigo.
fire_triggers_on_snapshot bit Se os gatilhos de usuário replicados forem executados quando o instantâneo inicial for aplicado.

1 = os gatilhos do usuário são executados.
0 = os gatilhos do usuário não são executados.

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

Valores do código de retorno

0 (sucesso) ou 1 (falha).

Comentários

sp_helparticle é usado na replicação de instantâneo e na replicação transacional.

Permissões

Somente membros da função de servidor fixa sysadmin , da função de banco de dados fixa db_owner ou da lista de acesso à publicação atual podem executar sp_helparticle.

Exemplos

DECLARE @publication AS sysname;
SET @publication = N'AdvWorksProductTran';

USE [AdventureWorks2022]
EXEC sp_helparticle
  @publication = @publication;
GO