sp_helparticle (Transact-SQL)sp_helparticle (Transact-SQL)
- Чтение занимает 4 мин
Применимо к:Applies to: 
SQL ServerSQL Server (все поддерживаемые версии) SQL ServerSQL Server (all supported versions) Управляемый экземпляр SQL AzureAzure SQL Managed InstanceУправляемый экземпляр SQL AzureAzure SQL Managed InstanceSQL ServerSQL Server (все поддерживаемые версии) SQL ServerSQL Server (all supported versions) Управляемый экземпляр SQL AzureAzure SQL Managed InstanceУправляемый экземпляр SQL AzureAzure SQL Managed Instance
Отображает сведения о статье.Displays information about an article. Эта хранимая процедура выполняется на издателе в базе данных публикации.This stored procedure is executed at the Publisher on the publication database. Для издателей Oracle данная хранимая процедура выполняется распространителем для любой базы данных.For Oracle Publishers, this stored procedure is executed at the Distributor on any database.
Синтаксические обозначения в Transact-SQL Transact-SQL Syntax Conventions
СинтаксисSyntax
sp_helparticle [ @publication = ] 'publication'
[ , [ @article = ] 'article' ]
[ , [ @returnfilter = ] returnfilter ]
[ , [ @publisher = ] 'publisher' ]
[ , [ @found = ] found OUTPUT ]
АргументыArguments
[ @publication = ] 'publication' Имя публикации.[ @publication = ] 'publication' Is the name of the publication. Аргумент publication имеет тип sysnameи не имеет значения по умолчанию.publication is sysname, with no default.
[ @article = ] 'article' Имя статьи в публикации.[ @article = ] 'article' Is the name of an article in the publication. Аргумент article имеет тип sysnameи значение по умолчанию % .article is sysname, with a default of %. Если статья не указана, возвращаются сведения обо всех статьях для указанной публикации.If article is not supplied, information on all articles for the specified publication is returned.
[ @returnfilter = ] returnfilter Указывает, должно ли возвращаться предложение фильтра.[ @returnfilter = ] returnfilter Specifies whether the filter clause should be returned. ретурнфилтер имеет бити значение по умолчанию 1, которое возвращает предложение фильтра.returnfilter is bit, with a default of 1, which returns the filter clause.
[ @publisher = ] 'publisher' Указывает издателя, отличного от MicrosoftMicrosoft SQL ServerSQL Server .[ @publisher = ] 'publisher' Specifies a non- MicrosoftMicrosoft SQL ServerSQL Server publisher. Аргумент Publisher имеет тип sysnameи значение по умолчанию NULL.publisher is sysname, with a default of NULL.
Примечание
не следует указывать Издатель при запросе сведений о статье, опубликованной SQL ServerSQL Server издателем.publisher should not be specified when requesting information on an article published by a SQL ServerSQL Server Publisher.
[ @found = ] found OUTPUT Только для внутреннего использования.[ @found = ] found OUTPUT Internal use only.
Результирующие наборыResult Sets
| Имя столбцаColumn name | Тип данныхData type | ОписаниеDescription |
|---|---|---|
| Идентификатор статьиarticle id | intint | Идентификатор статьи.ID of the article. |
| article namearticle name | sysnamesysname | Имя статьи.Name of the article. |
| base objectbase object | nvarchar (257)nvarchar(257) | Имя базовой таблицы, заданной в статье или в хранимой процедуре.Name of the underlying table represented by the article or stored procedure. |
| Объект destinationdestination object | sysnamesysname | Имя целевой таблицы (таблицы подписки).Name of the destination (subscription) table. |
| synchronization objectsynchronization object | nvarchar (257)nvarchar(257) | Имя представления, определяющего опубликованную статью.Name of the view that defines the published article. |
| typetype | smallintsmallint | Тип статьи:The type of article: 1 = на основе журнала.1 = Log-based. 3 = журнал на основе журнала с ручным фильтром.3 = Log-based with manual filter. 5 = Журнал основан на представлении, выполняемом вручную.5 = Log-based with manual view. 7 = на основе журнала с ручным фильтром и с ручным просмотром.7 = Log-based with manual filter and manual view. 8 = выполнение хранимой процедуры.8 = Stored procedure execution. 24 = выполнение сериализуемых хранимых процедур.24 = Serializable stored procedure execution. 32 = хранимая процедура (только схема).32 = Stored procedure (schema only). 64 = представление (только схема).64 = View (schema only). 96 = агрегатная функция (только схема).96 = Aggregate function (schema only). 128 = функция (только схема).128 = Function (schema only). 257 = индексированное представление на основе журнала.257 = Log-based indexed view. 259 = индексированное представление на основе журнала с ручным фильтром.259 = Log-based indexed view with manual filter. 261 = индексированное представление на основе журнала с ручным представлением.261 = Log-based indexed view with manual view. 263 = индексированное представление на основе журнала с ручным фильтром и ручным представлением.263 = Log-based indexed view with manual filter and manual view. 320 = индексированное представление (только схема).320 = Indexed view (schema only). |
| statusstatus | tinyinttinyint | Может быть результатом & (побитовое и) для одного или нескольких или следующих свойств статьи:Can be the & (Bitwise AND) result of one or more or these article properties: 0x00 = Указано только в ознакомительных целях.Identified for informational purposes only. Не поддерживается.Not supported. Совместимость с будущими версиями не гарантируется.Future compatibility is not guaranteed.0x00 = Указано только в ознакомительных целях.Identified for informational purposes only. Не поддерживается.Not supported. Совместимость с будущими версиями не гарантируется.Future compatibility is not guaranteed. 0x01 = статья активна.0x01 = Article is active. 0x08 = включить имя столбца в инструкции INSERT.0x08 = Include the column name in insert statements. 0x16 = использовать параметризованные инструкции.0x16 = Use parameterized statements. 0x32 = использовать параметризованные инструкции и включать имя столбца в инструкции INSERT.0x32 = Use parameterized statements and include the column name in insert statements. |
| filterfilter | nvarchar (257)nvarchar(257) | Хранимая процедура, используемая для горизонтальной фильтрации таблиц.Stored procedure used to horizontally filter the table. Данная хранимая процедура должна быть создана с помощью предложения FOR REPLICATION.This stored procedure must have been created using FOR REPLICATION clause. |
| descriptiondescription | nvarchar(255)nvarchar(255) | Описание статьи.Descriptive entry for the article. |
| insert_commandinsert_command | nvarchar(255)nvarchar(255) | Тип команды репликации, используемый при репликационной вставке в статьи таблицы.The replication command type used when replicating inserts with table articles. Дополнительные сведения см. в статье Указание способа распространения изменений для статей транзакций.For more information, see Specify How Changes Are Propagated for Transactional Articles. |
| update_commandupdate_command | nvarchar(255)nvarchar(255) | Тип команды репликации, используемый при репликационном обновлении статей таблицы.The replication command type used when replicating updates with table articles. Дополнительные сведения см. в статье Указание способа распространения изменений для статей транзакций.For more information, see Specify How Changes Are Propagated for Transactional Articles. |
| delete_commanddelete_command | nvarchar(255)nvarchar(255) | Тип команды репликации, используемый при репликационном удалении в статьях таблицы.The replication command type used when replicating deletes with table articles. Дополнительные сведения см. в статье Указание способа распространения изменений для статей транзакций.For more information, see Specify How Changes Are Propagated for Transactional Articles. |
| creation script pathcreation script path | nvarchar(255)nvarchar(255) | Путь и имя скрипта схемы статьи, используемого для создания целевых таблиц.Path and name of an article schema script used to create target tables. |
| vertical partitionvertical partition | bitbit | Указывает, включено ли вертикальное секционирование для статьи; значение 1 означает, что вертикальное секционирование включено.Is whether vertical partitioning is enabled for the article; where a value of 1 means that vertical partitioning is enabled. |
| pre_creation_cmdpre_creation_cmd | tinyinttinyint | Команда, выполняемая перед инструкциями DROP TABLE, DELETE TABLE и TRUNCATE.Precreation command for DROP TABLE, DELETE TABLE, or TRUNCATE TABLE. |
| filter_clausefilter_clause | ntextntext | Предложение WHERE задает горизонтальную фильтрацию.WHERE clause specifying the horizontal filtering. |
| schema_optionschema_option | Binary (8)binary(8) | Битовая карта параметра создания схемы для заданной статьи.Bitmap of the schema generation option for the given article. Полный список значений schema_option см. в разделе sp_addarticle (Transact-SQL).For a complete list of schema_option values, see sp_addarticle (Transact-SQL). |
| dest_ownerdest_owner | sysnamesysname | Имя владельца целевого объекта.Name of the owner of the destination object. |
| source_ownersource_owner | sysnamesysname | Владелец исходного объекта.Owner of the source object. |
| unqua_source_objectunqua_source_object | sysnamesysname | Имя исходного объекта без учета имени его владельца.Name of the source object, without the owner name. |
| sync_object_ownersync_object_owner | sysnamesysname | Владелец представления, определяющего опубликованную статью.Owner of the view that defines the published article. .. |
| unqualified_sync_objectunqualified_sync_object | sysnamesysname | Имя представления, определяющего опубликованную статью, без учета имени владельца.Name of the view that defines the published article, without the owner name. |
| filter_ownerfilter_owner | sysnamesysname | Владелец фильтра.Owner of the filter. |
| unqua_filterunqua_filter | sysnamesysname | Имя фильтра без учета имени его владельца.Name of the filter, without the owner name. |
| auto_identity_rangeauto_identity_range | intint | Флаг, показывающий включение автоматической обработки диапазонов идентификаторов для публикации при ее создании.Flag indicating if automatic identity range handling was turned on at the publication at the time it was created. 1 означает, что автоматический диапазон идентификаторов включен; 0 означает, что она отключена.1 means that automatic identity range is enabled; 0 means it is disabled. |
| publisher_identity_rangepublisher_identity_range | intint | Размер диапазона для диапазона идентификаторов на издателе, если в статье identityrangemanagementoption задано значение Auto или auto_identity_range задано значение true.Range size of the identity range at the Publisher if the article has identityrangemanagementoption set to auto or auto_identity_range set to true. |
| identity_rangeidentity_range | bigintbigint | Размер диапазона для диапазона идентификаторов на подписчике, если в статье identityrangemanagementoption задано значение Auto или auto_identity_range установлен в значение true.Range size of the identity range at the Subscriber if the article has identityrangemanagementoption set to auto or auto_identity_range set to true. |
| thresholdthreshold | bigintbigint | Процентное значение, показывающее момент, когда агент распространителя выделяет новый диапазон идентификаторов.Percentage value indicating when the Distribution Agent assigns a new identity range. |
| identityrangemanagementoptionidentityrangemanagementoption | intint | Указывает способ управления диапазоном идентификаторов для статьи.Indicates the identity range management handled for the article. |
| fire_triggers_on_snapshotfire_triggers_on_snapshot | bitbit | Используется в случае, когда реплицированные пользовательские триггеры срабатывают при применении исходного моментального снимка:Is if replicated user triggers are executed when the initial snapshot is applied. 1 = выполняются пользовательские триггеры.1 = user triggers are executed. 0 = пользовательские триггеры не выполняются.0 = user triggers are not executed. |
Значения кода возвратаReturn Code Values
0 (успешное завершение) или 1 (сбой)0 (success) or 1 (failure)
ПримечанияRemarks
sp_helparticle используется в репликации моментальных снимков и репликации транзакций.sp_helparticle is used in snapshot replication and transactional replication.
РазрешенияPermissions
Только члены предопределенной роли сервера sysadmin , предопределенной роли базы данных db_owner или списка доступа к публикации для текущей публикации могут выполнять sp_helparticle.Only members of the sysadmin fixed server role, the db_owner fixed database role, or the publication access list for the current publication can execute sp_helparticle.
ПримерExample
DECLARE @publication AS sysname;
SET @publication = N'AdvWorksProductTran';
USE [AdventureWorks2012]
EXEC sp_helparticle
@publication = @publication;
GO
См. также:See Also
Просмотр и изменение свойств статьи View and Modify Article Properties
sp_addarticle (Transact-SQL) sp_addarticle (Transact-SQL)
sp_articlecolumn (Transact-SQL) sp_articlecolumn (Transact-SQL)
sp_changearticle (Transact-SQL) sp_changearticle (Transact-SQL)
sp_droparticle (Transact-SQL) sp_droparticle (Transact-SQL)
Хранимые процедуры репликации (Transact-SQL)Replication Stored Procedures (Transact-SQL)