Пользовательский интерфейс IDE

Studio IDE — это инструмент, который позволяет разработчикам легко создавать, тестировать, запускать проекты dbt и управлять их версиями, а также улучшать управление данными — и всё это прямо в браузере. Используйте Studio IDE, чтобы компилировать код dbt в SQL и выполнять его непосредственно в вашей базе данных — без командной строки!

На этой странице приведены подробные определения и терминология элементов пользовательского интерфейса, которые помогут вам с лёгкостью ориентироваться в интерфейсе Studio IDE.

Интерфейс Studio IDE включает управление версиями вверху слева, файлы/папки и поиск слева, редактор справа, палитру команд вверху и команды/консоль внизу

Базовый макет

Studio IDE упрощает ваш рабочий процесс и предлагает привычную компоновку интерфейса с файлами и папками слева, редактором справа и информацией о командах и консоли внизу.

Боковое меню

Ссылка на репозиторий Git, кнопка сайта документации, меню управления версиями и проводник файлов

1. Ссылка на репозиторий Git: Ссылка на репозиторий Git, расположенная в верхней левой части Studio IDE, открывает ваш репозиторий на той же активной ветке. Она также отображает имя репозитория и имя активной ветки.

   • Примечание: Эта функция доступна только для репозиториев GitHub или GitLab в многоарендных аккаунтах dbt.

2. Кнопка сайта документации: Нажатие на значок книги сайта документации рядом со ссылкой на репозиторий Git открывает сайт документации dbt. Сайт использует последние артефакты dbt, созданные в IDE с помощью команды dbt docs generate (только dbt v1) из панели команд.

3. Управление версиями: Мощный раздел управления версиями в Studio IDE содержит все элементы, связанные с git, включая кнопку действий Git и раздел Изменения.

4. Проводник файлов: Проводник файлов отображает дерево файлов вашего репозитория. Вы можете:

   • Нажать на любой файл в дереве, чтобы открыть его в редакторе.
   • Перетаскивать файлы между директориями, чтобы перемещать их.
   • Щёлкнуть файл правой кнопкой мыши, чтобы открыть подменю с такими действиями, как копирование имени, копирование относительного пути, копирование в виде ref, скачивание, дублирование, переименование и удаление.
   • Использовать индикаторы файлов, расположенные справа от имени файла или папки, чтобы видеть, какие изменения или действия были выполнены:
     • Unsaved (•) — Studio IDE обнаружил несохранённые изменения в файле/папке
     • Modification (M) — Studio IDE обнаружил изменение существующих файлов/папок
     • Added (A) — Studio IDE обнаружил добавленные файлы
     • Deleted (D) — Studio IDE обнаружил удалённые файлы

Панель команд и состояния

Используйте панель команд для ввода команд dbt, переключения 'Defer' и просмотра текущего состояния IDE

5. Панель команд: Панель команд, расположенная в нижней левой части Studio IDE, используется для вызова команд dbt. При вызове команды соответствующие журналы отображаются на выдвижной панели истории вызовов.

6. Меню Defer: Меню Defer позволяет разработчикам настраивать среду для отложенного разрешения ссылок:

   • Среда разработки: То же самое, что отключение defer. Все вышестоящие модели собираются только в среде разработки. Полезно для изолированного тестирования.
   • Поведение dbt по умолчанию: Используется промежуточная среда, если она настроена, в противном случае используется рабочая среда. Рекомендуемая конфигурация для большинства сценариев использования.
   • Пользовательская среда: Выберите среду для defer из доступных в проекте.
   Настройте среду `defer`.

Подробнее см. в разделе Использование defer в dbt.

7. Состояние: Кнопка состояния Studio IDE, расположенная в нижней правой части Studio IDE, отображает текущее состояние подключения к хранилищу данных и состояние языкового сервера (LSP) dbt, если вы используете dbt v2, или состояние сервера движка, если вы используете dbt v1. Она содержит ссылки для быстрого перехода к настройкам среды и учётным данным пользователя.

   Просмотрите состояния подключений для вашей учётной записи.

8. Версия dbt: Текущая версия dbt, используемая в вашей среде разработки. Вы можете задать Персональное переопределение версии, которое изменит версию dbt только для вашей среды разработки.

   Просмотрите и настройте версию среды разработки.

9. Дополнительные инструменты: Состояние проекта и меню параметров с дополнительными действиями и информацией о Studio IDE:

   • Состояние проекта: Если в запусках среды разработки есть неустранённые ошибки или предупреждения, их количество отображается в этой области. Нажатие на них откроет вкладку Проблемы.
   • Меню параметров: Откройте меню параметров, нажав на меню с тремя точками в правом нижнем углу Studio IDE. Это меню содержит глобальные параметры:
     • Просмотреть сведения о состоянии: Просмотрите более подробную информацию о состоянии подключения.
     • Перезапустить Studio: Все несохранённые данные будут потеряны.
     • Переустановить зависимости: Перезаписывает зависимости проекта, устанавливая их заново.
     • Очистить проект dbt: Выполняет команду dbt clean для вашего проекта.
     • Автоматически исправить предупреждения об устаревших возможностях: Запускает инструмент автоматического исправления dbt. Помогает подготовиться к переходу на dbt v2.
     Меню IDE с дополнительной информацией и действиями.

Строка поиска и палитра команд

Studio IDE предоставляет инструменты для быстрой навигации по файлам проекта, поиска информации, выполнения команд и замены синтаксических конструкций всего за несколько щелчков в интерфейсе, знакомом пользователям популярных IDE.

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

1. Поиск и замена
2. Палитра команд

Поиск и замена

Функция поиска позволяет быстро находить определённые термины или фразы и заменять их одним нажатием кнопки.

Находите определённые термины в файлах и быстро заменяйте их.

1. Переключайтесь между навигацией по дереву файлов и поиском.
2. Ищите слова или фразы. Уточняйте поиск с учётом регистра и/или целых слов. Вы также можете ввести слова или фразы для замены. Нажмите значок рядом с полем Заменить, чтобы заменить все вхождения.
3. Перемещайтесь по результатам поиска. Нажмите на запись, чтобы открыть соответствующий файл и выделить её на экране. Если вы ввели текст для замены, вы увидите предварительный просмотр нового синтаксиса. Нажмите значок рядом с записью, чтобы заменить текст содержимым поля Заменить.

Палитра команд

Палитра команд упрощает навигацию по проекту dbt, позволяя искать файлы, содержимое и символы, просматривать и выполнять команды IDE, просматривать последние файлы и многое другое. Нажмите на палитру команд, чтобы увидеть доступные варианты. Для действий, поддерживающих сочетания клавиш, они отображаются справа от текста.

Палитра команд позволяет быстро перемещаться по проекту и выполнять команды.

• Перейти к файлу: Ищите файлы в текущем проекте и открывайте их в новой вкладке.
• Показать и выполнить команды: Просматривайте и выполняйте команды, связанные с навигацией и настройками IDE. Примечание: команды dbt (такие как run и build) доступны только в меню Панель команд в консоли; палитра команд в настоящее время их не поддерживает.
• Поиск текста: Ищите текст по всему проекту и открывайте файлы из результатов или отправляйте результаты в раздел поиска и замены для массовых изменений.
• Перейти к символу в редакторе: Быстро переходите к символам в текущем файле.
• Ещё: Отображает расширенные функции, такие как Перейти к строке/столбцу, Перейти к символу в рабочей области, и поиск только в открытых файлах.

Перейти к файлу.

Показать и выполнить команды.

Поиск текста.

Перейти к символу в редакторе.

More.

Функции редактирования

Studio IDE предлагает удобные инструменты и варианты компоновки, которые упрощают написание кода dbt и совместную работу с коллегами.

Используйте редактор файлов, раздел управления версиями и кнопку сохранения в процессе разработки

1. Редактор файлов — Редактор файлов — это место, где вы редактируете код. Вкладки разделяют область для каждого открытого файла, а несохранённые файлы помечаются синим индикатором во вкладке. Вы можете редактировать, форматировать или линтить файлы и выполнять dbt‑команды в защищённой основной git‑ветке. Поскольку Studio IDE не позволяет выполнять коммиты в защищённую ветку, он предлагает закоммитить изменения в новую ветку.

   • Используйте интуитивно понятные сочетания клавиш, чтобы упростить разработку для себя и своей команды.

2. Кнопка Save — В редакторе есть кнопка Save, которая сохраняет редактируемые файлы. Нажатие кнопки или использование сочетаний Command‑S или Control‑S сохраняет содержимое файла. Для предварительного просмотра результатов в консоли сохранять файл не требуется, но это необходимо, чтобы изменения участвовали в dbt‑выполнении. Во вкладке редактора несохранённые изменения отмечаются синим значком.

