Добавление фрагментов кода Transact-SQL

Статья
05/30/2023

Применимо к: SQL Server Azure SQL Database Управляемый экземпляр SQL Azure Azure Synapse Analytics Analytics Platform System (PDW)

В SQL Serverможно добавить собственные фрагменты кода Transact-SQL в набор предварительно определенных фрагментов.

Создание файла фрагмента Transact-SQL

Первая часть работы над фрагмента кода Transact-SQL заключается в создании XML-файла с текстом этого фрагмента кода. Файл должен иметь расширение SNIPPET и отвечать требованиям Схемы фрагментов кода. Укажите SQL в качестве языка фрагмента кода.

Можно использовать предварительно определенные фрагменты, которые поставляются вместе с SQL Server в качестве примеров. Чтобы найти предопределенные фрагменты кода, откройте среду SQL Server Management Studio, а затем в меню Сервис выберите пункт Диспетчер фрагментов кода. Выберите SQL из поля со списком Язык, и путь к фрагментам кода Transact-SQL отобразится в поле Расположение.

Регистрация фрагмента кода

После создания файла фрагмента используйте диспетчер фрагментов кода для регистрации фрагмента с помощью среды SQL Server Management Studio. Можно либо добавить папку, содержащую несколько фрагментов, либо импортировать отдельные фрагменты в папку Мои фрагменты кода .

Процедуры

Добавление папки фрагментов

Откройте SQL Server Management Studio.
Выберите меню Сервис и нажмите кнопку Диспетчер фрагментов кода.
Нажмите кнопку Добавить.
Перейдите к папке, содержащей собственные фрагменты кода, и нажмите кнопку Выбор папки .

Импорт фрагмента

Откройте SQL Server Management Studio.
Выберите меню Сервис и нажмите кнопку Диспетчер фрагментов кода.
Нажмите кнопку Import (Импортировать).
Перейдите к папке, содержащей собственный фрагмент кода, выберите файл с расширением SNIPPET и нажмите кнопку Открыть .

Примеры

В приведенном ниже примере создается окружающий блок TRY-CATCH для фрагмента кода, который будет импортирован в среду SQL Server Management Studio.

Вставьте следующий код в блокнот, сохраните файл с именем TryCatch.snippet.

<?xml version="1.0" encoding="utf-8" ?>  
<CodeSnippets  xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">  
<_locDefinition xmlns="urn:locstudio">  
    <_locDefault _loc="locNone" />  
    <_locTag _loc="locData">Title</_locTag>  
    <_locTag _loc="locData">Description</_locTag>  
    <_locTag _loc="locData">Author</_locTag>  
    <_locTag _loc="locData">ToolTip</_locTag>  
   <_locTag _loc="locData">Default</_locTag>  
</_locDefinition>  
<CodeSnippet Format="1.0.0">  
<Header>  
<Title>TryCatch</Title>  
                        <Shortcut></Shortcut>  
<Description>Example Snippet for Try-Catch.</Description>  
<Author>SQL Server Books Online Example</Author>  
<SnippetTypes>  
                                <SnippetType>SurroundsWith</SnippetType>  
</SnippetTypes>  
</Header>  
<Snippet>  
<Declarations>  
                                <Literal>  
                                <ID>CatchCode</ID>  
                                <ToolTip>Code to handle the caught error</ToolTip>  
                                <Default>CatchCode</Default>  
                                </Literal>  
</Declarations>  
<Code Language="SQL"><![CDATA[  
BEGIN TRY  

$selected$ $end$  

END TRY  
BEGIN CATCH  

$CatchCode$  

END CATCH;  
]]>  
</Code>  
</Snippet>  
</CodeSnippet>  
</CodeSnippets>

Откройте SQL Server Management Studio.
Выберите меню Сервис и нажмите кнопку Диспетчер фрагментов кода.
Нажмите кнопку Import (Импортировать).
Перейдите к папке, содержащей файл TryCatch.snippet, щелкните файл TryCatch.snippet и нажмите кнопку Открыть . В папке Мои фрагменты кода не должно быть фрагмента TryCatch.

См. также:

Вставка фрагментов кода окружения Transact-SQL