Руководство пользователя
Это подробное руководство по полному рабочему сценарию Data Source Explorer (DSE).
Используйте его как единую справку по следующим задачам:
- поиск и обзор источников
- проверка и тестирование подключений
- просмотр объектов
- работа со Schema Catalog и Data Catalog
- настройка целевых выходных определений
- генерация deployables
- анализ результатов, графической схемы и экспортов
- сохранение workspace и конфигурации задания
1. Назначение приложения
DSE — это настольное приложение для операторов и инженеров, которое позволяет находить источники данных, изучать их структуру, подготавливать определения извлечения или маппинга и генерировать повторно используемые выходные артефакты.
Обычный рабочий поток выглядит так:
- выбрать цель и запустить Discover
- просмотреть дерево найденных источников
- проверить или изменить параметры подключения
- протестировать соединение
- загрузить таблицы / коллекции / buckets / другие объекты
- изучить структуру объекта и предпросмотр данных
- сформировать полезный Schema Catalog / Data Catalog
- настроить output targets, если нужны описанные объекты назначения
- сгенерировать deployables для одной или нескольких сред выполнения
- проверить созданные файлы и при необходимости построить графическую схему
2. Структура главного окна
Верхняя командная область
Здесь можно:
- выбрать язык интерфейса
- работать с меню Workspace
- открывать Plugins, Logs и Help
- переключать тему
- выбирать цель обнаружения и нажимать Discover
Левое дерево навигации
Слева отображается обнаруженная среда. В зависимости от контекста вы можете увидеть:
- базы данных
- таблицы
- представления
- коллекции
- buckets
- файловые/объектные хранилища
- облачные или SaaS-узлы
- узлы, связанные с mainframe
Правая рабочая область
Справа отображаются:
- сводка по выбранному источнику
- действия для выбранного источника
- списки объектов
- вкладки деталей, например table info, preview, row details, catalog schema, data catalog и output data
3. Начало работы
- Запустите приложение.
- При необходимости выберите язык интерфейса.
- В поле цели укажите машину, хост, среду или путь обнаружения.
- Выберите тип обнаружения, если доступно несколько режимов.
- Нажмите Discover.
Практический совет
- Начинайте с меньшего охвата.
- Перед редактированием соединений и генерацией результатов убедитесь, что выбран нужный контур.
- После успешного обнаружения сохраните workspace.
4. Обнаружение и исследование источников
После завершения обнаружения внимательно просмотрите левое дерево.
На что обращать внимание:
- иконки типов источников
- имена источников
- подсказки по host/endpoint
- статусы вроде reachable, offline, local only или configured
- дочерние узлы: базы, таблицы, коллекции, buckets, сервисы
Рекомендуемый порядок
- раскрывайте дерево постепенно
- выберите интересующий источник
- просмотрите сводку справа
- решите, нужно ли открыть детали, изменить подключение, удалить scope или переходить к загрузке объектов
5. Детали и изменение подключения
Для выбранного источника DSE может показывать действия:
- Open details
- Edit connection
- Remove scope
- Test connection
- Load tables
- Run sample query
- Generate deployables
- Compose targets
Open details
Используйте для просмотра технической информации по выбранному узлу/подключению в режиме чтения.
Edit connection
Используйте, если:
- источник найден, но требуются учетные данные
- нужно исправить host, port, database, service или path
- нужно задать override для connection string или endpoint
Рекомендуемая последовательность:
- изменяйте только нужные поля
- сохраните изменения
- сразу выполните Test connection
- после успешной проверки переходите к загрузке объектов или генерации
6. Тестирование соединения
Используйте Test connection перед любыми важными действиями.
Хороший тест подтверждает, что:
- endpoint доступен
- аутентификация работает
- база / сервис / bucket корректны
- плагин/провайдер действительно может работать с источником
Если тест не проходит:
- проверьте host, port, instance/service name
- проверьте учетные данные
- проверьте сеть, firewall и локальные ограничения
- проверьте, что нужный driver/plugin установлен и включен
- откройте Logs для детальной диагностики
7. Загрузка объектов и просмотр структуры
После успешного теста нажмите Load tables или аналогичную команду.
В зависимости от типа источника могут загрузиться:
- реляционные таблицы и представления
- документные коллекции
- buckets и measurements
- другие группы объектов
Как анализировать объекты
- выберите объект в списке
- просмотрите Table info или аналогичную вкладку
- откройте Preview для просмотра примеров строк/документов
- используйте Row details для детального просмотра конкретной записи
- просматривайте Catalog Schema и Data Catalog, если хотите превратить структуру в повторно используемое описание
8. Формирование Schema Catalog и Data Catalog
Schema Catalog
Используйте эту область, чтобы определить структурный набор объектов источника, которые важны для извлечения или последующего развертывания.
Data Catalog
Используйте эту область, чтобы обогатить или проверить выбранные поля и объекты с более прикладной, пользовательской точки зрения.
Хорошая практика
- держите каталог сфокусированным
- не добавляйте экспериментальные объекты без необходимости
- проверяйте имена объектов перед переходом к настройке targets
9. Генерация Output Data напрямую
Используйте Output Data, когда нужно получить файлы данных на основе выбранного каталога.
Это полезно для:
- проверочных запусков
- выборочного отбора данных
- операционной проверки
- подтверждения корректности маппинга и доступа к данным
Обычные типы выходных файлов:
- CSV
- Excel (
.xlsx) - итоговый JSON или лог-файлы
Перед крупным запуском:
- проверьте выбранные объекты
- проверьте форматы вывода
- проверьте ограничения по строкам
- проверьте выходную папку
10. Настройка output targets
Используйте Compose targets, когда нужен маппинг на целевую структуру, а не просто просмотр исходника.
Обычно вы работаете с тремя уровнями:
- доступные исходные строки/поля слева
- одна или несколько целевых сущностей по центру
- целевые объекты и mappings справа
Типовой процесс
- создайте целевой target
- выберите preset или тип целевой системы
- создайте один или несколько target objects
- выберите исходные строки/поля
- добавьте их в выбранный target object
- проверьте таблицу mappings
- исправьте предупреждения валидации
- сохраните target definition
Советы по валидации
Исправьте до сохранения:
- пустые имена targets
- дубли имён
- недопустимые имена полей для выбранной технологии
- отсутствующие mappings
11. Генерация deployables
Используйте Generate deployables, чтобы создать portable runner или связанные артефакты на основе каталога и/или сохранённых targets.
Режимы входа
DSE поддерживает два основных сценария:
- использовать текущий набор каталога напрямую
- использовать один или несколько saved output targets
Если включён режим сохранённых targets, можно добавлять targets из выпадающего списка, формировать multi-target набор, переключаться между chips и удалять targets из текущего задания.
Раздел Destination instance
Здесь задаётся, как deployable будет подключаться к целевой системе или интерпретировать target definition.
Проверьте такие поля, как:
- target category
- instance/site name
- host/IP
- port
- database/service/path
- user name
- password
- optional connection string override
Платформы и runtimes
Выберите одну или несколько платформ, затем один или несколько совместимых runtime identifiers.
Output options
Выберите, какие файлы будет выпускать runner, например:
- CSV
- Excel
Также проверьте:
- максимальное число строк на объект
- выходную папку
- нужно ли включать connection strings в генерируемую схему
Панель readiness
Перед генерацией прочитайте секцию preflight/readiness.
Она должна подсказать, отсутствуют ли:
- платформы
- runtimes
- форматы вывода
- выходная папка
- корректное входное определение
Генерация
Когда конфигурация готова:
- проверьте выбранные targets и chips
- проверьте destination values
- проверьте платформы, runtimes, форматы и папку
- нажмите Generate
12. Сохранение конфигурации задания
При выходе со страницы Generate deployables приложение может спросить, сохранять ли конфигурацию job.
Если согласиться
При следующем открытии могут восстановиться:
- выбранные saved targets
- активный chip
- значения destination instance
- выбранные платформы и RID
- output options
- output folder
- limits по строкам
- связанные параметры генерации
Если отказаться
Временная конфигурация будет очищена.
13. Просмотр созданных deployables
После генерации DSE показывает область итогов по deployables.
Её можно использовать, чтобы:
- просмотреть созданные элементы
- открыть выходную папку
- открыть результаты
- сразу запустить runner, если доступен путь запуска
14. Анализ результатов выполнения
Окно результатов — это основная поверхность послезапусковой проверки.
Оно обычно показывает:
- список созданных файлов
- тип и размер файлов
- действия по открытию файлов
- табличный preview для CSV/Excel
- текстовый preview для JSON/log/text
- summary chips с количеством файлов, типов, доступностью preview и состоянием schema graph
Рекомендуемый порядок проверки
- откройте окно результатов
- выберите каждый файл хотя бы один раз
- просмотрите вкладки листов или текст
- проверьте количество строк и имена колонок
- при необходимости откройте физический файл отдельно
15. Генерация графической схемы
В окне результатов используйте Generate schema, чтобы построить визуальный граф выполнения.
Граф может связывать:
- Data Source Explorer
- найденные источники
- выбранные объекты: tables, collections, buckets
- настроенные targets
- созданные output files
Это полезно для:
- документации
- операционной проверки
- проверки дизайна
- объяснения процесса другим участникам
Во время построения индикатор прогресса должен показывать, что операция выполняется.
Save graph
Используйте Save graph, чтобы экспортировать схему в поддерживаемый формат, например:
- SVG
- PNG
- BMP
- draw.io
- PlantUML / UML text
- HTML preview
16. Workspaces
Используйте меню Workspace для управления повторно используемыми сессиями.
Типичные действия:
- открыть новый workspace
- открыть существующий
- recent workspaces
- сохранить текущий
- сохранить как
- import/export XML
- сохранить и выйти
Рекомендация
- сохраняйте после успешного discovery
- сохраняйте после работы с каталогом
- сохраняйте после настройки targets, если mapping важен
- используйте Save As перед крупными экспериментами
17. Plugins, Logs и Help
Plugins
Откройте Plugins, чтобы проверить доступные провайдеры/расширения. Если нужный тип источника отсутствует или ведёт себя необычно, сначала проверьте состояние плагина.
Logs
Открывайте Logs, когда нужны технические детали по discovery, connection, generation или runtime-проблемам.
Help
Открывайте Help для поиска по документации. Нажимайте F1 для контекстной помощи.
18. Рекомендуемая последовательность для чистого рабочего запуска
- откройте или создайте workspace
- выполните discovery нужного периметра
- выберите источник и просмотрите его детали
- при необходимости измените connection
- выполните test connection
- загрузите objects
- просмотрите preview и структуру
- сформируйте каталог
- настройте targets, если требуется явный mapping назначения
- откройте generate deployables
- выберите saved targets или catalog input
- перепроверьте destination settings, platforms, runtimes, formats и folder
- выполните генерацию
- откройте summary, затем results
- проверьте файлы и preview
- при необходимости постройте и сохраните graphical schema
- сохраните workspace
19. Контрольный список по устранению проблем
Discovery находит слишком много или слишком мало
- сузьте scope
- проверьте тип target
- убедитесь, что выбран нужный контур
Test connection не проходит
- проверьте endpoint
- проверьте учётные данные
- проверьте database/service/path
- проверьте сеть и firewall
- откройте Logs
Объекты не появляются после загрузки
- сначала убедитесь, что test connection успешен
- проверьте права на стороне источника
- выполните reload после исправления connection settings
Генерация deployables заблокирована
- посмотрите readiness panel
- убедитесь, что выбраны хотя бы одна платформа и один runtime
- убедитесь, что заданы форматы и выходная папка
- убедитесь, что входное определение корректно
Результаты выглядят неполными
- проверьте limits по строкам
- проверьте правильность выбранных targets/objects
- откройте файлы напрямую с диска для сравнения
- изучите summary JSON/log артефакты для дополнительной информации
20. Итоговые рекомендации
Для наиболее надёжной работы:
- организуйте workspaces по окружениям или проектам
- проверяйте connections до загрузки и генерации
- держите target definitions аккуратными и понятными
- проверяйте созданные файлы перед передачей другим
- используйте экспорт graphical schema для трассируемости и документации