3. Version Control — Это меню содержит все элементы, связанные с git, включая кнопку действий Git. Кнопка обновляет доступные действия в зависимости от состояния редактора, например предлагает подтянуть удалённые изменения, закоммитить и синхронизировать изменения, создать merge/pull request при необходимости или удалить локальные ветки, удалённые в удалённом репозитории.

   • Выпадающее меню кнопки действий Git позволяет откатывать изменения, обновлять состояние Git, создавать merge/pull request, выполнять prune веток и переключать ветки.
   • Вы также можете разрешать конфликты слияния, а дополнительные сведения о git см. в разделе Основы управления версиями.
   • Меню Version Control Options — Раздел Changes, расположенный под кнопкой действий Git, отображает все изменения файлов с момента последнего коммита. Вы можете нажать на изменение, чтобы открыть представление Git Diff View и увидеть построчные изменения. Также можно щёлкнуть правой кнопкой мыши по любому файлу и использовать специфические для файла опции в меню Version Control Options.

Щёлкните изменённые файлы правой кнопкой мыши, чтобы открыть меню параметров управления версиями

• Используйте параметр Очистить ветки, чтобы удалить локальные ветки, которые уже удалены из удалённого репозитория. При его выборе открывается всплывающее модальное окно, где вы можете подтвердить удаление определённых локальных веток, поддерживая порядок в управлении ветками. Обратите внимание, что текущая ветка не будет удалена. Очистка веток недоступна для управляемых репозиториев, поскольку у них нет типичной настройки удалённого репозитория, что не позволяет удалять удалённые ветки.

Дополнительные функции редактирования

• Minimap — Minimap (контур кода) даёт обзор исходного кода на высоком уровне, что полезно для быстрой навигации и понимания структуры. Minimap файла отображается в правом верхнем углу редактора. Чтобы быстро перейти к нужному разделу файла, нажмите на заштрихованную область.

Используйте мини-карту для быстрой навигации и понимания кода

• Git Diff View — При нажатии на файл в разделе Changes меню Version Control изменённый файл откроется в режиме Git Diff View. Редактор покажет предыдущую версию слева и внесённые изменения справа.

Представление различий Git отображает предыдущую версию слева, а внесённые изменения справа в редакторе

• Вкладка консоли Markdown Preview — Вкладка Markdown Preview отображает предварительный просмотр markdown‑кода вашего файла .md из репозитория и автоматически обновляется по мере редактирования.

Вкладка консоли Предпросмотр Markdown отображает результат обработки кода markdown под вкладкой редактора.

• Вкладка консоли CSV Preview — Вкладка CSV Preview отображает данные из CSV‑файла в виде таблицы и автоматически обновляется при редактировании файла в директории seed.

Просматривайте код CSV на вкладке консоли Предпросмотр CSV под вкладкой редактора.

Раздел консоли

Раздел консоли, расположенный под редактором файлов, включает различные вкладки и кнопки, которые помогают выполнять задачи, такие как предварительный просмотр, компиляция, сборка и просмотр DAG. Ниже приведены подробности по вкладкам и кнопкам консоли.

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

1. Кнопка Preview — При нажатии кнопки Preview выполняется SQL из активного редактора файлов независимо от того, сохранён он или нет, а результаты отправляются во вкладку консоли Results. Вы также можете выполнить предварительный просмотр выделенного фрагмента сохранённого или несохранённого кода, выделив его и нажав Preview.

Ограничения количества строк в IDE

Studio IDE по умолчанию ограничивает количество возвращаемых строк, однако вы также можете задать количество возвращаемых записей. Подробнее см. в следующих подпунктах:

• Ограничение в 500 строк: Чтобы IDE не возвращала слишком много данных и не вызывала проблем с браузером, dbt автоматически устанавливает ограничение в 500 строк при использовании кнопки предпросмотра. Вы можете изменить его, добавив limit your_number в конец SQL-запроса. Например, SELECT * FROM table limit 100 вернёт до 100 строк. Помните, что необходимо явно написать limit your_number, а не формировать его с помощью макроса.
• Изменение ограничения строк по умолчанию: В dbt версии 1.6 или выше вы можете изменить стандартное ограничение в 500 строк, отображаемых на вкладке Результаты при выполнении запроса. Чтобы изменить настройку, нажмите Изменить отображение строк рядом с отображаемыми строками. Помните, что нельзя установить значение выше 10,000 строк. Если вы обновите страницу или завершите сеанс разработки, ограничение по умолчанию вернётся к 500 строкам.
• Указание количества возвращаемых записей: IDE также поддерживает SELECT TOP #, который задаёт количество возвращаемых записей.

