Формат исходного кода интеграции Git

Элементы в Microsoft Fabric хранятся в папке. Папка, содержащая элемент, может находиться в корневом каталоге или подкаталоге. При подключении рабочей области к Git подключитесь к папке, содержащей элементы. Каждый элемент в папке представлен в отдельном подкаталоге.

Имя каталога

При сохранении нового элемента в Git интеграция Git автоматически создает каталог для этого элемента.

Имя каталога элементов основано на следующих правилах:

• Шаблон для имени — это {display name}.{public facing type}.
• При необходимости вносятся следующие изменения в отображаемое имя:
  • Недопустимые символы заменяются html-номером.
  • Ведущее пространство заменяется его HTML-номером.
  • Конечный пробел или точка заменяются соответствующим HTML-номером.
• Если это имя папки недоступно, вместо отображаемого имени используется имя логического ИДЕНТИФИКАТОРа элемента (GUID).

Например, если у вас есть следующие элементы в рабочей области (обратите внимание, что первые и третие элементы имеют невидимое начальное и конечное пространство соответственно):

В репозитории Git создаются следующие каталоги:

• После создания интеграция Git никогда не изменяет имя каталога. Даже если изменить имя элемента, имя каталога остается неизменным.
• Если вы вручную измените имя каталога элементов, обязательно учитывайте зависимости элемента. Например, если изменить каталог семантической модели, необходимо обновить путь к семантической модели в файле зависимостей отчета. Имейте в виду, что расположение зависимостей может различаться в зависимости от различных вариантов использования Fabric. Изменение имени каталога не приводит к входящему изменению в рабочей области.

Содержимое каталога

Каждый каталог элементов содержит файлы определения элементов и автоматически создаваемые системные файлы.

Файлы определения элементов

В каталоге каждого элемента есть определенные необходимые файлы, определяющие этот элемент.

В настоящее время в Microsoft Fabric поддерживаются следующие элементы:

• зеркальные базы данных
• Записная книжка
• Отчет с разбивкой на страницы
• Отчет
• Семантическая модель
• Функции пользовательских данных

Зеркальные базы данных

Зеркальные папки базы данных содержат файл .json, определяющий зеркальную базу данных.

Инструкции по использованию интеграции Git с зеркальными базами данных см. раздел CI/CD для зеркальных баз данных.

Файлы записной книжки

Папки блокнота содержат файл .py:

Инструкции по использованию интеграции Git с ноутбуками см. в разделе "Управление версиями исходного кода и развертывание ноутбуков".

Файлы отчетов с разбивкой на страницы

Папки отчетов с разбивкой на страницы содержат файл .rdl, определяющий такой отчет. RDL (язык определения отчета) — это XML-представление определения отчета с разбивкой на страницы.

Дополнительные сведения о RDL см. в языке определения отчетов (RDL). Инструкции по использованию интеграции Git с отчетами с разбивкой на страницы см. в статье Интеграция Git с отчетами с разбивкой на страницы.

Файлы отчетов

Папки отчетов содержат следующие файлы:

• definition.pbir
• report.json

Для получения дополнительных сведений о папках отчетов и полном списке их содержимого см. папку отчета проекта Power BI Desktop.

Файлы семантической модели

Папки семантической модели содержат следующие файлы:

• определение.pbism
• Папка \definition с файлами TMDL

Для получения дополнительной информации о папках семантической модели и полном списке их содержимого см. Папка семантической модели проекта Power BI Desktop.

Файлы функций пользовательских данных

Папки функций пользовательских данных содержат следующие файлы:

• function-app.py — код функции Python. Это основной файл, который вы редактируете.
• definitions.json — определения элементов, такие как подключения и ссылки на библиотеку.
• resources/functions.json — метаданные о подключениях, библиотеках и функциях в элементе. Не изменяйте этот файл вручную.

Инструкции по использованию интеграции Git с пользовательскими функциями данных см. в разделе "Управление версиями и развертыванием функций данных пользователей".

Автоматически созданные системные файлы

Помимо файлов определения элемента каждый каталог элементов содержит один или два автоматически созданных системных файлов в зависимости от используемой версии:

• Каталог версии 1 содержит item.metadata.json и item.config.json. В версии 1 оба файла должны находиться в каталоге.
• Каталог версии 2 включает .platform. Этот файл содержит содержимое как item.metadata.json, так и item.config.json файлов. Если у вас есть этот файл, то у вас не может быть других двух файлов. Если вы используете версию 1 и фиксируете изменения, системные файлы автоматически обновляются до этой версии.

Примечание.

