add-transact-sql-snippets.md

title	Add Transact-SQL Snippets
description	Learn how to add your own Transact-SQL code snippets to the set of pre-defined snippets included in SQL Server.
ms.prod	sql
ms.prod_service	sql-tools
ms.technology	ssms
ms.topic	conceptual
ms.assetid	901c7995-8eb5-4d12-8bb0-de0a922b48f8
author	markingmyname
ms.author	maghan
ms.reviewer
ms.custom	seo-lt-2019
ms.date	03/14/2017
monikerRange	>=aps-pdw-2016||=azuresqldb-current||=azure-sqldw-latest||>=sql-server-2016||>=sql-server-linux-2017||=azuresqldb-mi-current

Add Transact-SQL Snippets

[!INCLUDESQL Server Azure SQL Database Synapse Analytics PDW ]

You can add your own Transact-SQL code snippets to the set of pre-defined snippets included in [!INCLUDEssNoVersion].

Creating a Transact-SQL Snippet File

The first part of creating a [!INCLUDEtsql] code snippet is to create an XML file with the text of your code snippet. The file must have a .snippet file extension, and meet the requirements of the Code Snippets Schema. Set the snippet language to SQL.

You can use the pre-defined snippets that ship with [!INCLUDEssNoVersion] as examples. To find the pre-defined snippets, open [!INCLUDEssManStudioFull], select the Tools menu, and click Code Snippet Manager. Select SQL in the Language list box, the path to the [!INCLUDEtsql] snippets is displayed in the Location box.

Registering the Code Snippet

After creating the snippet file, use the Code Snippets Manager to register the snippet with [!INCLUDEssManStudioFull]. You can either add a folder containing multiple snippets, or import individual snippets to the My Code Snippets folder.

Procedures

Adding a Snippet Folder

1. Open [!INCLUDEssManStudioFull].

2. Select the Tools menu, and click Code Snippets Manager.

3. Click the Add button.

4. Navigate to the folder containing your code snippets, and click the Select Folder button.

Importing a Snippet

1. Open [!INCLUDEssManStudioFull].

2. Select the Tools menu, and click Code Snippets Manager.

3. Click the Import button.

4. Navigate to the folder containing your snippet, click on the .snippet file, and click the Open button.

Examples

The following example creates a TRY-CATCH surround-with snippet and imports it to [!INCLUDEssManStudioFull].

1. Paste the following code into notepad, then save as a file named TryCatch.snippet.

   <?xml version="1.0" encoding="utf-8" ?>  
   <CodeSnippets  xmlns="https://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>  
   

2. Open [!INCLUDEssManStudioFull].

3. Select the Tools menu, and click Code Snippets Manager.

4. Click the Import button.

5. Navigate to the folder containing TryCatch.snippet, click on the TryCatch.snippet file, and click the Open button. You should now have a TryCatch snippet in your My Code Snippets folder.

See Also

Insert Surround-with Transact-SQL snippets