2. Кнопка Compile — Кнопка Compile компилирует сохранённый или несохранённый SQL‑код и отображает его во вкладке Compiled code.

Начиная с dbt v1.6 или выше, при сохранении изменений в модели вы можете скомпилировать её код с контекстом, специфичным для этой модели. Этот контекст похож на тот, который используется при сборке модели, и включает полезные переменные контекста, такие как {{ this }} или {{ is_incremental() }}.

3. Кнопка Build — Кнопка Build позволяет быстро получить доступ к dbt‑командам, связанным с активной моделью в редакторе файлов. Доступные команды включают dbt build, dbt test и dbt run, с вариантами выполнения только текущего ресурса, ресурса и его upstream‑зависимостей, ресурса и его downstream‑зависимостей или ресурса со всеми зависимостями. Это меню доступно для всех исполняемых узлов.

4. Кнопка проверки кода — Кнопка Проверка кода запускает линтер для активного файла в редакторе файлов. Линтер проверяет код на синтаксические ошибки и нарушения стиля и отображает результаты на вкладке Качество кода.

5. dbt Wizard — dbt Wizard — это новый рекомендуемый агентный инструмент со встроенным управлением, интегрированный в Studio IDE, который использует контекст вашего проекта, чтобы помочь вам быстрее разрабатывать изменения dbt с соблюдением правил управления. Он может создавать или перерабатывать модели, семантические модели, тесты и документацию по запросам на естественном языке.

   dbt Copilot — это отдельный от dbt Wizard инструмент встроенной ИИ-помощи dbt, обеспечивающий генерацию SQL, документации, тестов и семантических моделей одним нажатием в Studio IDE, Canvas и Insights.

6. Вкладка Commands — Просматривайте последние выполненные dbt‑команды из текущей IDE‑сессии, их результаты и соответствующие системные логи.

7. Вкладка Проблемы — Для использования вкладки проблем необходимо работать с dbt v2. Получайте информацию о проблемах в проекте dbt, которые могут помешать его правильному выполнению в dbt v2, во время редактирования и до запуска.

Результаты предпросмотра отображаются на вкладке консоли Результаты

8. Вкладка Results — Вкладка Results отображает результаты последнего Preview в табличном виде.

Результаты предпросмотра отображаются на вкладке консоли Результаты

9. Вкладка Code quality — Вкладка Code quality отображает результаты работы линтера для активного файла в редакторе. Она позволяет просматривать ошибки кода, управлять качеством и показывает используемую версию SQLFluff.

10. Вкладка Compiled code — При выполнении Compile генерируется скомпилированный код. Вкладка Compiled code отображает скомпилированный SQL‑код для активного файла в редакторе.

Результаты компиляции отображаются на вкладке Скомпилированный код

11. Вкладка Lineage — Вкладка Lineage в редакторе файлов отображает lineage активной модели или DAG. По умолчанию показываются две степени зависимостей в обе стороны (2+model_name+2), однако вы можете изменить отображение на +model+ (полный DAG). Возможности работы с lineage:
    • Дважды щёлкните по узлу в DAG, чтобы открыть соответствующий файл в новой вкладке
    • Разворачивайте или сворачивайте DAG, используя синтаксис выбора узлов
    • Обратите внимание, что флаг --exclude не поддерживается

Просматривайте происхождение и зависимости ресурсов на вкладке Происхождение данных

История вызовов (Invocation history)

Панель Invocation History хранит историю вызовов dbt в IDE. Когда вы запускаете команду, например dbt run, на панели отображаются её журналы.

Вы можете открыть панель несколькими способами:

