sp_addpullsubscription_agent (Transact-SQL)

  • Artículo

Agrega un nuevo trabajo de agente programado utilizado para sincronizar una suscripción de extracción a una publicación transaccional. Este procedimiento almacenado se ejecuta en el suscriptor de la base de datos de suscripciones.

Icono de vínculo a temas Convenciones de sintaxis de Transact-SQL

Sintaxis

sp_addpullsubscription_agent [ @publisher = ] 'publisher'
    [ , [ @publisher_db = ] 'publisher_db' ]
        , [ @publication = ] 'publication'
    [ , [ @subscriber = ] 'subscriber' ]
    [ , [ @subscriber_db = ] 'subscriber_db' ]
    [ , [ @subscriber_security_mode = ] subscriber_security_mode ]
    [ , [ @subscriber_login = ] 'subscriber_login' ]
    [ , [ @subscriber_password = ] 'subscriber_password' ]
    [ , [ @distributor = ] 'distributor' ]
    [ , [ @distribution_db = ] 'distribution_db' ]
    [ , [ @distributor_security_mode = ] distributor_security_mode ]
    [ , [ @distributor_login = ] 'distributor_login' ]
    [ , [ @distributor_password = ] 'distributor_password' ]
    [ , [ @optional_command_line = ] 'optional_command_line' ]
    [ , [ @frequency_type = ] frequency_type ]
    [ , [ @frequency_interval = ] frequency_interval ]
    [ , [ @frequency_relative_interval = ] frequency_relative_interval ]
    [ , [ @frequency_recurrence_factor = ] frequency_recurrence_factor ]
    [ , [ @frequency_subda y= ] 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 ]
    [ , [ @distribution_jobid = ] distribution_jobid OUTPUT ]
    [ , [ @encrypted_distributor_password = ] encrypted_distributor_password ]
    [ , [ @enabled_for_syncmgr = ] 'enabled_for_syncmgr' ]
    [ , [ @ftp_address = ] 'ftp_address' ]
    [ , [ @ftp_port = ] ftp_port ]
    [ , [ @ftp_login = ] 'ftp_login' ]
    [ , [ @ftp_password = ] 'ftp_password' ]
    [ , [ @alt_snapshot_folder = ] 'alternate_snapshot_folder' ]
    [ , [ @working_directory = ] 'working_directory' ]
    [ , [ @use_ftp = ] 'use_ftp' ]
    [ , [ @publication_type = ] publication_type ]
    [ , [ @dts_package_name = ] 'dts_package_name' ]
    [ , [ @dts_package_password = ] 'dts_package_password' ]
    [ , [ @dts_package_location = ] 'dts_package_location' ]
    [ , [ @reserved = ] 'reserved' ]
    [ , [ @offloadagent = ] 'remote_agent_activation' ]
    [ , [ @offloadserver = ] 'remote_agent_server_name']
    [ , [ @job_name = ] 'job_name' ]
    [ , [ @job_login = ] 'job_login' ] 
    [ , [ @job_password = ] 'job_password' ]

