sp_helparticle (Transact-SQL)

Se aplica a: SQL Server Azure SQL Instancia administrada

Muestra información acerca de un artículo. Este procedimiento almacenado se ejecuta en el publicador de la base de datos de publicación. En los publicadores de Oracle, este procedimiento almacenado se ejecuta en el distribuidor de cualquier base de datos.

Convenciones de sintaxis de Transact-SQL

Sintaxis

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

Argumentos

[ @publication = ] N'publication'

Nombre de la publicación. @publication es sysname, sin ningún valor predeterminado.

[ @article = ] N'article'

Nombre de un artículo de la publicación. @article es sysname, con un valor predeterminado de %. Si no se proporciona @article , se devuelve información sobre todos los artículos de la publicación especificada.

[ @returnfilter = ] returnfilter

Especifica si se debe devolver la cláusula de filtro. @returnfilter es bit, con un valor predeterminado de 1, que devuelve la cláusula filter.

[ @publisher = ] N'publisher'

Especifica un publicador que no es de SQL Server. @publisher es sysname, con un valor predeterminado de NULL.

@publisher no se debe especificar al solicitar información sobre un artículo publicado por un publicador de SQL Server.

[ @found = ] se encontró OUTPUT

Solamente se identifica con fines informativos. No compatible. La compatibilidad con versiones posteriores no está garantizada.

Conjunto de resultados

Nombre de la columna Tipo de datos Descripción
article id int Identificador del artículo.
article name sysname Nombre del artículo.
base object nvarchar(257) Nombre de la tabla subyacente representada por el artículo o el procedimiento almacenado.
destination object sysname Nombre de la tabla de destino (suscripción).
synchronization object nvarchar(257) Nombre de la vista que define el artículo publicado.
type smallint Tipo de artículo:

1 = Basado en registros.
3 = Basado en registros con filtro manual.
5 = Basado en registros con vista manual.
7 = Basado en registros con filtro manual y vista manual.
8 = Ejecución de procedimientos almacenados.
24 = Ejecución de procedimientos almacenados serializables.
32 = Procedimiento almacenado (solo esquema).
64 = Vista (solo esquema).
96 = Función de agregado (solo esquema).
128 = Función (solo esquema).
257 = Vista indexada basada en registros.
259 = Vista indizada basada en registros con filtro manual.
261 = Vista indizada basada en registros con vista manual.
263 = Vista indizada basada en registros con filtro manual y vista manual.
320 = Vista indizada (solo esquema).
status tinyint Puede ser el resultado y (AND bit a bit) de una o varias propiedades de artículo:

0x00 = Solo se identifica con fines informativos. No compatible. La compatibilidad con versiones posteriores no está garantizada.
0x01 = El artículo está activo.
0x08 = Incluir el nombre de columna en instrucciones insert.
0x16 = Use instrucciones parametrizadas.
0x32 = Use instrucciones parametrizadas e incluya el nombre de columna en instrucciones insert.
filter nvarchar(257) Procedimiento almacenado utilizado para filtrar la tabla horizontalmente. Este procedimiento almacenado debe crearse mediante la FOR REPLICATION cláusula .
description nvarchar(255) Entrada descriptiva del artículo.
insert_command nvarchar(255) El tipo de comando de replicación utilizado al replicar inserciones con artículos de la tabla. 1
update_command nvarchar(255) El tipo de comando de replicación utilizado al replicar actualizaciones con artículos de la tabla. 1
delete_command nvarchar(255) El tipo de comando de replicación utilizado al replicar eliminaciones con artículos de la tabla. 1
creation script path nvarchar(255) Ruta de acceso y nombre de un script de esquema del artículo que se utiliza para crear tablas de destino.
vertical partition bit Es si la creación de particiones verticales está habilitada para el artículo; donde un valor de 1 significa que la creación de particiones verticales está habilitada.
pre_creation_cmd tinyint Comando de precreación para DROP TABLE, DELETE TABLEo TRUNCATE TABLE.
filter_clause ntext Cláusula WHERE que especifica el filtrado horizontal.
schema_option binary(8) Mapa de bits de la opción de generación del esquema para el artículo dado. Para obtener una lista completa de schema_option valores, consulte sp_addarticle.
dest_owner sysname Nombre del propietario del objeto de destino.
source_owner sysname Propietario del objeto de origen.
unqua_source_object sysname Nombre del objeto de origen, sin el nombre del propietario.
sync_object_owner sysname Propietario de la vista que define el artículo publicado
unqualified_sync_object sysname Nombre de la vista que define el artículo publicado, sin el nombre del propietario.
filter_owner sysname Propietario del filtro.
unqua_filter sysname Nombre del filtro, sin el nombre del propietario.
auto_identity_range int Marca que establece si se activó el control automático del intervalo de identidad en la publicación en el momento en que se creó. 1 significa que el intervalo de identidad automático está habilitado; 0 significa que está deshabilitado.
publisher_identity_range int Tamaño de intervalo del intervalo de identidades en el publicador si el artículo ha identityrangemanagementoption establecido en o auto_identity_range establecido en trueauto .
identity_range bigint Tamaño de intervalo del intervalo de identidades en el suscriptor si el artículo ha identityrangemanagementoption establecido en o auto_identity_range establecido en trueauto .
threshold bigint Valor de porcentaje que indica cuándo asigna el Agente de distribución un nuevo intervalo de identidad.
identityrangemanagementoption int Indica la administración de intervalos de identidad controlada del artículo.
fire_triggers_on_snapshot bit Indica si se ejecutan desencadenadores de usuario replicados al aplicar la instantánea inicial.

1 = se ejecutan desencadenadores de usuario.
0 = los desencadenadores de usuario no se ejecutan.

1 Para obtener más información, vea Artículos transaccionales: especificar cómo se propagan los cambios.

Valores de código de retorno

0 (correcto) o 1 (erróneo).

Comentarios

sp_helparticle se usa en la replicación de instantáneas y la replicación transaccional.

Permisos

Solo los miembros del rol fijo de servidor sysadmin , el rol fijo de base de datos db_owner o la lista de acceso a la publicación actual pueden ejecutar sp_helparticle.

Ejemplos

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

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