通过

添加 Transact-SQL 代码片段

适用于：SQL ServerAzure SQL 数据库Azure SQL 托管实例Azure Synapse AnalyticsAnalytics 平台系统（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。 可以添加包含多个代码段的文件夹，也可以将单个代码片段导入到“我的代码片段”文件夹中。

程序

添加代码段文件夹

  1. 打开 SQL Server Management Studio。
  2. 选择 “工具” 菜单，然后选择 “代码段管理器”。
  3. 选择 “添加 ”按钮。
  4. 导航到包含代码片段的文件夹，然后选择“ 选择文件夹 ”按钮。

导入代码片段

  1. 打开 SQL Server Management Studio。
  2. 选择 “工具” 菜单，然后选择 “代码段管理器”。
  3. 选择“ 导入 ”按钮。
  4. 导航到包含代码片段的文件夹，选择 .snippet 该文件，然后选择 “打开 ”按钮。

例子

以下示例创建一个 TRY...CATCH 环绕代码段并将其导入 SQL Server Management Studio。

  1. 将以下代码粘贴到记事本中，然后保存为一个文件，命名为 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 Documentation 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. 打开 SQL Server Management Studio。

  3. 选择 “工具” 菜单，然后选择 “代码段管理器”。

  4. 选择“ 导入 ”按钮。

  5. 导航到包含 TryCatch.snippet的文件夹，选择 TryCatch.snippet 该文件，然后选择 “打开 ”按钮。 现在，“TryCatch文件夹中应该有一个代码片段。

相关内容