SQL Server Agent-taken mislukt als de taak taakstappen bevat die tokens gebruiken na de installatie van SQL Server 2005 Service Pack 1


Bug #: 426808 (SQLBUDT)

Symptomen


Nadat u Microsoft SQL Server 2005 Service Pack 1 (SP1) hebt geïnstalleerd, doet u het volgende:
  • Taken van SQL Server Agent mislukken wanneer de taken taakstappen bevatten die tokens gebruiken.
  • Het volgende foutbericht wordt weergegeven:
    De taakstap bevat een of meer tokens. Voor SQL Server 2005 Service Pack 1 of hogere versies moeten alle taakstappen met tokens worden bijgewerkt met een macro voordat de taak kan worden uitgevoerd.
Opmerking Dit probleem doet zich voor in Build 2046 of nieuwere versies van SQL Server 2005.

Oorzaak


In SQL Server 2005 SP1 is de syntaxis van de SQL Server-taakstap token gewijzigd. Vervolgens moet u een Escape-macro opnemen met alle tokens die worden gebruikt in taakstappen. Als u geen Escape-macro opneemt, kunnen de volgende taakstappen niet worden uitgevoerd. De volgende tabel bevat de Escape-macro's.
Escape-macroBeschrijving
$(ESCAPE_SQUOTE(TokenName))Deze macro escaped apostroffen (') in de vervangende tekenreeks van het token. De macro vervangt één apostrof door twee apostroffen.
$(ESCAPE_DQUOTE(TokenName))Deze macro Escapet aanhalingstekens (") in de vervangende tekenreeks van het token. De macro vervangt één aanhalingsteken door twee aanhalingstekens.
$(ESCAPE_RBRACKET(TokenName))In deze macro wordt de vierkante haken (]) in de vervangende tekenreeks van het token escaped. De macro vervangt een vierkante haak sluiten met twee vierkante haken.
$ (ESCAPE_NONE (tokennaam))De macro vervangt een token zonder escapetekens in de tekenreeks. Deze macro wordt geboden om compatibiliteit met eerdere versies te ondersteunen in omgevingen waarbij tokens die worden vervangen, alleen worden verwacht van vertrouwde gebruikers.
Een taakstap kan bijvoorbeeld de volgende Transact-SQL-instructie bevatten die het token -Dbn gebruikt:
CREATE DATABASE [$(A-DBN)]
In dit voorbeeld moet u de syntaxis van tokens bijwerken naar de volgende syntaxis:
CREATE DATABASE [$(ESCAPE_RBRACKET(A-DBN))]
Deze wijziging is van invloed op het eerdere gedrag van SQL Server 2005, waarbij geen Escape-macro's zijn vereist.

Oplossing


Als u dit probleem wilt oplossen, moet u alle of alleen bepaalde taken met tokens aan de nieuwe token syntaxis bijwerken. U kunt dit doen met behulp van de opgeslagen procedure sp_AddEscapeNoneToJobStepTokens . U kunt deze opgeslagen procedure maken met behulp van het volgende Transact-SQL-script.Opmerking Zorg ervoor dat u de versie van SQL Server 2005 SP1 installeert en de versie 2046 of hoger maakt. Daarnaast moet u lid zijn van de vaste serverrol sysadmin om het script uit te voeren.
      -- This script is used to automatically edit SQL Agent job steps so that-- unescaped tokens are prefaced with the ESCAPE_NONE syntax that was added in-- SQL Server 2005 SP1.if (@@microsoftversion < 0x90007FE)BEGIN    RAISERROR('This script should only be run on at least SQL Server 2005 SP1.', 20, 127) WITH LOG    returnENDuse msdbgoif exists (select * from sys.objects where name = N'fn_PrefaceTokensWithEscapeNone' and type = 'FN')    drop function fn_PrefaceTokensWithEscapeNonego-- This function manipulates @commands so that all bare tokens-- are prefaced with ESCAPE_NONE.create function fn_PrefaceTokensWithEscapeNone(@commands nvarchar(max)) RETURNS nvarchar(max)ASBEGIN    if (@commands IS NULL)    BEGIN        return @commands    END    -- In order to let this script run under SQLCMD mode, we define    -- the special "$(" variable start string by concatenation so that    -- sqlcmd mode does not think that we are defining one of its variables.    declare @strVariableStart nchar(2)    select @strVariableStart = N'$' + N'('    declare @idxTokenStart int    select @idxTokenStart = CHARINDEX(@strVariableStart, @commands)    while (@idxTokenStart != 0 and @idxTokenStart is not null)    BEGIN        declare @idxCloseParen int        select @idxCloseParen = CHARINDEX(N')', SUBSTRING(@commands, @idxTokenStart, LEN(@commands)))        -- Error checking. If there is no close parenthesis, return.        if (0 = @idxCloseParen)        BEGIN            return @commands        END        -- Deduce the token variable.        declare @tokenLen int        select @tokenLen = @idxCloseParen - LEN(@strVariableStart) - 1        declare @token nvarchar(max)        select @token = SUBSTRING(@commands, @idxTokenStart + LEN(@strVariableStart), @tokenLen)        -- Verify if @token contains a mis-matched number of open and        -- close parens. This behavior could happen if invalid syntax is        -- in a comment block. If so, skip to the next token.        declare @idx int        declare @cOpenParens int        declare @cCloseParens int        select @cOpenParens = 0        select @idx = CHARINDEX(N'(', @token);        while (@idx != 0)        BEGIN            select @cOpenParens = @cOpenParens + 1            select @idx = CHARINDEX(N'(', @token, @idx + 1);        END        select @cCloseParens = 0        select @idx = CHARINDEX(N')', @token);        while (@idx != 0)        BEGIN            select @cCloseParens = @cCloseParens + 1            select @idx = CHARINDEX(N')', @token, @idx + 1);        END        -- Special case for the WMI token.        if (N'WMI(' = SUBSTRING(@token, 1, LEN(N'WMI(')))        BEGIN                select @cOpenParens = @cOpenParens - 1        END        if ((@cOpenParens = @cCloseParens) and            (N'ESCAPE_NONE(' != SUBSTRING(@token, 1, LEN(N'ESCAPE_NONE('))) and            (N'ESCAPE_SQUOTE(' != SUBSTRING(@token, 1, LEN(N'ESCAPE_SQUOTE('))) and            (N'ESCAPE_DQUOTE(' != SUBSTRING(@token, 1, LEN(N'ESCAPE_DQUOTE('))) and            (N'ESCAPE_RBRACKET(' != SUBSTRING(@token, 1, LEN(N'ESCAPE_RBRACKET('))))        BEGIN            select @commands = STUFF(@commands, @idxTokenStart + LEN(@strVariableStart), @tokenLen, N'ESCAPE_NONE(' + @token + N')')        END        select @idxTokenStart = CHARINDEX(@strVariableStart, @commands, @idxTokenStart + 1)    END    return @commandsENDgoif exists (select * from sys.objects where name = N'sp_AddEscapeNoneToJobStepTokens' and type = 'P')    drop procedure sp_AddEscapeNoneToJobStepTokensgo-- This procedure allows you to update jobs so that bare tokens-- are prefaced with ESCAPE_NONE. By default, all jobs are updated.-- You can optionally specify @job_name, @job_id, or @owner_name-- to limit the jobs that will be affected.CREATE PROCEDURE sp_AddEscapeNoneToJobStepTokens(    @job_name nvarchar(128) = null,    @job_id uniqueidentifier = null,    @owner_name nvarchar(256) = null)AS  -- Find the jobs to update. These jobs must match all of the input  -- criteria, unless all of the inputs are null. In this case,   -- examine all jobs.  The jobs must also be jobs created locally,  -- such as sysjobs.originating_server_id = 0. These jobs should not be a job that we run  -- because another server told us to.  Furthermore, if the job  -- is local but it is meant to be run on a target server, we send an  -- update for the job.  declare @jobsToUpdate TABLE (job_id uniqueidentifier not null)    insert into @jobsToUpdate      select job_id      from sysjobs      where originating_server_id = 0 -- local jobs      and ((COALESCE(@job_name, sysjobs.name) = sysjobs.name) and           (COALESCE(@job_id, sysjobs.job_id) = sysjobs.job_id) and           (COALESCE(@owner_name, suser_sname(sysjobs.owner_sid)) = suser_sname(sysjobs.owner_sid)))    -- Now find the job steps to update, creating the new command by using  -- fn_PrefaceTokensWithEscapeNone.  declare @jobStepsToUpdate TABLE (job_id uniqueidentifier not null,                                    step_id int not null,                                    command_old nvarchar(max) null,                                    command_new nvarchar(max) null,                                   output_file_old nvarchar(max) null,                                    output_file_new nvarchar(max) null)    insert into @jobStepsToUpdate  (job_id, step_id, command_old, command_new, output_file_old, output_file_new)      select job_id, step_id, command, dbo.fn_PrefaceTokensWithEscapeNone(command), output_file_name, dbo.fn_PrefaceTokensWithEscapeNone(output_file_name)      from sysjobsteps      where sysjobsteps.job_id =       (select job_id        from @jobsToUpdate        where job_id = sysjobsteps.job_id)    -- Now we update the actual job step commands. We do this first before  -- we push out the updated jobs to the target servers so the  -- target servers actually get the updated version.  declare @updated_job_id uniqueidentifier  declare @updated_job_step_id int  declare @updated_job_step_command nvarchar(max)  declare @updated_job_step_output_file nvarchar(max)    declare job_steps_cursor CURSOR FOR      select job_id, step_id, command_new, output_file_new      from @jobStepsToUpdate      order by job_id, step_id    OPEN job_steps_cursor  FETCH NEXT from job_steps_cursor into @updated_job_id, @updated_job_step_id, @updated_job_step_command, @updated_job_step_output_file  WHILE (@@FETCH_STATUS <> -1)  BEGIN      IF (@@FETCH_STATUS <> -2)      BEGIN          EXEC sp_update_jobstep @job_id = @updated_job_id, @step_id = @updated_job_step_id, @command = @updated_job_step_command, @output_file_name = @updated_job_step_output_file      END      FETCH NEXT from job_steps_cursor into @updated_job_id, @updated_job_step_id, @updated_job_step_command, @updated_job_step_output_file  END    CLOSE job_steps_cursor  DEALLOCATE job_steps_cursor      -- For multiserver jobs, call the sp_post_msx_operation stored procedure to update  -- all the target servers. Note that the sp_post_msx_operation stored procedure is safe  -- to call because it verifies whether the job is really a multiserver job.  declare jobs_cursor CURSOR FOR      select job_id      from @jobsToUpdate    OPEN jobs_cursor  FETCH NEXT from jobs_cursor into @updated_job_id  WHILE (@@FETCH_STATUS <> -1)  BEGIN      IF (@@FETCH_STATUS <> -2)      BEGIN          EXEC sp_post_msx_operation @operation = 'UPDATE', @job_id = @updated_job_id      END      FETCH NEXT from jobs_cursor into @updated_job_id  END    CLOSE jobs_cursor  DEALLOCATE jobs_cursor  -- List the jobs that we ran on, including the previous command  -- text. We list all of the job steps, even the ones that we did not  -- update. Otherwise, a jumble of job steps from  -- different jobs run together and the output is not  -- useful.  select N'Warning - Jobs Updated' = N'The following job steps and job output file names were analyzed and potentially updated to add the ESCAPE_NONE macro before any job tokens that were not already escaped. Please review the modified job steps and replace ESCAPE_NONE with the correct escape macro.'    select suser_sname(jobs.owner_sid) as N'Job owner',          jobs.name as N'Job name',          jobs.job_id,          jobStepsUpdated.step_id,          N'Modified' = CASE WHEN jobStepsUpdated.command_new != jobStepsUpdated.command_old or jobStepsUpdated.output_file_new != jobStepsUpdated.output_file_old THEN 1 ELSE 0 END,         N'Command' = jobStepsUpdated.command_new,          N'Previous Command' = jobStepsUpdated.command_old,          N'Output file' = jobStepsUpdated.output_file_new,          N'Previous Output file' = jobStepsUpdated.output_file_old      from sysjobs as jobs, @jobsToUpdate as jobsUpdated, @jobStepsToUpdate as jobStepsUpdated      where jobsUpdated.job_id = jobs.job_id and jobsUpdated.job_id = jobStepsUpdated.job_id      order by 'Job name', jobStepsUpdated.step_idgo
Na het uitvoeren van het script wordt de opgeslagen procedure sp_AddEscapeNoneToJobStepTokens gemaakt. U kunt standaard alle taken bijwerken als u deze opgeslagen procedure uitvoert zonder parameters. Als u alleen bepaalde taken wilt bijwerken, moet u niet-Null-waarden opgeven voor minimaal één van de volgende drie parameters:
  • @job_name
  • @job_id
  • @owner_name
U kunt bijvoorbeeld de volgende syntaxis gebruiken:
  • Alle taken bijwerken:
    EXEC sp_AddEscapeNoneToJobStepTokens
  • Een taak bijwerken door de naam van een taak op te geven:
    EXEC sp_AddEscapeNoneToJobStepTokens 'MyJob'
  • Taken bijwerken waarvan de eigenaar eigenaar is:
    EXEC sp_AddEscapeNoneToJobStepTokens null,null,'JobOwner'
Dit script voegt de ESCAPE_NONE macro toe aan alle taakstappen die tokens bevatten. Als u dit script hebt uitgevoerd, is het raadzaam om uw taakstappen die tokens zo snel mogelijk gebruiken, te controleren. Vervolgens moet u de ESCAPE_NONE macro vervangen door een van de andere Escape-macro's die geschikt zijn voor de context van taakstappen.Opmerking Als u in een omgeving met hoofdserver (MSX) en doelserver (TSX) werkt, moet u het volgende script uitvoeren op de MSX en de TSX, zodat u zeker weet dat de hoofdtaken op de TSX correct zijn bijgewerkt. Als u meer wilt weten over het bijwerken van taken voor het gebruik van de nieuwe syntaxis en het gebruik van Escape-macro's om token vervanging in te schakelen in de taakstappen van SQL Server-Agent, raadpleegt u het onderwerp ' tokens in taakstappen gebruiken ' in SQL Server 2005-boeken online (april 2006) of latere versies van SQL Server 2005 Books Online.

Status


Microsoft heeft bevestigd dat dit probleem zich kan voordoen in de Microsoft-producten die worden vermeld in de sectie Van toepassing op.

Verwijzingen


Ga naar de volgende MSDN-website (Microsoft Developer Network) voor meer informatie over het gebruik van tokens in taakstappen: