sp_addsubscription (Transact-SQL)

Agrega una suscripción a una publicación y define el estado del suscriptor. Este procedimiento almacenado se ejecuta en el publicador de la base de datos de publicaciones.

Icono de vínculo a temasConvenciones de sintaxis de Transact-SQL

Sintaxis

sp_addsubscription [ @publication = ] 'publication'
    [ , [ @article = ] 'article']
    [ , [ @subscriber = ] 'subscriber' ]
    [ , [ @destination_db = ] 'destination_db' ]
    [ , [ @sync_type = ] 'sync_type' ]
    [ , [ @status = ] 'status'
    [ , [ @subscription_type = ] 'subscription_type' ]
    [ , [ @update_mode = ] 'update_mode' ]
    [ , [ @loopback_detection = ] 'loopback_detection' ]
    [ , [ @frequency_type = ] frequency_type ]
    [ , [ @frequency_interval = ] frequency_interval ]
    [ , [ @frequency_relative_interval = ] frequency_relative_interval ]
    [ , [ @frequency_recurrence_factor = ] frequency_recurrence_factor ]
    [ , [ @frequency_subday = ] frequency_subday ]
    [ , [ @frequency_subday_interval = ] frequency_subday_interval ]
    [ , [ @active_start_time_of_day = ] active_start_time_of_day ]
    [ , [ @active_end_time_of_day = ] active_end_time_of_day ]
    [ , [ @active_start_date = ] active_start_date ]
    [ , [ @active_end_date = ] active_end_date ]
    [ , [ @optional_command_line = ] 'optional_command_line' ]
    [ , [ @reserved = ] 'reserved' ]
    [ , [ @enabled_for_syncmgr= ] 'enabled_for_syncmgr' ]
    [ , [ @offloadagent= ] remote_agent_activation]
    [ , [ @offloadserver= ] 'remote_agent_server_name' ]
    [ , [ @dts_package_name= ] 'dts_package_name' ]
    [ , [ @dts_package_password= ] 'dts_package_password' ]
    [ , [ @dts_package_location= ] 'dts_package_location' ]
    [ , [ @distribution_job_name= ] 'distribution_job_name' ]
    [ , [ @publisher = ] 'publisher' ]
    [ , [ @backupdevicetype = ] 'backupdevicetype' ]
    [ , [ @backupdevicename = ] 'backupdevicename' ]
    [ , [ @mediapassword = ] 'mediapassword' ]
    [ , [ @password = ] 'password' ]
    [ , [ @fileidhint = ] fileidhint ]
    [ , [ @unload = ] unload ]
    [ , [ @subscriptionlsn = ] subscriptionlsn ]
    [ , [ @subscriptionstreams = ] subscriptionstreams ]
    [ , [ @subscriber_type = ] subscriber_type ]

Argumentos

  • [ **@publication=**\] 'publication'
    Es el nombre de la publicación. publication es de tipo sysname y no tiene ningún valor predeterminado.
  • [ **@article=**\] 'article'
    Es el artículo al que se va a suscribir la publicación. article es de tipo sysname y su valor determinado es all. Si el valor es all, se agrega una suscripción a todos los artículos de esa publicación. Los publicadores de Oracle sólo admiten los valores all o NULL.
  • [ **@subscriber=**\] 'subscriber'
    Es el nombre del suscriptor. subscriber es de tipo sysname y su valor predeterminado es NULL.
  • [ **@destination\_db=**\] 'destination_db'
    Es el nombre de la base de datos de destino en la que se guardarán los datos replicados. destination_db es de tipo sysname y su valor predeterminado es NULL. Cuando el valor es NULL, destination_db se establece en el nombre de la base de datos de publicaciones. En los publicadores de Oracle, debe especificarse destination_db. Especifique un valor de (destino predeterminado) para destination_db en un suscriptor que no sea de SQL Server.
  • [ **@sync\_type=**\] 'sync_type'
    Es el tipo de sincronización de la suscripción. sync_type es de tipo nvarchar(255) y puede tener uno de los siguientes valores:

    Valor

  • [ **@status=**\] 'status'
    Es el estado de la suscripción. status es de tipo sysname y su valor predeterminado es NULL. Si este parámetro no se establece de forma explícita, la réplica lo establece automáticamente en uno de estos valores.

    Valor Descripción

    active

    La suscripción está inicializada y lista para aceptar cambios. Esta opción se establece cuando el valor de sync_type es none, initialize with backup o replication support only.

    subscribed

    La suscripción debe inicializarse. Esta opción se establece cuando el valor de sync_type es automatic.

  • [ **@subscription\_type=**\] 'subscription_type'
    Es el tipo de suscripción. subscription_type es de tipo nvarchar(4) y su valor predeterminado es push. Puede ser push o pull. Los Agentes de distribución de suscripciones push residen en el distribuidor y los Agentes de distribución de suscripciones pull residen en el suscriptor. subscription_type puede ser de tipo pull para crear una suscripción de extracción con nombre conocida para el publicador. Para obtener más información, vea Suscribirse a publicaciones.

    [!NOTA] Las suscripciones anónimas no necesitan utilizar este procedimiento almacenado.

  • [ @update\_mode=**\] 'update_mode'
    Es el tipo de actualización
    .
    update_mode es de tipo nvarchar(30) y puede tener uno de estos valores.

    Valor Descripción

    read only (predeterminado)

    La suscripción es de sólo lectura. Los cambios en el suscriptor no se envían al publicador.

    sync tran

    Habilita la compatibilidad con las suscripciones de actualización inmediata. No se admite para los publicadores de Oracle.

    queued tran

    Permite la actualización en cola de la suscripción. Las modificaciones de los datos se realizan en el suscriptor, se almacenan en una cola y después se propagan al publicador. No se admite para los publicadores de Oracle.

    failover

    Permite la actualización inmediata de las suscripciones con la actualización en cola como conmutación por error. Las modificaciones de los datos se pueden realizar en el suscriptor y propagarse inmediatamente al publicador. Si el publicador y el suscriptor no están conectados, el modo de actualización se puede cambiar para que las modificaciones de los datos realizadas en el suscriptor se almacenen en una cola hasta que el suscriptor y el publicador vuelvan a conectarse. No se admite para los publicadores de Oracle.

    queued failover

    Habilita la suscripción como una suscripción de actualización en cola con la capacidad de cambiar al modo de actualización inmediata. Las modificaciones de los datos se pueden realizar en el suscriptor y almacenarse en una cola hasta que se establezca una conexión entre el suscriptor y el publicador. Cuando se establece una conexión continua, el modo de actualización puede cambiar a actualización inmediata. No se admite para los publicadores de Oracle.

    Observe que los valores synctran y queued tran no se permiten si la publicación a la que se está suscribiendo permite DTS.

  • [ **@loopback\_detection=**\] 'loopback_detection'
    Especifica si el Agente de distribución envía transacciones que se originaron en el suscriptor al propio suscriptor. loopback_detection es de tipo nvarchar(5) y puede tener uno de estos valores.

    Valor Descripción

    true

    El Agente de distribución no envía las transacciones originadas en el suscriptor al mismo suscriptor. Se utiliza para configurar la réplica transaccional bidireccional. Para obtener más información, vea Réplica transaccional bidireccional.

    false

    El Agente de distribución envía las transacciones originadas en el suscriptor al mismo suscriptor.

    NULL (predeterminado)

    Se establece automáticamente en true para un suscriptor de SQL Server y en false para un suscriptor que no sea de SQL Server.

  • [ **@frequency\_type=**\] frequency_type
    Es la frecuencia con la que se programa la tarea de distribución. frequency_type es de tipo int y puede ser uno de estos valores.

    Valor Descripción

    1

    Una vez

    2

    A petición

    4

    Diariamente

    8

    Semanalmente

    16

    Mensualmente

    32

    Mensual relativa

    64 (predeterminado)

    Iniciar automáticamente

    128

    Periódica

  • [ **@frequency\_interval=**\] frequency_interval
    Es el valor que frequency_type va a a aplicar a la frecuencia. frequency_interval es de tipo int y su valor predeterminado es NULL.
  • [ **@frequency\_relative\_interval=**\] frequency_relative_interval
    Es la fecha del Agente de distribución. Este parámetro se utiliza cuando frequency_type se ha establecido en 32 (mensual relativa). frequency_relative_interval es de tipo int y puede ser uno de estos valores.

    Valor Descripción

    1

    Primero

    2

    Segundo

    4

    Tercero

    8

    Cuarto

    16

    Último

    NULL (predeterminado)

     

  • [ **@frequency\_recurrence\_factor=**\] frequency_recurrence_factor
    Es el factor de periodicidad utilizado por frequency_type. frequency_recurrence_factor es de tipo int y su valor predeterminado es NULL.
  • [ **@frequency\_subday=**\] frequency_subday
    Es la frecuencia, en minutos, con la que se vuelve a programar durante el período definido. frequency_subday es de tipo int y puede ser uno de estos valores.

    Valor Descripción

    1

    Una vez

    2

    Segundo

    4

    Minuto

    8

    Hora

    NULL

     

  • [ **@frequency\_subday\_interval=**\] frequency_subday_interval
    Es el intervalo de frequency_subday. frequency_subday_interval es de tipo int y su valor predeterminado es NULL.
  • [ **@active\_start\_time\_of\_day=**\] active_start_time_of_day
    Hora del día de la primera programación del Agente de distribución, con el formato HHMMSS. active_start_time_of_day es de tipo int y su valor predeterminado es 0.
  • [ **@active\_end\_time\_of\_day=**\] active_end_time_of_day
    Hora del día en que se detiene la programación del Agente de distribución, con el formato HHMMSS. active_end_time_of_day es de tipo int y su valor predeterminado es 0.
  • [ **@active\_start\_date=**\] active_start_date
    Es la fecha en la que comienza la programación del Agente de distribución, en formato AAAAMMDD. active_start_date es de tipo int y su valor predeterminado es NULL.
  • [ **@active\_end\_date=**\] active_end_date
    Es la fecha en la que se detiene la programación del Agente de distribución, en formato AAAAMMDD. active_end_date es de tipo int y su valor predeterminado es NULL.
  • [ **@optional\_command\_line=**\] 'optional_command_line'
    Es el símbolo del sistema opcional que se va a ejecutar. optional_command_line es de tipo nvarchar(4000) y su valor predeterminado es NULL.
  • [ **@reserved=**\] 'reserved'
    Sólo para uso interno.
  • [ **@enabled\_for\_syncmgr=**\] 'enabled_for_syncmgr'
    Indica si la suscripción se puede sincronizar mediante el Administrador de sincronización de Microsoft Windows. enabled_for_syncmgr es de tipo nvarchar(5) y su valor predeterminado es FALSE. Si el valor es false, la suscripción no se registra con el Administrador de sincronización de Windows. Si el valor es true, la suscripción se registra con el Administrador de sincronización de Windows y se puede sincronizar sin iniciar SQL Server Management Studio. No se admite para los publicadores de Oracle.
  • [ **@offloadagent=** ] 'remote_agent_activation'
    Especifica que es posible activar el agente de forma remota. remote_agent_activation es de tipo bit y su valor predeterminado es 0.

    [!NOTA] Este parámetro ha quedado obsoleto y sólo se mantiene por compatibilidad con versiones anteriores de secuencias de comandos.

  • [ **@offloadserver=** ] 'remote_agent_server_name'
    Especifica el nombre de red del servidor que se va a utilizar para la activación remota. remote_agent_server_namees de tipo sysname y su valor predeterminado es NULL.
  • [ **@dts\_package\_name**= ] 'dts_package_name'
    Especifica el nombre del paquete de Servicios de transformación de datos (DTS). dts_package_name es de tipo sysname y su valor predeterminado es NULL. Por ejemplo, para especificar un paquete DTSPub_Package, el parámetro sería @dts_package_name = N'DTSPub_Package'. Este parámetro está disponible para suscripciones de inserción. Paga agregar información de un paquete DTS a una suscripción de extracción, utilice sp_addpullsubscription_agent.
  • [ **@dts\_package\_password**= ] 'dts_package_password'
    Especifica la contraseña del paquete, si la hay. dts_package_password es de tipo sysname y su valor predeterminado es NULL.

    [!NOTA]    Si se especifica el parámetro dts_package_name, es necesario especificar una contraseña.

  • [ **@dts\_package\_location**= ] 'dts_package_location'
    Especifica la ubicación del paquete. dts_package_location es de tipo nvarchar(12) y su valor predeterminado es DISTRIBUTOR. La ubicación del paquete puede ser distributor o subscriber.
  • [ **@distribution\_job\_name=** ] 'distribution_job_name'
    Sólo para uso interno.
  • [ **@publisher**= ] 'publisher'
    Especifica un publicador que no es de Microsoft SQL Server. publisher es de tipo sysname y su valor predeterminado es NULL.

    [!NOTA] No se debe especificar publisher con un publicador de SQL Server.

  • [ **@backupdevicetype**= ] 'backupdevicetype'
    Especifica el tipo de dispositivo de copia de seguridad que se utiliza al inicializar un suscriptor desde una copia de seguridad. backupdevicetype es de tipo nvarchar(20) y puede tener uno de estos valores:

    Valor Descripción

    logical (predeterminado)

    El dispositivo de copia de seguridad es un dispositivo lógico.

    disk

    El dispositivo de copia de seguridad es una unidad de disco.

    tape

    El dispositivo de copia de seguridad es una unidad de cinta.

    backupdevicetype sólo se utiliza cuando sync_methodestá establecido en initialize_with_backup.

  • [ **@backupdevicename**= ] 'backupdevicename'
    Especifica el nombre del dispositivo que se utiliza al inicializar un suscriptor desde una copia de seguridad. backupdevicename es de tipo nvarchar(1000) y su valor predeterminado es NULL.
  • [ **@mediapassword**= ] 'mediapassword'
    Especifica una contraseña para el conjunto de medios si se estableció una contraseña cuando se dio formato a los medios. mediapassword es de tipo sysname y su valor predeterminado es NULL.
  • [ **@password**= ] 'password'
    Especifica una contraseña para la copia de seguridad si se estableció una contraseña cuando se creó la copia de seguridad. passwordes de tipo sysname y su valor predeterminado es NULL.
  • [ **@fileidhint**= ] fileidhint
    Identifica un valor ordinal del conjunto de copia de seguridad que se va a restaurar. fileidhint es de tipo int y su valor predeterminado es NULL.
  • [ **@unload**= ] unload
    Especifica si se debería descargar un dispositivo de copia de seguridad en cinta cuando finaliza la inicialización desde la copia de seguridad. unload es de tipo bit y su valor predeterminado es 1. 1 especifica que la cinta debe descargarse. unload sólo se utiliza cuando backupdevicetype es tape.
  • [ **@subscriptionlsn**= ] subscriptionlsn
    Sólo para uso interno.
  • [ **@subscriptionstreams=** ] subscriptionstreams
    Es el número de conexiones permitidas por Agente de distribución para aplicar lotes de cambios en paralelo a un suscriptor, aunque manteniendo muchas de las características transaccionales presentes al utilizar un único subproceso. subscriptionstreams es de tipo tinyint y su valor predeterminado es NULL. Se admite un intervalo de valores de 1 a 64. Este parámetro no está permitido para los suscriptores que no sean de SQL Server, los publicadores de Oracle ni las suscripciones de punto a punto.
  • [ **@subscriber\_type=**\] subscriber_type
    Es el tipo de suscriptor. subscriber_type es de tipo tinyint y puede tener unos de estos valores.

    Valor Descripción

    0 (predeterminado)

    Suscriptor de SQL Server

    1

    Servidor del origen de datos ODBC

    2

    Base de datos Microsoft Jet

    3

    Proveedor OLE DB

Notas

sp_addsubscription se utiliza en la réplica de instantáneas y transaccional.

Cuando un miembro de la función fija de servidor sysadmin ejecuta sp_addsubscription para crear una suscripción de inserción, se crea implícitamente el trabajo del Agente de distribución y se ejecuta en la cuenta de servicio del Agente SQL Server. Se recomienda ejecutar sp_addpushsubscription_agent y especificar las credenciales de una cuenta distinta de Windows específica del agente para **@job\_login** y **@job\_password**. Para obtener más información, vea Modelo de seguridad del Agente de réplica.

sp_addsubscription impide que los suscriptores ODBC y OLE DB tengan acceso a publicaciones que:

  • Hayan sido creadas con sync_method nativo en la llamada a sp_addpublication.
  • Contengan artículos que se hayan agregado a la publicación mediante un procedimiento almacenado sp_addarticle con un valor del parámetro pre_creation_cmd de 3 (truncar).
  • Intenten establecer update_mode en sync tran.
  • Tengan un artículo configurado para utilizar instrucciones con parámetros.

Además, si una publicación tiene la opción allow_queued_tran establecida en true (que permite poner en cola los cambios en el suscriptor hasta que se puedan aplicar en el publicador), la columna timestamp de un artículo se automatizará como timestamp y los cambios de esa columna se enviarán al suscriptor. El suscriptor genera y actualiza el valor de la columna timestamp. Para un suscriptor ODBC u OLE DB, sp_addsubscription dará error si se intenta una suscripción a una publicación que tiene allow_queued_tran establecido en true y artículos con columnas timestamp.

Si una suscripción no utiliza un paquete DTS, no puede suscribirse a una publicación que esté establecida en allow_transformable_subscriptions. Si la tabla de la publicación debe replicarse en una suscripción DTS y una suscripción no DTS, deben crearse dos publicaciones independientes: una para cada tipo de suscripción.

Permisos

Sólo los miembros de la función fija de servidor sysadmin o de la función fija de base de datos db_owner pueden ejecutar sp_addsubscription. En las suscripciones de extracción, los usuarios que tengan inicios de sesión en la lista de acceso de la publicación pueden ejecutar sp_addsubscription.

Valores de código de retorno

0 (correcto) o 1 (error)

Ejemplo

-- This script uses sqlcmd scripting variables. They are in the form
-- $(MyVariable). For information about how to use scripting variables  
-- on the command line and in SQL Server Management Studio, see the 
-- "Executing Replication Scripts" section in the topic
-- "Programming Replication Using System Stored Procedures".

DECLARE @publication AS sysname;
DECLARE @subscriber AS sysname;
DECLARE @subscriptionDB AS sysname;
SET @publication = N'AdvWorksProductTran';
SET @subscriber = $(SubServer);
SET @subscriptionDB = N'AdventureWorksReplica';

--Add a push subscription to a transactional publication.
USE [AdventureWorks]
EXEC sp_addsubscription 
  @publication = @publication, 
  @subscriber = @subscriber, 
  @destination_db = @subscriptionDB, 
  @subscription_type = N'push';

--Add an agent job to synchronize the push subscription.
EXEC sp_addpushsubscription_agent 
  @publication = @publication, 
  @subscriber = @subscriber, 
  @subscriber_db = @subscriptionDB, 
  @job_login = $(Login), 
  @job_password = $(Password);
GO

Vea también

Referencia

sp_addpushsubscription_agent (Transact-SQL)
sp_changesubstatus (Transact-SQL)
sp_dropsubscription (Transact-SQL)
sp_helpsubscription (Transact-SQL)
Procedimientos almacenados del sistema (Transact-SQL)

Otros recursos

Cómo crear una suscripción de inserción (programación de la réplica con Transact-SQL)
How to: Create a Subscription for a Non-SQL Server Subscriber (Replication Transact-SQL Programming)
Suscribirse a publicaciones

Ayuda e información

Obtener ayuda sobre SQL Server 2005