Интерфейс командной строки Glarus BI¶
Glarus BI поставляется с несколькими удобными командами CLI. Чтобы просмотреть список команд, запустите JAR-файл Glarus BI, указав параметр help.
Glarus BI выведет справочный текст для доступных команд.
api-documentation¶
Создаёт файл в формате markdown, содержащий документацию по всем методам API. Файл сохраняется как docs/api-documentation.md.
driver-methods | driver-methods _docs¶
Выводит список всех мультиметодов, доступных для реализации драйвером. Добавьте _docs, чтобы включить их документацию.
config-template¶
Генерирует файл Markdown с документацией и примером файла конфигурации в формате YAML. YAML-шаблон включает настройки Glarus BI и их значения по умолчанию. Glarus BI сохраняет файл как docs/configuring-metabase/config-template.md.
dump-to-h2 h2-filename & opts¶
Переносит данные из существующей базы данных в новую созданную базу данных H2 с указанным именем файла. Целевой файл H2 удаляется перед выгрузкой, если не указан флаг --keep-existing.
Опции:
-k, --keep-existing — Не удалять целевой файл H2, если он существует.-p, --dump-plaintext — Не шифровать выгруженное содержимое.
environment-variables-documentation¶
Генерирует файл markdown, содержащий документацию по переменным окружения, относящимся к настройке Glarus BI. Команда включает только переменные окружения, зарегистрированные как defsettings. Полный список переменных окружения см. в документации.
help command-name | help¶
Показать это справочное сообщение со списком действительных команд Glarus BI. Используйте help command-name для получения подробностей о конкретной команде.
load-from-h2 | load-from-h2 h2-connection-string¶
Переносит данные из существующей базы данных H2 в новую созданную базу данных MySQL или Postgres, указанную переменными окружения.
migrate direction¶
Выполняет миграцию базы данных. Допустимые опции для direction: up, force, down, print или release-locks.
profile¶
Запускает Glarus BI обычным способом и завершает работу. Полезно для профилирования времени запуска Glarus BI.
reset-password email-address¶
Сбрасывает пароль для пользователя с адресом электронной почты email-address.
rotate-encryption-key new-key¶
Меняет ключ шифрования базы данных Glarus BI. Переменная окружения MB_ENCRYPTION_SECRET_KEY должна быть установлена в текущий ключ, а параметр new-key должен быть новым ключом. new-key должен содержать не менее 16 символов.
version¶
Выводит информацию о версии Glarus BI и текущей системе.
Дополнительные полезные команды¶
SQL-оболочка для H2¶
Открывает SQL-оболочку для базы данных Glarus BI H2: