Executar consultas federadas no Microsoft Azure Synapse

Este artigo descreve como configurar a Federação de Lakehouse para executar consultas federadas em dados do Azure Synapse (SQL Data Warehouse) que não são gerenciados pelo Azure Databricks. Para saber mais sobre a Federação do Lakehouse, consulte O que é a Federação do Lakehouse?.

Para se conectar a um banco de dados do Azure Synapse (SQL Data Warehouse) usando a Federação de Lakehouse, você deve criar o seguinte no metastore do Unity Catalog do Azure Databricks:

  • Uma conexão com o banco de dados Azure Synapse (SQL Data Warehouse).
  • Um catálogo estrangeiro que espelha seu banco de dados do Azure Synapse (SQL Data Warehouse) no Catálogo do Unity para que você possa usar a sintaxe de consulta do Catálogo do Unity e as ferramentas de governança de dados para gerenciar o acesso do usuário do Azure Databricks ao banco de dados.

Antes de começar

Requisitos do workspace:

  • Workspace habilitado para o Catálogo do Unity.

Requisitos de computação:

  • Conectividade de rede do cluster do Databricks Runtime ou do Warehouse SQL para os sistemas de banco de dados de destino. Confira Recomendações de rede para a Federação de Lakehouse.
  • Os clusters do Azure Databricks devem usar o Databricks Runtime 13.3 LTS ou superior e o modo de acesso compartilhado ou de usuário único.
  • Os SQL warehouses precisam ser Pro ou sem servidor e precisam usar a versão 2023.40 ou superior.

Permissões necessárias:

  • Para criar uma conexão, você deve ser um administrador de metastore ou um usuário com o privilégio de CREATE CONNECTION no metastore do Catálogo do Unity anexado ao workspace.
  • Para criar um catálogo estrangeiro, você deve ter a permissão de CREATE CATALOG no metastore e ser o proprietário da conexão ou ter o privilégio de CREATE FOREIGN CATALOG na conexão.

Requisitos de permissão adicionais são especificados em cada seção baseada em tarefa a seguir.

Criar uma conexão

Uma conexão especifica um caminho e credenciais para acessar um sistema de banco de dados externo. Para criar uma conexão, você pode usar o Explorador do Catálogo ou o comando SQL CREATE CONNECTION em um notebook do Azure Databricks, ou o editor de consulta do Databricks SQL.

Observação

Você também pode usar a API REST do Databricks ou a CLI do Databricks para criar uma conexão. Consulte POST /api/2.1/unity-catalog/connections e Comandos do Catálogo do Unity.

Permissões necessárias: administrador ou usuário do metastore com o privilégio de CREATE CONNECTION.

Explorador do Catálogo

  1. No workspace do Azure Databricks, clique em Ícone do catálogo Catálogo.

  2. Na parte superior do painel Catálogo, clique no ícone Ícone de adição ou mais Adicionar e selecione Adicionar uma conexão no menu.

    Como alternativa, na página Acesso rápido, clique no botão Dados externos >, vá até a guia Conexões e clique em Criar conexão.

  3. Insira um nome de conexão simples.

  4. Selecione um Tipo de Conexão do SQLDW.

  5. Insira as propriedades de conexão a seguir para a sua instância do Azure Synapse.

    • Host: por exemplo, sqldws-demo.database.windows.net.
    • Porta: por exemplo, 1433
    • trustServerCertificate: o padrão é false. Quando configurada como true, a camada de transporte usa SSL para criptografar o canal e ignora a cadeia de certificados para validar a relação de confiança. Deixe esse conjunto com os valores padrão, a menos que você tenha uma necessidade específica de ignorar a validação de confiança.
    • Usuário
    • Senha
  6. (Opcional) Clique em Testar a conexão para confirmar se está funcionando.

  7. (Opcional) Adicione um comentário.

  8. Clique em Criar.

SQL

Execute o comando a seguir em um notebook ou no editor de SQL do Databricks.