Ваш каталог должен содержать либо файлы item.metadata.json и item.config.json, либо файл . Вы не можете иметь все три файла.

Версия 2

Файл платформы

В версии 2 вместо двух исходных файлов в каждом каталоге элемента файл .platform объединяет все сведения в один файл, включая свойство $schema. Если у вас есть этот файл, то у вас не может быть других двух файлов.

{
    "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"
    }
}

Файл .platform содержит следующие атрибуты:

• version: номер версии системных файлов. Это число используется для обеспечения обратной совместимости. Номер версии элемента может отличаться.
• logicalId: (строка) Автоматически сгенерированный идентификатор межрабочего пространства, представляющий собой элемент и его представление в системе управления версиями.
• type: (строка) Тип элемента (семантическая модель, отчет и т. д.)
• displayName: (строка) Имя элемента.
• description: (необязательная строка) Описание элемента.

Если переименовать артефакт в рабочей области и у папки артефакта в Git есть суффикс '.', то после фиксации, displayName и каталог в Git будет совпадать.

Логический идентификатор связывает элемент в рабочей области с соответствующим элементом в ветке Git. Предполагается, что элементы с одинаковыми логическими идентификаторами совпадают. Логический Идентификатор сохраняет ссылку, даже если имя или каталог изменяются. Так как ветвь может быть синхронизирована с несколькими рабочими областями, можно иметь элементы в разных рабочих областях с одним логическим идентификатором, но одна рабочая область не может содержать два элемента с одинаковым логическим идентификатором. Логический идентификатор создается при подключении рабочей области к ветви Git или синхронизации нового элемента. Логический идентификатор необходим для правильной работы интеграции Git. Поэтому важно не изменять его каким-либо образом.

Примечание.

При фиксации изменений в Git версии 1 системные файлы автоматически обновляются до версии 2 вместе с изменениями. Кроме того, все новые файлы, экспортированные из режима разработчика Power BI Desktop, будут сохранены в формате файла версии 2.

Версия 1

Если вы используете версию 1, каждый каталог элементов имеет два файла:

• item.metadata.json
• item.config.json

{ 
    "type": "report", 
    "displayName": "All visual types",
    "description": "This is a report"
} 

{ 
    version: "1.0", 
    logicalId: "e553e3b0-0260-4141-a42a-70a24872f88d", 
} 

Файл метаданных

{ 
    "type": "report", 
    "displayName": "All visual types",
    "description": "This is a report"
} 

Файл item.metadata.json содержит следующие атрибуты:

• type: (строка) Тип элемента (семантическая модель, отчет и т. д.)
• displayName: (строка) Имя элемента
• description: (необязательная строка) Описание элемента

Чтобы переименовать элемент, измените displayName в файле item.metadata.json. Изменение имени папки не изменяет отображаемое имя элемента в рабочей области.

Файл конфигурации

{ 
    version: "1.0", 
    logicalId: "e553e3b0-0260-4141-a42a-70a24872f88d", 
} 

Файл item.config.json содержит следующие атрибуты:

• version: номер версии системных файлов. Это число используется для обеспечения обратной совместимости. Номер версии элемента может отличаться.
• logicalId: автоматически создаваемый идентификатор, действующий через рабочие области, представляющий элемент и его представление в системе управления версиями.

Логический идентификатор связывает элемент в рабочей области с соответствующим элементом в ветке Git. Предполагается, что элементы с одинаковыми логическими идентификаторами совпадают. Логический Идентификатор сохраняет ссылку, даже если имя или каталог изменяются. Так как ветвь может быть синхронизирована с несколькими рабочими областями, можно иметь элементы в разных рабочих областях с одним логическим идентификатором, но одна рабочая область не может содержать два элемента с одинаковым логическим идентификатором. Логический идентификатор создается при подключении рабочей области к ветви Git или синхронизации нового элемента. Логический идентификатор необходим для правильной работы интеграции Git. Поэтому важно не изменять его каким-либо образом.

Примечание.

При фиксации изменений в Git версии 1 системные файлы автоматически обновляются до версии 2 вместе с изменениями. Кроме того, все новые файлы, экспортированные из режима разработчика Power BI Desktop, будут сохранены в формате файла версии 2.

Примечание.

• Поле типа чувствительно к регистру. Не изменяйте способ автоматической генерации, иначе это может привести к сбою.
• Хотя обычно не следует изменять логический идентификатор или отображаемое имя элемента, одно исключение может быть в том случае, если вы создаете новый элемент путем копирования существующего каталога элементов. В этом случае необходимо изменить логический идентификатор и отображаемое имя на что-то уникальное в репозитории.

Связанный контент

Начните работу с интеграцией Git.