Compartilhar via


Formato do código-fonte da integração do Git

Os itens no Microsoft Fabric são armazenados em uma pasta. A pasta que contém o item pode estar no diretório raiz ou em um subdiretório. Ao conectar seu workspace ao git, conecte-se à pasta que contém os itens. Cada item na pasta é representado em seu próprio subdiretório.

Nome do diretório

Quando você salva um novo item no Git, a integração do Git cria automaticamente um diretório para ele.

O nome do diretório do item é baseado nas seguintes regras:

  • O padrão para o nome é {display name}.{public facing type}.
  • Quando necessário, são realizadas as seguintes alterações no nome de exibição:
    • Os caracteres inválidos são substituídos pelo número HTML.
    • O espaço inicial é substituído pelo respectivo número HTML.
    • O espaço à direita ou o ponto final é substituído pelo respectivo número HTML.
  • Se o nome da pasta não estiver disponível, o nome do logicalID (GUID) do item será usado em vez do nome de exibição.

Por exemplo, se você tiver os seguintes itens em um workspace (observe que o primeiro e o terceiro itens têm um espaço invisível à esquerda e à direita, respectivamente):

Captura de tela da lista de itens em um espaço de trabalho do Fabric.

Os seguintes diretórios são criados no repositório Git:

Captura de tela dos nomes dos diretórios Git que contêm os itens do Fabric.

  • Uma vez criada, a integração do Git nunca altera o nome de um diretório. Mesmo se você alterar o nome do item, o nome do diretório permanecerá o mesmo.
  • Se você alterar manualmente o nome de um diretório de item, certifique-se de levar em conta as dependências do item. Por exemplo, se você alterar o diretório de um modelo semântico, certifique-se de atualizar o caminho do modelo semântico no arquivo de dependência do relatório. Lembre-se de que os locais de dependência variam entre as diferentes experiências do Fabric. Alterar o nome do diretório não causa uma alteração no workspace.

Conteúdo do diretório

Cada diretório de item contém arquivos de definição do item e arquivos do sistema gerados automaticamente.

Arquivos de definição de item

O diretório de cada item tem arquivos específicos que são necessários para definir o item.

No momento, os itens a seguir têm suporte no Microsoft Fabric:

Bancos de dados espelhados

As pastas de banco de dados espelhadas contêm um arquivo .json definindo o banco de dados espelhado.

Para obter instruções sobre como usar a integração do Git com bancos de dados espelhados, consulte CI/CD para bancos de dados espelhados.

Arquivos do Notebook

As pastas do Notebook contêm um arquivo .py:

Para obter instruções sobre como usar a integração do Git com notebooks, consulte Controle de código-fonte e implantação de notebooks.

Arquivos de relatório paginados

As pastas de relatório paginados contêm um arquivo .rdl que define o relatório paginado. RDL (Report Definition Language) é uma representação XML de uma definição de relatório paginado.

Para obter mais informações sobre RDL, consulte RDL (Linguagem de Definição de Relatório). Para obter instruções sobre como usar a integração do Git com relatórios paginados, consulte Integração do Git com relatórios paginados.

Arquivos de relatório

As pastas de relatório contêm os seguintes arquivos:

  • definition.pbir
  • report.json

Para obter mais informações sobre pastas de relatórios e uma lista completa de seu conteúdo, consulte Pasta do relatórios do projeto Power BI Desktop.

Arquivos de modelo semântico

As pastas de modelo semântico contêm os seguintes arquivos:

  • definition.pbism
  • \pasta de definição com arquivos TMDL

Para obter mais informações sobre pastas de modelo semântico e uma lista completa de seu conteúdo, consulte Pasta do modelo semântico do projeto Power BI Desktop.

Arquivos de sistema geradas automaticamente

Além dos arquivos de definição de item, cada diretório de item contém um ou dois arquivos de sistema gerados automaticamente, dependendo de qual versão você está usando:

  • Um diretório versão 1 contém item.metadata.json e item.config.json. Com a V1, ambos os arquivos devem estar no diretório.
  • Um diretório versão 2 contém .platform. Esse arquivo inclui o conteúdo dos arquivos item.metadata.json e item.config.json. Caso tenha esse arquivo, não poderá ter os outros dois arquivos. Se você estiver usando a versão 1 e confirmar alterações, seus arquivos de sistema serão atualizados automaticamente para esta versão.

Observação

Seu diretório deve conter os arquivos item.metadata.json e item.config.jsonou o arquivo .platform. Não é possível ter os três arquivos.

Arquivo de plataforma

Na versão 2, em vez de ter dois arquivos de origem em cada diretório de item, o arquivo .platform combina todas as informações em um arquivo junto com uma propriedade $schema. Caso tenha esse arquivo, não poderá ter os outros dois arquivos.

{
    "version": "2.0",
    "$schema": https://developer.microsoft.com/json-schemas/fabric/platform/platformProperties.json,
    "config": {
        "logicalId": "e553e3b0-0260-4141-a42a-70a24872f88d"
    },
    "metadata": {
        "type": "Report",
        "displayName": "All visual types",
        "description": "This is a report"
    }
}

O arquivo .platform contém os seguintes atributos:

  • version: número de versão dos arquivos do sistema. Esse número é usado para habilitar a compatibilidade com versões anteriores. O número de versão do item pode ser diferente.
  • logicalId: (cadeia de caracteres) um identificador entre espaços de trabalho gerado automaticamente representando um item e sua representação do controle do código-fonte.
  • type: (cadeia de caracteres) tipo do item (modelo semântico, relatório, etc.)
  • displayName: (cadeia de caracteres) o nome do item.
  • description: (sequência opcional) Descrição do item.

Se você renomear o artefato no workspace e a pasta do artefato no Git tiver um sufixo '.', então, após confirmar, o displayName e o nome do diretório no Git coincidirão.

A logicalId conecta um item em um espaço de trabalho com seu item correspondente em uma ramificação do Git. Presume-se que os itens com as mesmas logicalIds sejam os mesmos. A logicalId preserva o link mesmo se o nome ou diretório for alterado. Como uma ramificação pode ser sincronizada com vários espaços de trabalhos, é possível ter itens em espaços de trabalho diferentes com a mesma logicalId, mas um único espaço de trabalho não pode ter dois itens com a mesma logicalId. A logicalId é criada quando o espaço de trabalho está conectado a uma ramificação do Git ou um novo item é sincronizado. A logicalId é necessária para que a integração do Git funcione corretamente. Portanto, é essencial não alterá-lo de forma alguma.

Observação

Quando você confirma alterações no Git na versão 1, os arquivos do sistema são atualizados automaticamente para a versão 2 junto com as alterações. Além disso, todos os novos arquivos exportados do modo do desenvolvedor do Power BI Desktop serão salvos no formato de arquivo da versão 2.

Observação

  • O campo type diferencia maiúsculas de minúsculas. Não altere a forma como ele é gerado automaticamente. Caso contrário, a operação poderá falhar.
  • Embora você geralmente não deve alterar o logicalId ou nome de exibição de um item, uma exceção é possível, caso esteja criando um novo item copiando um diretório de item existente. Nesse caso, você precisará alterar o logicalId e o nome de exibição para algo exclusivo no repositório.

Introdução à integração do Git.