Argumentos

  • [ @publisher=] 'publisher'
    Es el nombre del publicador. publisher es de tipo sysname y no tiene ningún valor predeterminado.

  • [ @publisher_db=] **'**publisher_db'
    Es el nombre de la base de datos del publicador. publisher_db es de tipo sysname y su valor predeterminado es NULL. Los publicadores de Oracle omiten publisher_db.

  • [ @publication=] 'publication'
    Es el nombre de la publicación. publication es de tipo sysname y no tiene ningún valor predeterminado.

  • [ @subscriber=] 'subscriber'
    Es el nombre del suscriptor. subscriber es de tipo sysname y su valor predeterminado es NULL.

    [!NOTA]

    Este parámetro ha quedado desusado y solo se mantiene por compatibilidad de scripts con versiones anteriores.

  • [ @subscriber_db=] 'subscriber_db'
    Nombre de la base de datos de suscripciones. subscriber_db es de tipo sysname y su valor predeterminado es NULL.

    [!NOTA]

    Este parámetro ha quedado desusado y solo se mantiene por compatibilidad de scripts con versiones anteriores.

  • [ @subscriber_security_mode=] subscriber_security_mode
    Es el modo de seguridad que se debe utilizar al conectarse con un suscriptor durante la sincronización. subscriber_security_mode es de tipo int, y su valor predeterminado es NULL. 0 especifica Autenticación de SQL Server. 1 especifica Autenticación de Windows.

    [!NOTA]

    Este parámetro ha quedado desusado y solo se mantiene por compatibilidad de scripts con versiones anteriores. El Agente de distribución siempre conecta con el suscriptor local mediante Autenticación de Windows. Si se especifica un valor distinto de NULL o 1 para este parámetro, se devuelve un mensaje de advertencia.

  • [ @subscriber_login =] 'subscriber_login'
    Es el inicio de sesión del suscriptor que se utiliza al conectarse a un suscriptor durante la sincronización. subscriber_login es de tipo sysname y su valor predeterminado es NULL.

    [!NOTA]

    Este parámetro ha quedado desusado y solo se mantiene por compatibilidad de scripts con versiones anteriores. Si se especifica un valor para este parámetro, se devuelve un mensaje de advertencia, pero el valor se pasa por alto.

  • [ @subscriber_password=] 'subscriber_password'
    Es la contraseña del suscriptor. subscriber_password es obligatorio si subscriber_security_mode está establecido en 0. subscriber_password es de tipo sysname y su valor predeterminado es NULL. Si se utiliza una contraseña de suscriptor, se cifra automáticamente.

    [!NOTA]

    Este parámetro ha quedado desusado y solo se mantiene por compatibilidad de scripts con versiones anteriores. Si se especifica un valor para este parámetro, se devuelve un mensaje de advertencia, pero el valor se pasa por alto.

  • [ @distributor=] 'distributor'
    Es el nombre del distribuidor. distributor es de tipo sysname y su valor predeterminado es el valor especificado por publisher.

  • [ @distribution_db=] 'distribution_db'
    Es el nombre de la base de datos de distribución. distribution_db es de tipo sysname y su valor predeterminado es NULL.

  • [ @distributor_security_mode=] distributor_security_mode
    Es el modo de seguridad que se debe utilizar al conectarse con un distribuidor durante la sincronización. distributor_security_mode es de tipo int y su valor predeterminado es 1. 0 especifica Autenticación de SQL Server. 1 especifica Autenticación de Windows.

    Nota de seguridadNota de seguridad

    Siempre que sea posible, utilice la autenticación de Windows.

  • [ @distributor_login=] 'distributor_login'
    Es el inicio de sesión del distribuidor que se debe utilizar al conectarse con un distribuidor durante la sincronización. distributor_login es obligatorio si distributor_security_mode está establecido en 0. distributor_login es de tipo sysname y su valor predeterminado es NULL.

  • [ @distributor_password =] 'distributor_password'
    Es la contraseña del distribuidor. distributor_password es obligatorio si distributor_security_mode está establecido en 0. distributor_password es de tipo sysname y su valor predeterminado es NULL.

    Nota de seguridadNota de seguridad

    No utilice una contraseña en blanco. Utilice una contraseña segura. Cuando sea posible, pida a los usuarios que especifiquen credenciales de seguridad en tiempo de ejecución. Si debe almacenar las credenciales en un archivo de script, proteja el archivo para evitar el acceso no autorizado.

  • [ @optional_command_line=] 'optional_command_line'
    Es un símbolo del sistema opcional proporcionado al Agente de distribución. Por ejemplo, -DefinitionFile C:\Distdef.txt or -CommitBatchSize 10. optional_command_line es de tipo nvarchar(4000) y su valor predeterminado es una cadena vacía.

  • [ @frequency_type=] frequency_type
    Es la frecuencia con que se programa el agente de distribución. frequency_type es int, y puede ser uno de los siguientes valores.

    Valor

    Descripción

    1

    Una vez

    2 (predeterminado)

    A petición

    4

    Diariamente

    8

    Semanalmente

    16

    Mensualmente

    32

    Mensualmente relativa

    64

    Iniciar automáticamente

    128

    Periódica

    [!NOTA]

    Al especificar un valor de 64, el Agente de distribución se ejecuta en modo continuo. Esto equivale a configurar el parámetro -Continuous para el agente. Para obtener más información, vea Agente de distribución de replicación.

  • [ @frequency_interval=] frequency_interval
    Es el valor que se va a aplicar a la frecuencia establecida por frequency_type. frequency_interval es de tipo int y su valor predeterminado es 1.

  • [ @frequency_relative_interval=] frequency_relative_interval
    Es la fecha del Agente de distribución. Este parámetro se utiliza cuando frequency_type se establece en 32 (mensualmente relativa). frequency_relative_interval es int, y puede ser uno de los siguientes valores.

    Valor

    Descripción

    1 (predeterminado)

    Primero

    2

    Segundo

    4

    Tercero

    8

    Cuarto

    16

    Último

  • [ @frequency_recurrence_factor=] frequency_recurrence_factor
    Es el factor de repetición que se utiliza en frequency_type. frequency_recurrence_factor es de tipo int y su valor predeterminado es 1.

  • [ @frequency_subday=] frequency_subday
    Es la frecuencia de repetición de la programación durante el periodo definido. frequency_subday es int, y puede ser uno de los siguientes valores.

    Valor

    Descripción

    1 (predeterminado)

    Una vez

    2

    Segundo

    4

    Minute

    8

    Hour

  • [ @frequency_subday_interval=] frequency_subday_interval
    Es el intervalo de frequency_subday. frequency_subday_interval es de tipo int y su valor predeterminado es 1.

  • [ @active_start_time_of_day=] active_start_time_of_day
    Es la hora del día en que el agente de distribución se programa por primera vez, 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
    Es la hora del día en que el agente de distribución deja de estar programado, 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 que el agente de distribución se programa por primera vez, con el formato AAAAMMDD. active_start_date es de tipo int y su valor predeterminado es 0.

  • [ @active_end_date=] active_end_date
    Es la fecha en la que el agente de distribución deja de estar programado, con el formato AAAAMMDD. active_end_date es de tipo int y su valor predeterminado es 0.

  • [ @distribution_jobid =] distribution_jobidOUTPUT
    Es el identificador del agente de distribución para este trabajo. distribution_jobid es de tipo binary(16), su valor predeterminado es NULL y se trata de un parámetro OUTPUT.

  • [ @encrypted_distributor_password=] encrypted_distributor_password
    Ya no se admite la configuración de encrypted_distributor_password. Si se intenta establecer este parámetro de tipo bit en 1, se producirá un error.

  • [ @enabled_for_syncmgr=] 'enabled_for_syncmgr'
    Indica si la suscripción se puede sincronizar mediante el Administrador de sincronización de Microsoft. enabled_for_syncmgr es de tipo nvarchar(5) y su valor predeterminado es FALSE. Si es false, la suscripción no se registra con el Administrador de sincronización. Si es true, la suscripción se registra con el Administrador de sincronización y se puede sincronizar sin iniciar SQL Server Management Studio.

  • [ @ftp_address=] 'ftp_address'
    Se conserva únicamente por compatibilidad con versiones anteriores.

  • [ @ftp_port=] ftp_port
    Se conserva únicamente por compatibilidad con versiones anteriores.

  • [ @ftp_login=] 'ftp_login'
    Se conserva únicamente por compatibilidad con versiones anteriores.

  • [ @ftp_password=] 'ftp_password'
    Se conserva únicamente por compatibilidad con versiones anteriores.

  • [ @alt_snapshot_folder= ] **'**alternate_snapshot_folder'
    Especifica la ubicación de la carpeta alternativa de la instantánea. alternate_snapshot_folder es de tipo nvarchar(255) y su valor predeterminado es NULL.

  • [ @working_directory= ] 'working_director'
    Es el nombre del directorio de trabajo utilizado para almacenar archivos de datos y de esquema para la publicación. working_directory es de tipo nvarchar(255) y su valor predeterminado es NULL. El nombre se debe especificar en el formato UNC.

  • [ @use_ftp= ] 'use_ftp'
    Especifica que se utilizará FTP en lugar del protocolo regular para recuperar las instantáneas. use_ftp es de tipo nvarchar(5) y su valor predeterminado es FALSE.

  • [ @publication_type= ] publication_type
    Especifica el tipo de replicación de la publicación. publication_type es de tipo tinyint y su valor predeterminado es 0. Si es 0, la publicación es del tipo de transacción. Si es 1, la publicación es del tipo de instantánea. Si es 2, la publicación es del tipo de mezcla.

  • [ @dts_package_name= ] 'dts_package_name'
    Especifica el nombre del paquete DTS. dts_package_name es de tipo sysname y su valor predeterminado es NULL. Por ejemplo, para especificar un paquete de DTSPub_Package, el parámetro sería @dts\_package\_name = N'DTSPub_Package'.

  • [ @dts_package_password= ] 'dts_package_password'
    Especifica la contraseña del paquete, si procede. dts_package_password es de tipo sysname y su valor predeterminado es NULL, lo que significa que el paquete no contiene una contraseña.

    [!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 subscriber. La ubicación del paquete puede ser distributor o subscriber.

  • [ @reserved= ] 'reserved'
    Solamente se identifica con fines informativos. No compatible. La compatibilidad con versiones posteriores no está garantizada.

  • [ @offloadagent= ] 'remote_agent_activation'

    [!NOTA]

    La activación remota del agente ha quedado desusada y ya no es compatible. Este parámetro solamente se admite por compatibilidad de scripts con versiones anteriores. Si se establece remote_agent_activation en un valor distinto de false, se generará un error.

  • [ @offloadserver= ] 'remote_agent_server_name'

    [!NOTA]

    La activación remota del agente ha quedado desusada y ya no es compatible. Este parámetro solamente se admite por compatibilidad de scripts con versiones anteriores. Si se establece remote_agent_server_name en cualquier valor que no sea NULL, se generará un error.

  • [ @job_name= ] 'job_name'
    Es el nombre de un trabajo del agente existente. job_name es de tipo sysname y su valor predeterminado es NULL. Este parámetro solamente se especifica cuando la suscripción se va a sincronizar mediante un trabajo existente en lugar de uno recién creado (el valor predeterminado). Si no es miembro del rol fijo de servidor sysadmin, debe especificar job_login y job_password cuando especifique job_name.

  • [ @job_login= ] 'job_login'
    Es el inicio de sesión de la cuenta de Windows en la que se ejecuta el agente. job_login es de tipo nvarchar(257) y no tiene ningún valor predeterminado. Esta cuenta de Windows siempre se utiliza para las conexiones del agente con el suscriptor.

  • [ @job_password= ] 'job_password'
    Es la contraseña de la cuenta de Windows en la que se ejecuta el agente. job_password es de tipo sysname y no tiene ningún valor predeterminado.

    Nota de seguridadNota de seguridad

    Cuando sea posible, pida a los usuarios que proporcionen credenciales de seguridad en tiempo de ejecución. Si debe almacenar las credenciales en un archivo de script, proteja el archivo para evitar el acceso no autorizado.

Valores de código de retorno

0 (correcto) o 1 (error)

Comentarios

sp_addpullsubscription_agent se utiliza en la replicación de instantáneas y transaccional.

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".

-- Execute this batch at the Subscriber.
DECLARE @publication AS sysname;
DECLARE @publisher AS sysname;
DECLARE @publicationDB AS sysname;
SET @publication = N'AdvWorksProductTran';
SET @publisher = $(PubServer);
SET @publicationDB = N'AdventureWorks2012';

-- At the subscription database, create a pull subscription 
-- to a transactional publication.
USE [AdventureWorks2012Replica]
EXEC sp_addpullsubscription 
  @publisher = @publisher, 
  @publication = @publication, 
  @publisher_db = @publicationDB;

-- Add an agent job to synchronize the pull subscription.
EXEC sp_addpullsubscription_agent 
  @publisher = @publisher, 
  @publisher_db = @publicationDB, 
  @publication = @publication, 
  @distributor = @publisher, 
  @job_login = $(Login), 
  @job_password = $(Password);
GO

Permisos

Solo los miembros del rol fijo de servidor sysadmin o del rol fijo de base de datos db_owner pueden ejecutar sp_addpullsubscription_agent.

Vea también

Referencia

sp_addpullsubscription (Transact-SQL)

sp_change_subscription_properties (Transact-SQL)

sp_droppullsubscription (Transact-SQL)

sp_helppullsubscription (Transact-SQL)

sp_helpsubscription_properties (Transact-SQL)

Conceptos

Crear una suscripción de extracción

Suscribirse a publicaciones