• Нажав на иконку ^ рядом с Command bar в нижнем левом углу страницы
• Введя dbt‑команду и нажав Enter
• Или нажав Control‑backtick (или Ctrl + `)

Выдвижная панель истории вызовов содержит журнал и подробности всех ваших вызовов dbt.

1. Список Invocation History — Левая панель Invocation History Drawer отображает список предыдущих вызовов в Studio IDE, включая команду, имя ветки, статус выполнения и затраченное время.

2. Invocation Summary — Блок Invocation Summary, расположенный над System Logs, отображает информацию о выбранной команде из списка Invocation History, такую как команда, её статус (Running, если выполнение ещё продолжается), активная git‑ветка и время запуска команды.

3. Переключатель System Logs — Переключатель System Logs, расположенный под Invocation Summary, позволяет просматривать полный stdout и debug‑логи за всё время выполнения команды.

4. Кнопка Command Control — Используйте кнопку Command Control, расположенную справа, чтобы управлять выполнением команды, отменять или перезапускать выбранный запуск.

Список истории вызовов отображает предыдущие вызовы в IDE

5. Вкладка Node Summary — При нажатии на вкладки статусов результатов список узлов фильтруется по соответствующему статусу. Доступные статусы: Pass (успешное выполнение узла), Warn (тест выполнен с предупреждением), Error (ошибка базы данных или сбой теста), Skip (узлы не выполнены из‑за ошибки upstream), Queued (узлы, которые ещё не были выполнены).

6. Переключатель Node result — После выполнения dbt‑команды информация о каждом выполненном узле доступна в переключателе Node Result, который включает сводку и debug‑логи. Список Node Results содержит все узлы, задействованные в выполнении команды.

7. Список Node result — Список Node result отображает все результаты узлов, использованные в dbt‑запуске, и позволяет фильтровать их по вкладкам статусов результатов.

Модальные окна и меню

Используйте меню и модальные окна для взаимодействия с Studio IDE и доступа к полезным опциям, которые помогают в процессе разработки.

Меню вкладки редактора

Чтобы взаимодействовать с открытыми вкладками редактора, щёлкните правой кнопкой мыши по любой вкладке и получите доступ к опциям меню вкладки файла.

Щёлкните вкладку правой кнопкой мыши, чтобы просмотреть параметры меню вкладки редактора

Глобальное сочетание клавиш для команд

Глобальное сочетание клавиш для команд предоставляет быстрый доступ к действиям в Studio IDE, таким как действия git, специализированные команды dbt, компиляция и предпросмотр, а также другим действиям. Чтобы открыть меню, используйте Command-P или Control-P.

История команд содержит журнал и подробности всех ваших вызовов dbt.

Модальное окно статуса Studio IDE

Модальное окно статуса Studio IDE отображает текущее сообщение об ошибке и debug‑логи сервера. Также здесь доступна опция перезапуска Studio IDE. Открывается нажатием на кнопку статуса Studio IDE.

История команд содержит журнал и подробности всех ваших вызовов dbt.

Commit в новую ветку

Редактируйте код напрямую в защищённой основной git‑ветке и, когда будете готовы, коммитьте изменения в новую ветку.

Зафиксируйте изменения в новой ветке

Модальное окно Commit Changes

Модальное окно Commit Changes доступно через кнопку действий Git для коммита всех изменений или через меню Version Control Options для коммита отдельных изменений. После ввода сообщения коммита вы можете использовать это окно для коммита и синхронизации выбранных изменений.

Модальное окно фиксации изменений позволяет пользователям фиксировать изменения в своей ветке.

Модальное окно Change Branch

Модальное окно Change Branch позволяет переключать git‑ветки в Studio IDE. Оно доступно через ссылку Change Branch или кнопку Git actions в меню Version control.

Модальное окно фиксации изменений позволяет пользователям менять ветку.

Модальное окно Prune branches

Модальное окно Prune branches позволяет удалять локальные ветки, которые были удалены из удалённого репозитория, поддерживая порядок в управлении ветками. Оно доступно через кнопку Git actions в меню Version control. Обратите внимание, что текущая ветка удалена не будет. Функция prune недоступна для managed repositories, так как у них отсутствует типичная удалённая конфигурация, что делает удаление удалённых веток невозможным.

Модальное окно очистки веток позволяет пользователям удалять локальные ветки, которые уже удалены из удалённого репозитория.

Модальное окно Revert Uncommitted Changes

Модальное окно Revert Uncommitted Changes используется для отката изменений в IDE. Оно доступно через опцию Revert File в меню Version Control Options либо через кнопку Git Actions, если в IDE есть сохранённые, но не закоммиченные изменения.

Модальное окно фиксации изменений позволяет пользователям менять ветку.

Нашли ошибку?

Создать GitHub Issue