Compartilhar via


Blocos de Anotações SQL (versão prévia)

Os Blocos de Anotações SQL na extensão MSSQL para Visual Studio Code fornecem desenvolvimento de SQL baseado em notebook usando notebooks Jupyter do Visual Studio Code nativos. Você pode combinar a execução interativa de consulta SQL com células de documentação do Markdown para criar coleções de consultas executáveis, operações de banco de dados de documentos e compartilhar análise reproduzível.

Dica

O SQL Notebooks está atualmente em versão prévia e pode ser alterado com base nos comentários. Junte-se à comunidade no GitHub Discussions para compartilhar ideias ou relatar problemas.

Características

O SQL Notebooks oferece estes recursos:

  • Execute consultas T-SQL interativamente em células de código do notebook com resultados embutidos exibidos abaixo de cada célula.

  • Use o formato nativo de notebook Jupyter do Visual Studio Code (.ipynb arquivos) para compatibilidade completa com as ferramentas de notebook existentes.

  • A consulta de exibição resulta em uma grade de dados avançada com classificação, filtragem, seleção de célula, realce de valor nulo e opções de cópia (incluindo cópia com cabeçalhos).

  • Escreva SQL com o IntelliSense, incluindo sugestões de nomes de tabela e coluna com base em sua conexão de banco de dados ativa.

  • Adicione células de texto markdown ao lado de células de código SQL para documentar consultas, anotar resultados e criar fluxos de trabalho narrativos.

  • Conecte cada notebook a uma instância do SQL Server e alterne entre bancos de dados no mesmo servidor.

  • Execute células individualmente ou execute todas as células sequencialmente.

  • Use o GitHub Copilot para sugestões de consulta embutidas em células de código e criação de notebook orientada por chat para gerar notebooks completos a partir de descrições de linguagem natural.

  • Combine células SQL com outros kernels de idioma (como Python) no mesmo notebook instalando a extensão Jupyter.

  • Exporte e compartilhe notebooks como .ipynb arquivos que outras pessoas podem abrir no Visual Studio Code ou em qualquer ambiente compatível com Jupyter.

Pré-requisitos

Antes de usar o SQL Notebooks, verifique se os seguintes requisitos são atendidos:

Criar um notebook SQL

Você pode criar um novo notebook SQL de várias maneiras:

  • Abra a Paleta de Comandos (Ctrl+Shift+P no Windows e Linux ou Cmd+Shift+P no macOS), digite New Notebooke selecione o comando.

  • Vá para o menu Arquivo e selecione Novo Arquivo e escolha o tipo jupyter notebook.

  • Clique com o botão direito do mouse em um banco de dados no Pesquisador de Objetos da extensão MSSQL e selecione Novo Bloco de Anotações no menu de contexto.

Ao criar um novo notebook, selecione o kernel MSSQL para habilitar a execução do T-SQL em células de código.

Conectar a um banco de dados

Cada bloco de anotações SQL precisa de uma conexão de banco de dados ativa para executar consultas. Quando você abre um notebook com o kernel MSSQL, a extensão solicita que você selecione um perfil de conexão ou crie um novo.

Importante

Cada notebook dá suporte a uma única conexão de servidor por kernel. Você pode se conectar a uma instância do SQL Server e alternar entre bancos de dados nesse servidor, mas não é possível se conectar a vários servidores no mesmo notebook. Para trabalhar com um servidor diferente, crie um bloco de anotações separado ou altere a conexão do notebook.

Gravar e executar células SQL

As células de código SQL permitem que você escreva e execute consultas T-SQL interativamente no notebook.

  1. Selecione + Código na barra de ferramentas do notebook para adicionar uma nova célula de código.

  2. Insira sua consulta T-SQL na célula. A célula fornece a mesma experiência de edição de SQL que um editor de consultas padrão, incluindo o IntelliSense com sugestões de nomes de tabela e coluna do banco de dados conectado.

  3. Selecione Executar célula (o botão de execução à esquerda da célula) para realizar a consulta.

  4. Os resultados aparecem diretamente abaixo da célula em uma grade de dados avançada.

