sp_helparticle (Transact-SQL)

Статья
08/21/2023

Применимо к:SQL Server Управляемый экземпляр SQL Azure

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

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

Синтаксис

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

Аргументы

[ @publication = ] 'publication' Имя публикации. публикация — sysname, без значения по умолчанию.

[ @article = ] 'article' Имя статьи в публикации. статья — sysname с значением по умолчанию %. Если статья не указана, возвращается информация обо всех статьях для указанной публикации.

[ @returnfilter = ] returnfilter Указывает, следует ли возвращать предложение фильтра. значение returnfilter имеет значение по умолчанию 1, которое возвращает предложение фильтра.

[ @publisher = ] 'publisher' Указывает издателя, отличного от Microsoft SQL Server. publisher имеет имя sysname с значением NULL по умолчанию.

Примечание.

издатель не должен указываться при запросе сведений о статье, опубликованной издателем SQL Server.

[ @found = ] found OUTPUT Только внутреннее использование.

Результирующие наборы

Имя столбца	Тип данных	Description
Идентификатор статьи	int	Идентификатор статьи.
имя статьи	sysname	Имя статьи.
базовый объект	nvarchar(257)	Имя базовой таблицы, заданной в статье или в хранимой процедуре.
целевой объект	sysname	Имя целевой таблицы (таблицы подписки).
Объект синхронизации	nvarchar(257)	Имя представления, определяющего опубликованную статью.
type	smallint	Тип статьи: 1 = на основе журналов. 3 = журнал с помощью ручного фильтра. 5 = на основе журналов с помощью ручного представления. 7 = на основе журналов с помощью ручного фильтра и ручного просмотра. 8 = выполнение хранимой процедуры. 24 = сериализуемое выполнение хранимой процедуры. 32 = хранимая процедура (только схема). 64 = вид (только схема). 96 = агрегатная функция (только схема). 128 = функция (только схема). 257 = индексированные представления на основе журналов. 259 = индексированное представление на основе журналов с помощью ручного фильтра. 261 = представление индексированных на основе журналов с помощью ручного представления. 263 = представление индексированных на основе журналов с помощью ручного фильтра и ручного представления. 320 = индексированное представление (только схема).
состояние	tinyint	Может быть результатом и (побитового И) одного или нескольких свойств статьи: 0x00 = определен только для информационных целей. Не поддерживается. Совместимость с будущими версиями не гарантируется. 0x01 = статья активна. 0x08 = включить имя столбца в инструкции insert. 0x16 = использование параметризованных инструкций. 0x32 = используйте параметризованные инструкции и включите имя столбца в инструкции insert.
filter	nvarchar(257)	Хранимая процедура, используемая для горизонтальной фильтрации таблиц. Данная хранимая процедура должна быть создана с помощью предложения FOR REPLICATION.
описание	nvarchar(255)	Описание статьи.
insert_command	nvarchar(255)	Тип команды репликации, используемый при репликационной вставке в статьи таблицы. Дополнительные сведения см. в статье Указание способа распространения изменений для статей транзакций.
update_command	nvarchar(255)	Тип команды репликации, используемый при репликационном обновлении статей таблицы. Дополнительные сведения см. в статье Указание способа распространения изменений для статей транзакций.
delete_command	nvarchar(255)	Тип команды репликации, используемый при репликационном удалении в статьях таблицы. Дополнительные сведения см. в статье Указание способа распространения изменений для статей транзакций.
Путь к скрипту создания	nvarchar(255)	Путь и имя скрипта схемы статьи, используемого для создания целевых таблиц.
вертикальная секция	bit	Указывает, включено ли вертикальное секционирование для статьи; где значение 1 означает, что вертикальное секционирование включено.
pre_creation_cmd	tinyint	Команда, выполняемая перед инструкциями DROP TABLE, DELETE TABLE и TRUNCATE.
filter_clause	ntext	Предложение WHERE задает горизонтальную фильтрацию.
schema_option	binary(8)	Битовая карта параметра создания схемы для заданной статьи. Полный список значений schema_option см. в разделе sp_addarticle (Transact-SQL).
dest_owner	sysname	Имя владельца целевого объекта.
source_owner	sysname	Владелец исходного объекта.
unqua_source_object	sysname	Имя исходного объекта без учета имени его владельца.
sync_object_owner	sysname	Владелец представления, определяющего опубликованную статью. .
unqualified_sync_object	sysname	Имя представления, определяющего опубликованную статью, без учета имени владельца.
filter_owner	sysname	Владелец фильтра.
unqua_filter	sysname	Имя фильтра без учета имени его владельца.
auto_identity_range	int	Флаг, показывающий включение автоматической обработки диапазонов идентификаторов для публикации при ее создании. 1 означает, что включен диапазон автоматических удостоверений; Значение 0 означает, что он отключен.
publisher_identity_range	int	Размер диапазона удостоверений в издателе, если в статье задано значение identityrangemanagementoptionдля автоматического или auto_identity_range задано значение true.
identity_range	bigint	Размер диапазона удостоверений на подписчике, если в статье задано значение identityrangemanagementoptionдля автоматического или auto_identity_range задано значение true.
threshold	bigint	Процентное значение, показывающее момент, когда агент распространителя выделяет новый диапазон идентификаторов.
identityrangemanagementoption	int	Указывает способ управления диапазоном идентификаторов для статьи.
fire_triggers_on_snapshot	bit	Используется в случае, когда реплицированные пользовательские триггеры срабатывают при применении исходного моментального снимка: 1 = выполняются триггеры пользователя. 0 = триггеры пользователя не выполняются.

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

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

Замечания

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

Разрешения

Только члены предопределенных ролей сервера sysadmin , предопределенных ролей базы данных db_owner или список доступа к публикации для текущей публикации может выполняться sp_helparticle.

Пример

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

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

См. также

View and Modify Article Properties (Просмотр и изменение свойств статьи)
sp_addarticle (Transact-SQL)
sp_articlecolumn (Transact-SQL)
sp_changearticle (Transact-SQL)
sp_droparticle (Transact-SQL)
Хранимые процедуры репликации (Transact-SQL)