Compartilhar via


Adicionar snippets de Transact-SQL

aplica-se a:SQL ServerBanco de Dados SQL do AzureInstância Gerenciada de SQL do AzureAzure Synapse AnalyticsAnalytics Platform System (PDW)

Você pode adicionar seus próprios snippets de código Transact-SQL ao conjunto de snippets predefinidos incluídos no SQL Server.

Criar um arquivo de snippet de Transact-SQL

A primeira etapa para criar um trecho de código Transact-SQL é criar um arquivo XML com o texto do trecho de código. O arquivo deve ter uma .snippet extensão de arquivo e atender aos requisitos do Esquema de Snippets de Código. Defina o idioma do snippet como SQL.

Você pode usar os snippets predefinidos que são enviados com o SQL Server como exemplos. Para localizar os snippets predefinidos, abra o SQL Server Management Studio, selecione o menu Ferramentas e selecione o Gerenciador de Snippets de Código. Selecione SQL na caixa de listagem Linguagem; o caminho para os snippets do Transact-SQL será exibido na caixa Local.

Registrar o trecho de código

Depois de criar o arquivo de snippet, use o Gerenciador de Snippets de Código para registrar o snippet com o SQL Server Management Studio. Você pode adicionar uma pasta contendo vários snippets ou importar snippets individuais para a pasta Meus Snippets de Código.

Procedimentos

Adicionar uma pasta de trechos

  1. Abra o SQL Server Management Studio.
  2. Selecione o menu Ferramentas e selecione o Gerenciador de Snippets de Código.
  3. Selecione o botão Adicionar .
  4. Navegue até a pasta que contém os snippets de código e selecione o botão Selecionar Pasta .

Importar um snippet

  1. Abra o SQL Server Management Studio.
  2. Selecione o menu Ferramentas e selecione o Gerenciador de Snippets de Código.
  3. Selecione o botão Importar .
  4. Navegue até a pasta que contém o snippet, selecione o .snippet arquivo e selecione o botão Abrir .

Exemplos

O exemplo a seguir cria um TRY...CATCH snippet surround-with e o importa para o SQL Server Management Studio.

  1. Cole o código a seguir no bloco de notas e salve como um arquivo chamado 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. Abra o SQL Server Management Studio.

  3. Selecione o menu Ferramentas e selecione o Gerenciador de Snippets de Código.

  4. Selecione o botão Importar .

  5. Navegue até a pasta que TryCatch.snippetcontém, selecione o TryCatch.snippet arquivo e selecione o botão Abrir . Agora você deve ter um TryCatch snippet na pasta Meus Snippets de Código.