Знакомство с примером приложения

Пошаговый обзор демонстрационного админ-приложения из состава SQLly Embedded: статус и лицензирование, профили и подключения, метки, пользователи и запуск SQLly.

Пакет включает небольшое административное приложение (sample-app/, Node.js 20+, без зависимостей), которое демонстрирует все возможности SQLly Embedded. Оно выполняет роль ваш приложения: административная часть для профилей, меток и пользователей, и пользовательская часть, которая выполняет вход и открывает SQLly. Каждый экран ниже — тонкий слой над одной-двумя API управления вызовами, которые указаны под каждым скриншотом, чтобы вы могли увидеть, что будет вызывать ваше собственное приложение.

Эти скриншоты сделаны на настоящем мосте, привязанном к пробной лицензии, с базой данных SQL Server Northwind за ним.

Вход администратора

Карточка входа администратора в демо-приложении с полями имени пользователя и пароля
Админка живет по адресу /admin. Учетная запись по умолчанию — sqlly-admin / GoodLittlePiggy, и приложение отказывается слушать что-либо за пределами loopback, пока вы не поменяете их в sample-app/config.json.

Статус и лицензирование

Статус является GET /manage/status Отображается как страница. Мост, запущенный без ключа или лицензионного файла, является нелицензированного: вы уже можете создавать и тестировать профили, но SQLly не запустится, пока установка не будет связана.

Страница состояния моста сообщает, что мост работает, но не привязан к лицензии, и показывает кнопку Подключиться к sqlly.app
Не лицензировано: карточка «Подключить эту установку к sqlly.app» запускает процесс привязки.

Подключитесь к sqlly.app запрашивает у sqlly.app код привязки (POST /api/embedded/links) и показывает его. Откройте sqlly.app, чтобы подтвердить перенаправляет владельца лицензии на sqlly.app, где он подтверждает тот же код и выбирает лицензию:

Демо-приложение с большим кодом сопряжения и кнопкой «Открыть sqlly.app для подтверждения» — ожидает одобрения
Админ-приложение показывает код и опрашивает sqlly.app в фоне (POST /api/embedded/links/token).
Страница sqlly.app «Link an install to your account»: имя установки, совпадающий код и выбранная пробная лицензия, а также кнопки Approve link и Deny.
На sqlly.app владелец видит, какая установка запрашивает доступ, проверяет код, выбирает лицензию и одобряет. Каждая привязанная установка получает собственный ключ, который можно отозвать со страницы Embedded владельца.

Спустя несколько секунд приложение администратора забирает ключ установки и передаёт его мосту с PUT /manage/license, и статус показывает лицензию:

Страница состояния моста у подключённой установки: режим Connected, лицензия в порядке, пробный план SQLly Embedded, занято 0 из 1 мест, привязанный аккаунт sqlly.app и детали лицензии
Привязано: план, занятые места, конец периода, аккаунт, к которому привязана лицензия (с кнопками Управление на sqlly.app и Отвязать), и сведения, которые сообщает мост. Регистрация на sqlly.app теперь вызывает POST /manage/license/checkin.

Профили

Профиль — это набор подключений, который видит группа пользователей. Список показывает подключения каждого профиля и кому он назначен, вместе с Запустить для открытия SQLly от вашего имени с этим профилем.

Список профилей со строкой создания и двумя профилями: Аналитики – Northwind и Поддержка – только для чтения; у каждого кнопки Запустить, Изменить и Удалить
Создание профиля — это PUT /manage/profiles/{id} с пустым документом учетных данных; мост сохраняет его и проверяет каждое последующее изменение.
Страница профиля «Analysts – Northwind» с зелёным результатом проверки подключения и таблицей из двух подключений SQL Server, каждое помечено как «Подключено» и имеет кнопки «Тест», «Редактировать» и «Удалить».
Подключения профиля, каждое тестируется на месте. Тест вызывает POST /manage/test-connection с документом, содержащим только это подключение; «Запустить SQLly с этим профилем» выпускает токен для администратора.

Редактирование подключения

Редактор подключения предлагает все поля, которые поддерживает формат учётных данных для выбранного движка. Список движков и типы входа каждого движка берутся из GET /manage/engines. Тест проверяет всё, что заполнено на форме, сохранено оно или нет, и показывает собственный ответ движка прямо в поле:

