sp_helparticle (Transact-SQL)

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

Значок ссылки на раздел Синтаксические обозначения в Transact-SQL

Синтаксис

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

Аргументы

  • [ @publication =] 'publication'
    Имя публикации. Аргумент publication имеет тип sysname и не имеет значения по умолчанию.

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

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

  • [ @publisher= ] 'publisher'
    Задает издателя, отличного от Microsoft SQL Server. Аргумент publisher имеет тип sysname и значение по умолчанию NULL.

    ПримечаниеПримечание

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

  • [ @found= ] found OUTPUT
    Только для внутреннего применения.

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

Имя столбца

Тип данных

Описание

article id

int

Идентификатор статьи.

article name

sysname

Имя статьи.

base object

nvarchar(257)

Имя базовой таблицы, заданной в статье или в хранимой процедуре.

destination object

sysname

Имя целевой таблицы (таблицы подписки).

synchronization object

nvarchar(257)

Имя представления, определяющего опубликованную статью.

тип

smallint

Тип статьи:

1 = Статья на основе журнала;

3 = Статья на основе журнала с ручным фильтром;

5 = Статья на основе журнала с ручным просмотром;

7 = Статья на основе журнала с ручным фильтром и ручным просмотром;

8 = Выполнение хранимой процедуры;

24 = Выполнение сериализуемой хранимой процедуры;

32 = Хранимая процедура (только схема);

64 = Представление (только схема);

128 = Функция (только схема);

status

tinyint

Может являться результатом операции & (Bitwise AND) над одним или более свойством статьи:

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

0x01 = Статья активна;

0x08 = Включить имя столбца в инструкции INSERT;

0x16 = Использовать параметризованные инструкции;

0x32 = Включить имя столбца в операторы INSERT и использовать параметризованные инструкции.

filter

nvarchar(257)

Хранимая процедура, используемая для горизонтальной фильтрации таблиц. Данная хранимая процедура должна быть создана с помощью предложения FOR REPLICATION.

description

nvarchar(255)

Запись с описанием статьи.

insert_command

nvarchar(255)

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

update_command

nvarchar(255)

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

delete_command

nvarchar(255)

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

creation script path

nvarchar(255)

Путь и имя скрипта схемы статьи, используемого для создания целевых таблиц.

vertical partition

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 или параметр auto_identity_range имеет значение true.

identity_range

bigint

Размер диапазона идентификаторов для подписчика в случае, если параметр identityrangemanagementoption статьи имеет значение auto или параметр auto_identity_range имеет значение true.

threshold

bigint

Процентное значение, показывающее момент, когда агент распространителя выделяет новый диапазон идентификаторов.

identityrangemanagementoption

int

Указывает способ управления диапазоном идентификаторов для статьи.

fire_triggers_on_snapshot

bit

Используется в случае, когда реплицированные пользовательские триггеры срабатывают при применении исходного моментального снимка:

1 = Триггеры выполняются;

0 = Триггеры не выполняются.

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

0 (успешное завершение) или 1 (неуспешное завершение)

Замечания

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

Разрешения

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

Пример

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

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

См. также

Справочник

sp_addarticle (Transact-SQL)

sp_articlecolumn (Transact-SQL)

sp_changearticle (Transact-SQL)

sp_droparticle (Transact-SQL)

Хранимые процедуры репликации (Transact-SQL)

Основные понятия

Просмотр и изменение свойств статьи