sp_helpdistributor (Transact-SQL)

Эта хранимая процедура выводит информацию о распространителе, базе данных распространителя, рабочем каталоге и учетной записи агента Microsoft SQL Server. Она выполняется на издателе для базы данных публикации или любой базы данных.

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

Синтаксис

sp_helpdistributor [ [ @distributor= ] 'distributor' OUTPUT ]
    [ , [ @distribdb= ] 'distribdb' OUTPUT ]
    [ , [ @directory= ] 'directory' OUTPUT ]
    [ , [ @account= ] 'account' OUTPUT ]
    [ , [ @min_distretention= ] min_distretention OUTPUT ]
    [ , [ @max_distretention= ] max_distretention OUTPUT ]
    [ , [ @history_retention= ] history_retention OUTPUT ]
    [ , [ @history_cleanupagent= ] 'history_cleanupagent' OUTPUT ]
    [ , [ @distrib_cleanupagent = ] 'distrib_cleanupagent' OUTPUT ]
    [ , [ @publisher = ] 'publisher' ] 
    [ , [ @local = ] 'local' ]
    [ , [ @rpcsrvname= ] 'rpcsrvname' OUTPUT ]
    [ , [ @publisher_type = ] 'publisher_type' OUTPUT ]

Аргументы

  • [ @distributor=] 'distributor' OUTPUT
    Имя распространителя. Этот аргумент имеет тип sysname и значение по умолчанию %; это единственное значение, при котором возвращается результирующий набор.

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

  • [ @directory=] 'directory' OUTPUT
    Рабочий каталог. Этот аргумент имеет тип nvarchar(255) и значение по умолчанию %; это единственное значение, при котором возвращается результирующий набор.

  • [ @account=] 'account' OUTPUT
    Учетная запись пользователя Microsoft Windows. Этот аргумент имеет тип nvarchar(255) и значение по умолчанию %; это единственное значение, при котором возвращается результирующий набор.

  • [ @min_distretention=] min_distretentionOUTPUT
    Минимальный срок хранения распространения в часах. Этот аргумент имеет тип int и значение по умолчанию -1.

  • [ @max_distretention=] max_distretentionOUTPUT
    Максимальный срок хранения распространения в часах. Этот аргумент имеет тип int и значение по умолчанию -1.

  • [ @history_retention=] history_retentionOUTPUT
    Срок хранения журнала в часах. Этот аргумент имеет тип int и значение по умолчанию -1.

  • [ @history_cleanupagent=] 'history_cleanupagent' OUTPUT
    Имя агента очистки журнала. Этот аргумент имеет тип nvarchar(100) и значение по умолчанию %; это единственное значение, при котором возвращается результирующий набор.

  • [ @distrib_cleanupagent =] 'distrib_cleanupagent' OUTPUT
    Имя агента очистки распространителя. Аргумент distrib_cleanupagent имеет тип nvarchar(100) и значение по умолчанию %, единственным значением, при котором возвращается результирующий набор.

  • [ @publisher=] 'publisher'
    Имя издателя. Этот аргумент имеет тип sysname и значение по умолчанию NULL.

  • [ @local=] 'local'
    Этот аргумент определяет, должен ли SQL Server получать значения локального сервера. Аргумент локальные_значения имеет тип nvarchar(5) и значение по умолчанию NULL.

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

  • [ @publisher_type= ] 'publisher_type' OUTPUT
    Тип издателя. Этот аргумент имеет тип sysname и значение по умолчанию %; это единственное значение, при котором возвращается результирующий набор.

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

Имя столбца

Тип данных

Описание

distributor

sysname

Имя распространителя.

distribution database

sysname

Имя базы данных распространителя.

directory

nvarchar(255)

Имя рабочего каталога.

account

nvarchar(255)

Имя учетной записи пользователя Windows.

min distrib retention

int

Минимальный срок хранения распространения.

max distrib retention

int

Максимальный срок хранения распространения.

history retention

int

Срок хранения журнала.

history cleanup agent

nvarchar(100)

Имя агента очистки журнала.

distribution cleanup agent

nvarchar(100)

Имя агента очистки распространителя.

rpc server name

sysname

Имя удаленного или локального распространителя.

rpc login name

sysname

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

publisher type

sysname

Тип издателя; возможны следующие варианты:

MSSQLSERVER;

ORACLE;

ORACLE GATEWAY.

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

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

Замечания

Хранимая процедура sp_helpdistributor применяется при всех типах репликации.

Если при вызове процедуры sp_helpdistributor указан хотя бы один выходной параметр, при выходе из нее всем выходным параметрам, имевшим значения NULL, присваиваются значения и результирующий набор не возвращается. Если выходных параметров нет, результирующий набор возвращается.

Разрешения

Членам предопределенной роли сервера sysadmin на издателе и предопределенной роли db_owner базы данных публикации возвращаются следующие столбцы результирующего набора или выходные параметры.

Столбец результирующего набора

Выходной параметр

account

@account

min distrib retention

@min_distretention

max distrib retention

@max_distretention

history retention

@history_retention

history cleanup agent

@history_cleanupagent

distribution cleanup agent

@distrib_cleanupagent

rpc login name

нет

Пользователям из списка доступа публикации распространителя возвращается следующий столбец результирующего набора:

  • directory.

Следующие столбцы результирующего набора возвращаются всем пользователям:

Столбец результирующего набора

Выходной параметр

distributor

@distributor

distribution database

@distribdb

rpc server name

@rpcsrvname

publisher type

@publisher_type