Para executar todas as células no notebook sequencialmente, selecione Executar Tudo na barra de ferramentas do notebook.

Dica

Use Ctrl+Enter (Windows e Linux) ou Cmd+Enter (macOS) para executar a célula atual e permanecer nela. Use Shift+Enter para executar a célula atual e avançar para a próxima.

Resultados da consulta

Os resultados da consulta no SQL Notebooks fornecem a mesma experiência de grade de dados avançada disponível no editor de consultas padrão:

  • Classificação: selecione um cabeçalho de coluna para classificar os resultados em ordem crescente ou decrescente.
  • Filtragem: use o ícone de filtro em cabeçalhos de coluna para filtrar dados de resultado.
  • Seleção de células: selecione células individuais ou intervalos de células na grade de resultados.
  • Realce nulo: NULL os valores são realçados visualmente na grade de resultados para facilitar a identificação.
  • Opções de cópia: clique com o botão direito do mouse nas células selecionadas para acessar As opções Copiar, Copiar com Cabeçalhos e Selecionar Todos .

Adicionar células Markdown

Você pode usar células Markdown para adicionar texto formatado, títulos, listas e links junto com suas células de código SQL. Use-as para documentar suas consultas, explicar a lógica de negócios ou adicionar anotações sobre os resultados esperados.

  1. Selecione + Markdown na barra de ferramentas do notebook para adicionar uma nova célula de texto.

  2. Digite o conteúdo do Markdown. Uma visualização é mostrada conforme você digita.

  3. Selecione fora da célula para renderizar o texto Markdown.

Selecione a célula novamente para retornar ao modo de edição.

Usar vários kernels

A extensão MSSQL fornece o kernel SQL pronto para uso. Você pode estender seus notebooks com mais kernels de idioma instalando a extensão Jupyter, que agrupa o suporte para Python e outros kernels. Você pode combinar consultas de dados SQL com células de processamento e visualização de dados python no mesmo notebook.

Integração do GitHub Copilot

O GitHub Copilot funciona com o SQL Notebooks para ajudá-lo a escrever consultas e gerar notebooks. Ao instalar a extensão do GitHub Copilot, você obtém:

  • Sugestões embutidas: à medida que você digita em células de código SQL, o GitHub Copilot sugere conclusões de consulta com base no contexto do banco de dados e nas células do Markdown ao redor.

  • Criação de notebook orientada por chat: use o GitHub Copilot Chat para gerar notebooks completos com células Markdown e SQL alternadas. Descreva a análise que você deseja executar e o GitHub Copilot cria a estrutura completa do notebook.

Por exemplo, você pode abrir o GitHub Copilot Chat e usar um prompt como:

I have a SQL Notebook open connected to AdventureWorks. Create cells for a sales
analysis: list all tables, find top 10 customers by revenue, show revenue by product
category, and demonstrate a safe data modification using BEGIN TRAN / ROLLBACK.

O GitHub Copilot gera as células de documentação do Markdown e as células de código T-SQL, que você pode executar individualmente ou tudo de uma vez usando Executar Tudo.

Alternar bancos de dados

Para alternar para um banco de dados diferente na mesma conexão de servidor:

  1. Selecione o nome do banco de dados exibido na área de status de conexão do notebook.

  2. Escolha um banco de dados diferente na lista dropdown.

Todas as execuções subsequentes de células usam o banco de dados recém-selecionado.

Observação

Para mudar para um servidor diferente, você precisa alterar o perfil de conexão do notebook. Considere a criação de um bloco de anotações separado para cada servidor com o qual você precisa trabalhar.

Limitações

Conexão de servidor único por notebook: atualmente, cada notebook se conecta a uma instância do SQL Server. Você pode alternar bancos de dados nesse servidor, mas não pode se conectar a um segundo servidor no mesmo notebook.

Feedback e suporte

Se você tiver ideias, comentários ou quiser se envolver com a comunidade, participe da discussão em https://aka.ms/vscode-mssql-discussions. Para relatar um bug, visite https://aka.ms/vscode-mssql-bug. Para solicitar um novo recurso, vá para https://aka.ms/vscode-mssql-feature-request.