sp_helparticle (Transact-SQL)

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

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

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

Синтаксис

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

Аргументы

[ @publication = ] N'publication'

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

[ @article = ] N'article'

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

[ @returnfilter = ] returnfilter

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

[ @publisher = ] N'publisher'

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

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

[ @found = ] найден выходные данные

Указано только в ознакомительных целях. Не поддерживается. Совместимость с будущими версиями не гарантируется.

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

Имя столбца Тип данных Description
article id int Идентификатор статьи.
article name sysname Имя статьи.
base object nvarchar(257) Имя базовой таблицы, заданной в статье или в хранимой процедуре.
destination object sysname Имя целевой таблицы (таблицы подписки).
synchronization object nvarchar(257) Имя представления, определяющего опубликованную статью.
type smallint Тип статьи:

1 = на основе журналов.
3 = журнал с помощью ручного фильтра.
5 = журнал с помощью ручного представления.
7 = журнал на основе журналов с помощью ручного фильтра и ручного представления.
8 = выполнение хранимой процедуры.
24 = сериализуемое выполнение хранимой процедуры.
32 = хранимая процедура (только схема).
64 = представление (только схема).
96 = агрегатная функция (только схема).
128 = функция (только схема).
257 = индексированное представление на основе журнала.
259 = индексированное представление на основе журнала с помощью ручного фильтра.
261 = индексированные представления на основе журналов с помощью ручного представления.
263 = индексированное представление на основе журналов с помощью ручного фильтра и ручного представления.
320 = индексированное представление (только схема).
status tinyint Может быть результатом и (побитового И) одного или нескольких свойств статьи:

0x00 = определяется только для информационных целей. Не поддерживается. Совместимость с будущими версиями не гарантируется.
0x01 = статья активна.
0x08 = включить имя столбца в инструкции insert.
0x16 = используйте параметризованные операторы.
0x32 = используйте параметризованные инструкции и включите имя столбца в инструкции insert.
filter nvarchar(257) Хранимая процедура, используемая для горизонтальной фильтрации таблиц. Эта хранимая процедура должна быть создана с помощью FOR REPLICATION предложения.
description nvarchar(255) Описание статьи.
insert_command nvarchar(255) Тип команды репликации, используемый при репликационной вставке в статьи таблицы. 1
update_command nvarchar(255) Тип команды репликации, используемый при репликационном обновлении статей таблицы. 1
delete_command nvarchar(255) Тип команды репликации, используемый при репликационном удалении в статьях таблицы. 1
creation script path nvarchar(255) Путь и имя скрипта схемы статьи, используемого для создания целевых таблиц.
vertical partition bit Указывает, включено ли вертикальное секционирование для статьи; где значение 1 означает, что вертикальное секционирование включено.
pre_creation_cmd tinyint Команда предварительного создания для DROP TABLE, DELETE TABLEили TRUNCATE TABLE.
filter_clause ntext Предложение WHERE задает горизонтальную фильтрацию.
schema_option binary(8) Битовая карта параметра создания схемы для заданной статьи. Полный список значений schema_option см. в sp_addarticle.
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 Размер диапазона удостоверений на издателе, если в статье задано auto identityrangemanagementoption значение или auto_identity_range задано значение true.
identity_range bigint Размер диапазона удостоверений на подписчике, если в статье задано auto identityrangemanagementoption значение или auto_identity_range задано значение true.
threshold bigint Процентное значение, показывающее момент, когда агент распространителя выделяет новый диапазон идентификаторов.
identityrangemanagementoption int Указывает способ управления диапазоном идентификаторов для статьи.
fire_triggers_on_snapshot bit Используется в случае, когда реплицированные пользовательские триггеры срабатывают при применении исходного моментального снимка:

1 = выполняются триггеры пользователей.
0 = триггеры пользователя не выполняются.

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

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

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

Замечания

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

Разрешения

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

Примеры

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

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