Recursos do editor SQL da extensão JupyterLab SQL

A extensão SQL fornece comandos mágicos que habilitam as funcionalidades do editor SQL nas células do seu JupyterLab notebook.

Se você for usuário da imagem de SageMaker distribuição versão 1.6, deverá carregar a biblioteca mágica da extensão SQL executando %load_ext amazon_sagemaker_sql_magic em um JupyterLab notebook. Isso ativa os atributos de edição do SQL.

Para usuários das versões 1.7 e posteriores da imagem de SageMaker distribuição, nenhuma ação é necessária, a extensão SQL carrega automaticamente.

Depois que a extensão for carregada, adicione o comando mágico %%sm_sql no início de uma célula para ativar os seguintes recursos do editor de SQL:

• Lista suspensa de seleção de conexão: ao adicionar o comando mágico %%sm_sql mágico a uma célula, um menu suspenso aparece na parte superior da célula com suas conexões de fonte de dados disponíveis. Selecione uma conexão para preencher automaticamente os parâmetros necessários para consultar essa fonte de dados. Veja a seguir um exemplo de uma cadeia de comando mágico %%sm_sql gerada pela seleção da conexão chamada connection-name.

  %%sm_sql --metastore-type GLUE_CONNECTION --metastore-id connection-name

  Use os atributos do editor de SQL abaixo para criar suas consultas SQL e, em seguida, realizar a consulta executando a célula. Para obter mais informações sobre os atributos de execução do SQL, consulte Recursos de execução de JupyterLab SQL da extensão SQL.

• Lista suspensa de resultados da consulta: você pode especificar como renderizar os resultados da consulta selecionando um tipo de resultado no menu suspenso ao lado do menu suspenso de seleção de conexão. Escolha entre as duas alternativas a seguir:

  • Saída da célula (padrão): essa opção exibe o resultado da sua consulta na área de saída da célula do caderno.

  • Pandas Dataframe: Essa opção preenche um pandas DataFrame com os resultados da consulta. Uma caixa de entrada extra permite que você nomeie o DataFrame quando você escolhe essa opção.

• Destaque da sintaxe do SQL: a célula distingue visualmente palavras-chave, cláusulas, operadores e muito mais do SQL por cor e estilo. Isso torna o código SQL mais fácil de ler e entender. Palavras-chave como SELECT, FROM e WHERE, e funções integradas, como SUM e COUNT, ou cláusulas como GROUP BY e mais, são destacadas em uma cor diferente e negrito.

• Formatação SQL: você pode aplicar recuos, capitalização, espaçamento e quebras de linha consistentes para agrupar ou separar instruções e cláusulas SQL de uma das seguintes maneiras. Isso torna o código SQL mais fácil de ler e entender.

  • Clique com o botão direito do mouse na célula SQL e escolha Formatar SQL.

  • Quando a célula SQL estiver em foco, use o atalho ALT + F no Windows ou Option + F no MacOS.

• Preenchimento automático de SQL: a extensão fornece sugestões automáticas e preenchimento de palavras-chave SQL, funções, nomes de tabelas, nomes de colunas e muito mais à medida que você digita. Quando você começa a digitar uma palavra-chave SQL, como SELECT ou WHERE, a extensão exibe um pop-up com sugestões para preencher automaticamente o resto da palavra. Por exemplo, ao digitar nomes de tabelas ou colunas, ela sugere nomes de tabela e coluna correspondentes definidos no esquema do banco de dados.

  Importante

  Para ativar o preenchimento automático de SQL em JupyterLab notebooks, os usuários da imagem de distribuição SageMaker AI versão 1.6 devem executar o seguinte npm install -g vscode-jsonrpc sql-language-server comando em um terminal. Depois que a instalação for concluída, reinicie o JupyterLab servidor executandorestart-jupyter-server.

  Para usuários das versões 1.7 e posteriores de imagens de SageMaker distribuição, nenhuma ação é necessária.

  A célula oferece dois métodos para preencher automaticamente palavras-chave SQL reconhecidas:

  • Invocação explícita (recomendada): escolha a tecla Tab para iniciar o menu de sugestão contextual e, em seguida, escolha Enter para aceitar o item sugerido.

  • Dicas contínuas: a célula sugere automaticamente as conclusões à medida que você digita.

  nota

  • O preenchimento automático só é acionado se as palavras-chave SQL estiverem em maiúsculas. Por exemplo, inserir prompts SEL para SELECT, porque digitar sel não funciona.

  • Na primeira vez que você se conecta a uma fonte de dados, o preenchimento automático de SQL indexa os metadados da fonte de dados. Esse processo de indexação pode levar algum tempo para ser concluído, dependendo do tamanho dos seus bancos de dados.