CREATE CONNECTION <connection-name> TYPE sqldw
OPTIONS (
  host '<hostname>',
  port '<port>',
  user '<user>',
  password '<password>'
);

Recomendamos usar segredos do Azure Databricks em vez de cadeias de caracteres de texto não criptografado para valores confidenciais, como credenciais. Por exemplo:

CREATE CONNECTION <connection-name> TYPE sqldw
OPTIONS (
  host '<hostname>',
  port '<port>',
  user secret ('<secret-scope>','<secret-key-user>'),
  password secret ('<secret-scope>','<secret-key-password>')
)

Para obter informações sobre configuração de segredos, confira Gestão de segredos.

Criar um catálogo estrangeiro

Um catálogo estrangeiro espelha um banco de dados em um sistema de dados externo para que você possa consultar e gerenciar o acesso aos dados nesse banco de dados usando o Azure Databricks e o Catálogo do Unity. Para criar um catálogo estrangeiro, use uma conexão com a fonte de dados que já foi definida.

Para criar um catálogo estrangeiro, você pode usar o Explorador de Catálogos ou o comando SQL CREATE FOREIGN CATALOG em um notebook do Azure Databricks ou no editor de consultas SQL.

Observação

Além disso, é possível usar a API REST do Databricks ou a CLI do Databricks para criar um catálogo. Confira POST /api/2.1/unity-catalog/catalogs e Comandos do Unity Catalog.

Permissões necessárias: permissão de CREATE CATALOG no metastore e a propriedade da conexão ou o privilégio de CREATE FOREIGN CATALOG na conexão.

Explorador do Catálogo

  1. Em seu workspace do Azure Databricks, clique em Ícone do catálogo Catálogo para abrir o Explorador de Catálogo.

  2. Na parte superior do painel Catálogo, clique no ícone Ícone de adição ou mais Adicionar e selecione Adicionar um catálogo no menu.

    Como alternativa, na página Acesso rápido, clique no botão Catálogos e depois no botão Criar catálogo.

  3. Siga as instruções para criar catálogos estrangeiros em Criar catálogos.

SQL

Execute o comando SQL a seguir em um notebook ou editor de consultas SQL. Os itens entre colchetes são opcionais. Substitua os valores de espaço reservado:

  • <catalog-name>: nome do catálogo no Azure Databricks.
  • <connection-name>: o objeto de conexão que especifica a fonte de dados, o caminho e as credenciais de acesso.
  • <database-name>: nome do banco de dados que você deseja espelhar como um catálogo no Azure Databricks.
CREATE FOREIGN CATALOG [IF NOT EXISTS] <catalog-name> USING CONNECTION <connection-name>
OPTIONS (database '<database-name>');

Pushdowns com suporte

Há suporte para os seguintes pushdowns:

  • Filtros
  • Projeções
  • Limite
  • Agregações (Average, Count, Max, Min, StddevPop, StddevSamp, Sum, VarianceSamp)
  • Funções (funções de cadeia de caracteres e outras funções diversas, como Alias, Cast, SortOrder)
  • Classificação

Não há suporte para os seguintes pushdowns:

  • Junções
  • Funções do Windows

Mapeamentos de tipo de dados

Quando você lê do Synapse/SQL Data Warehouse para o Spark, os tipos de dados são mapeados da seguinte maneira:

Tipo do Synapse Tipo do Spark
decimal, money, numeric, smallmoney DecimalType
SMALLINT ShortType
tinyint ByteType
int IntegerType
BIGINT LongType
real FloatType
FLOAT DoubleType
char, nchar, ntext, nvarchar, text, uniqueidentifier, varchar, xml StringType
binary, geography, geometry, image, timestamp, udt, varbinary BinaryType
bit BooleanType
date DateType
datetime, datetime, smalldatetime, time TimestampType/TimestampNTZType*

*Quando você lê do Synapse/SQL Data Warehouse (SQLDW), o SQLDW datetimes é mapeado para o Spark TimestampType se preferTimestampNTZ = false (padrão). O SQLDW datetimes será mapeado para TimestampNTZType se preferTimestampNTZ = true.