Редактор подключения к SQL Server: сервер, база данных, метки, замаскированный пароль, параметры безопасности и TLS, зелёный результат проверки над кнопками «Сохранить подключение», «Проверить», «Сохранить и проверить» и «Отмена»
Сервер, метки (окружение, клиент, проект), аутентификация, правила безопасности и TLS. Пароли остаются на вашем сервере: их хранит мост, а браузер никогда их не получает.

Метки

Клиенты, проекты и окружения раскрашивают и группируют подключения в SQLly и задают правила безопасности. Пример приложения хранит один общий набор и отправляет его с каждым профилем, поэтому переименование метки обновляет каждое подключение, которое её использует.

Страница меток на вкладке Клиенты: форма добавления клиента с цветом, эмодзи или картинкой-иконкой и флагами безопасности, плюс два клиента в списке с иконками и количеством подключений
Клиенты и проекты получают цвет, иконку (эмодзи сохраняется как изображение, или можно загрузить своё) и необязательные флаги безопасности.
Страница меток на вкладке Окружения: перечислены Dev, Test, Staging и Production, у Production отмечен флаг Считать production
Четыре окружения SQLly. Production помечено как production, поэтому SQLly показывает панель только для чтения и запрашивает подтверждение перед изменениями.
Форма редактирования клиента для Northwind Traders с именем, цветом, эмодзи-иконкой и полным набором флажков безопасности
Каждый флаг безопасности, который поддерживает формат учетных данных, — например, разрешение только на SELECT или подтверждение изменений данных, — применяется SQLly для всех, кто открывает профиль с этой меткой.

Пользователи и места

Пользователи демо-приложения — его собственные учётные записи, каждому назначен один профиль. В вашем приложении пользователи и их доступ — всё как у вас уже есть. На странице также видно, кто прямо сейчас занимает место (GET /manage/seats), с Освободить место (DELETE /manage/seats/{user}).

Страница пользователей: занято мест 1 из 1, предупреждение, что два пользователя превышают пробный лимит в одно место, строка создания пользователя и два пользователя, один из которых занял место, с кнопкой «Освободить место»
dana.analyst занимает единственное место пробной версии, пока SQLly открыт; sam.support получит отказ с seat_limit, пока оно не освободится. Запуск от имени пользователя открывает SQLly точно так, как видит его этот пользователь.
Форма редактирования пользователя dana.analyst с полями имени пользователя, нового пароля и профиля
Пользователь — это имя пользователя, пароль (scrypt-хэш в sample-app/data) и профиль.

Что видят ваши пользователи

Пользователи входят через корень приложения, а не через /admin:

Карточка «Вход в SQLly» для конечного пользователя
Пользовательская часть примера приложения. В вашем продукте это уже имеющийся вход.
Страница приветствия для dana.analyst с указанием профиля Analysts – Northwind и кнопкой Open SQLly
«Open SQLly» ведёт в /app/, где создаётся токен запуска (POST /manage/tokens), и SQLly открывается с ним. Закрытие вкладки SQLly освобождает место.
SQLly, работающий в браузере через мост: в проводнике отображаются подключения Northwind для production и staging, в редакторе находится SELECT-запрос к Orders и Customers под панелью PRODUCTION только для чтения, а сетка результатов показывает 25 строк.
SQLly в браузере, который общается с SQL Server через мост. В строке состояния видны метки профиля, действуют правила безопасности окружения Production, а редактор доступен только для чтения, пока его не разблокируют.

Пока SQLly открыт, в статусе видно занятое место:

Страница статуса моста показывает 1 из 1 занятых мест и 1 активную сессию
Места считаются по одновременным пользователям: это место освобождается, как только dana.analyst закроет вкладку и истечёт срок действия токена.

Чтение кода

ФайлЧто из этого следует взять
lib/bridge.jsПолный клиент управления API: каждый вызов, обработка ошибок, тайм-ауты. Скопируйте его или перенесите.
lib/credentials.jsПреобразует элементы формы и общие метки в sqlly-credentials document (документ).
lib/sqllyapp.jsЧасть, выполняемая на стороне sqlly.app: создать привязку и опрашивать ключ.
server.jsМаршрутизация. GET /app/ — маршрут запуска; /admin/* — это админ-часть; /admin/link* отвечает за связывание.
views/pages.jsHTML, включая injectLaunch, который устанавливает две глобальные переменные перед boot.js.
test/node --test наборы тестов, которые запускают приложение против моста-заглушки. Хорошая модель, чтобы проверить свою интеграцию.

Готовы заменить его? Создание собственного приложения разбирает каждую из этих задач в вашем собственном стеке.