添加 Transact-SQL 代码段

项目
05/30/2023

适用于：SQL Server Azure SQL 数据库 Azure SQL 托管实例 Azure Synapse Analytics Analytics Platform System (PDW)

您可以将自己的 Transact-SQL 代码段添加到在 SQL Server中包括的一组预定义的代码段中。

创建 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?
选择 “工具” 菜单，然后单击 “代码段管理器” 。
单击“导入”按钮。
导航到包含您的代码段的文件夹，单击 .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?
选择 “工具” 菜单，然后单击 “代码段管理器” 。
单击“导入”按钮。
导航到包含 TryCatch.snippet 的文件夹，单击该 TryCatch.snippet 文件，然后单击 “打开” 按钮。 “My Code Snippets”文件夹中应有一个 TryCatch 代码片段。

另请参阅

插入外侧 Transact-SQL 代码片段

通过