Visão geral das APIs de tabela do OneLake

O OneLake fornece APIs para trabalhar com metadados de tabela e ler linhas de tabelas no Fabric. As APIs de metadados de catálogo funcionam com clientes e bibliotecas compatíveis com o padrão aberto da API Iceberg REST Catalog (IRC) ou com o padrão aberto da API Unity Catalog. Uma API REST comum lê e escreve descrições e tags adicionais para tabelas e colunas. A API de leitura de tabelas independente do formato retorna as linhas das tabelas como dados do Apache Arrow, enquanto aplica a segurança do OneLake.

Trabalhar com metadados de tabela

Use as APIs de metadados para descobrir esquemas, tabelas e os metadados das tabelas. As operações de leitura e escrita suportadas variam conforme o protocolo.

Use a API adicional de metadados de tabelas (prévia) para ler e escrever descrições e tags de tabelas e colunas sem usar uma API de catálogo específica para cada formato.

API Protocol Formatos de tabela
API de metadados Iceberg API do Catálogo REST do Iceberg Metadados do Apache Iceberg para tabelas do OneLake com suporte
API de metadados Delta API REST compatível com o Unity Catalog Metadados Delta

Ler dados da tabela

Use a API de leitura de tabelas para recuperar linhas seguras das tabelas OneLake suportadas.

API Protocolo e fluxo de trabalho Formatos de tabela
API de leitura de tabela (prévia) Aloque fluxos com POST /read, e recupere cada fluxo com GET /readStream/{streamId} Tabelas válidas de Delta Lake e Apache Iceberg

Pré-requisitos

Antes de usar essas APIs, identifique algumas informações e selecione o fluxo de autenticação do Microsoft Entra ID que preferir.

Colete informações básicas

Reúna as seguintes informações:

  • Sua ID do locatário do Fabric.

    O ID do locatário é um GUID. Encontre no Cartão de Perfil ou em Ajuda>Sobre Fabric.

  • O workspace e o ID do item de dados (como um lakehouse) com um diretório de Tabelas no nível superior.

    Esses identificadores são GUIDs. Eles podem ser encontrados na URL de qualquer tabela no OneLake. Como alternativa, eles podem ser encontrados na URL vista no navegador quando você tem um item de dados aberto no Fabric.

  • O nome do esquema e o nome da tabela que você quer acessar. Para a API de leitura de tabela, a tabela deve ser uma tabela Delta Lake ou Apache Iceberg válida.

  • Uma identidade de usuário ou principal de serviço no Microsoft Entra ID que possui as permissões necessárias para as operações que você pretende usar.

    • Operações de leitura exigem permissão para ler as tabelas de destino. A API de leitura de tabela usa as permissões e políticas de segurança de dados para essa identidade quando retorna linhas e colunas.
    • Operações de escrita exigem acesso de escrita ao item de dados alvo e à localização do OneLake. Dependendo do tipo de item e do modelo de acesso, conceda um papel de item ou espaço de trabalho que permita escritas ou conceda ReadWrite por meio de uma função de acesso a dados OneLake. Para obter mais informações, consulte Introdução à segurança do OneLake.

Prepare-se para autenticação

Faça um plano de como você quer autenticar com a API.

  1. Decida como você deseja autenticar com a ID do Microsoft Entra para obter um token de acesso para sua identidade escolhida do Microsoft Entra.

    Você pode verificar este guia para saber mais sobre as diferentes maneiras de obter um token de acesso com a ID do Microsoft Entra. A Microsoft oferece bibliotecas de autenticação convenientes em vários idiomas.

  2. Se você estiver desenvolvendo um novo aplicativo que permitirá que os usuários entrem ou entrem como um aplicativo autônomo, registre seu aplicativo com a ID do Microsoft Entra.

  3. Conceda permissão de API ao destinatário de token do Armazenamento do Azure (https://storage.azure.com/) para seu aplicativo do Microsoft Entra ID. Conceder essa permissão garante que seu aplicativo possa obter tokens para uso com o endpoint da tabela OneLake.

    Observação

    O endpoint da API de tabela do OneLake aceita o mesmo público-alvo de token que os endpoints do sistema de arquivos OneLake.

    Se você está desenvolvendo uma aplicação, talvez já saiba como autenticar com o Microsoft Entra ID para interagir com APIs REST do sistema de arquivos OneLake. Se for o caso, você pode usar a mesma abordagem para se autenticar com o endpoint de tabela do OneLake.

Conteúdo relacionado

  • Última atualização em