Знакомство с примером приложения
Пошаговый обзор демонстрационного админ-приложения из состава SQLly Embedded: статус и лицензирование, профили и подключения, метки, пользователи и запуск SQLly.
Пакет включает небольшое административное приложение (sample-app/, Node.js 20+, без зависимостей), которое демонстрирует все возможности SQLly Embedded. Оно выполняет роль ваш приложения: административная часть для профилей, меток и пользователей, и пользовательская часть, которая выполняет вход и открывает SQLly. Каждый экран ниже — тонкий слой над одной-двумя API управления вызовами, которые указаны под каждым скриншотом, чтобы вы могли увидеть, что будет вызывать ваше собственное приложение.
Эти скриншоты сделаны на настоящем мосте, привязанном к пробной лицензии, с базой данных SQL Server Northwind за ним.
Вход администратора
Статус и лицензирование
Статус является GET /manage/status Отображается как страница. Мост, запущенный без ключа или лицензионного файла, является нелицензированного: вы уже можете создавать и тестировать профили, но SQLly не запустится, пока установка не будет связана.
Подключитесь к sqlly.app запрашивает у sqlly.app код привязки (POST /api/embedded/links) и показывает его. Откройте sqlly.app, чтобы подтвердить перенаправляет владельца лицензии на sqlly.app, где он подтверждает тот же код и выбирает лицензию:
Спустя несколько секунд приложение администратора забирает ключ установки и передаёт его мосту с PUT /manage/license, и статус показывает лицензию:
Профили
Профиль — это набор подключений, который видит группа пользователей. Список показывает подключения каждого профиля и кому он назначен, вместе с Запустить для открытия SQLly от вашего имени с этим профилем.
Редактирование подключения
Редактор подключения предлагает все поля, которые поддерживает формат учётных данных для выбранного движка. Список движков и типы входа каждого движка берутся из GET /manage/engines. Тест проверяет всё, что заполнено на форме, сохранено оно или нет, и показывает собственный ответ движка прямо в поле:
Метки
Клиенты, проекты и окружения раскрашивают и группируют подключения в SQLly и задают правила безопасности. Пример приложения хранит один общий набор и отправляет его с каждым профилем, поэтому переименование метки обновляет каждое подключение, которое её использует.
Пользователи и места
Пользователи демо-приложения — его собственные учётные записи, каждому назначен один профиль. В вашем приложении пользователи и их доступ — всё как у вас уже есть. На странице также видно, кто прямо сейчас занимает место (GET /manage/seats), с Освободить место (DELETE /manage/seats/{user}).
Что видят ваши пользователи
Пользователи входят через корень приложения, а не через /admin:
Пока SQLly открыт, в статусе видно занятое место:
Чтение кода
| Файл | Что из этого следует взять |
|---|---|
lib/bridge.js | Полный клиент управления API: каждый вызов, обработка ошибок, тайм-ауты. Скопируйте его или перенесите. |
lib/credentials.js | Преобразует элементы формы и общие метки в sqlly-credentials document (документ). |
lib/sqllyapp.js | Часть, выполняемая на стороне sqlly.app: создать привязку и опрашивать ключ. |
server.js | Маршрутизация. GET /app/ — маршрут запуска; /admin/* — это админ-часть; /admin/link* отвечает за связывание. |
views/pages.js | HTML, включая injectLaunch, который устанавливает две глобальные переменные перед boot.js. |
test/ | node --test наборы тестов, которые запускают приложение против моста-заглушки. Хорошая модель, чтобы проверить свою интеграцию. |
Готовы заменить его? Создание собственного приложения разбирает каждую из этих задач в вашем собственном стеке.