digna CLI Reference 2024.09¶
2024-08-24
Основы CLI¶
help¶
Опция --help предоставляет информацию о доступных командах и их использовании. Существует два основных способа использования этой опции:
-
Отображение общей справки:
Используйте --help сразу после ключевого слова dignacl
bash dignacli --help -
Получение справки по конкретной команде:
Для подробной информации о конкретной команде добавьте --help к этой команде. Например, чтобы получить справку по команде add-user, выполните: bash dignacli add-user --help
### вывод:
- Описание команды: Даёт подробное описание того, что делает команда.
- Синтаксис: Показывает точный синтаксис, включая обязательные и необязательные аргументы.
- Опции: Перечисляет опции, специфичные для команды, с пояснениями.
- Примеры: Предоставляет примеры эффективного выполнения команды.
check-repo-connection¶
Команда check-repo-connection в утилите digna CLI предназначена для проверки подключаемости и доступа к указанному репозиторию digna. Эта команда гарантирует, что CLI может взаимодействовать с репозиторием.
Использование команды¶
bash dignacli check-repo-connection
При успешном выполнении команда выводит подтверждение подключения, а также сведения о репозитории: версия репозитория, хост, база данных и схема.
Если подключение к репозиторию не удалось, проверьте файл config.toml на предмет корректных настроек.
version¶
Чтобы проверить установленную версию dignacli, используйте опцию --version.
Использование команды¶
bash dignacli --version
Пример вывода¶
bash dignacli version 2024.09
параметры логирования¶
По умолчанию вывод команд digna в консоль минималистичен. Большинство команд позволяют получить дополнительную информацию с помощью следующих опций:
--verbose (-v)
--debug (-d)
--logfile (lf)
«verbose» и «debug» определяют уровень детализации, в то время как переключатель «logfile» позволяет перенаправлять вывод в файл вместо окна консоли.
Управление пользователями¶
add-user¶
Команда add-user в digna CLI используется для добавления нового пользователя в систему digna.
Использование команды¶
bash dignacli add-user [OPTIONS] USER_NAME USER_FULL_NAME USER_PASSWORD
Аргументы¶
- USER_NAME: Имя пользователя для нового пользователя (обязательно).
- USER_FULL_NAME: Полное имя нового пользователя (обязательно).
- USER_PASSWORD: Пароль для нового пользователя (обязательно).
Опции¶
- --is_superuser, -su: Флаг, обозначающий нового пользователя как администратора.
- --valid_until, -vu: Устанавливает дату истечения действия учётной записи в формате YYYY-MM-DD HH:MI:SS. Если не задано, учётная запись не имеет срока действия.
Пример¶
Чтобы добавить нового пользователя с именем jdoe, полным именем John Doe и паролем password123:
bash dignacli add-user [OPTIONS] USER_NAME USER_FULL_NAME USER_PASSWORD
Чтобы добавить нового пользователя и задать дату истечения действия учётной записи: bash dignacli add-user jdoe "John Doe" password123 --valid_until "2024-12-31 23:59:59"
delete-user¶
Команда delete-user в digna CLI используется для удаления существующего пользователя из системы digna.
Использование команды¶
bash dignacli delete-user USER_NAME
Аргументы¶
- USER_NAME: Имя пользователя, которого необходимо удалить (обязательно). Это единственный обязательный аргумент команды.
Пример¶
bash dignacli delete-user jdoe
Выполнение этой команды удалит пользователя jdoe из системы digna, отзовет его доступ и удалит связанные данные и права из репозитория.
modify-user¶
Команда modify-user в digna CLI используется для обновления данных существующего пользователя в системе digna.
Использование команды¶
bash dignacli modify-user
Аргументы¶
- USER_NAME: Имя пользователя, которого необходимо изменить (обязательно).
- USER_FULL_NAME: Новое полное имя пользователя (обязательно).
Опции¶
- --is_superuser, -su: Назначает пользователя суперпользователем, предоставляя повышенные привилегии. Этот флаг не требует значения.
- --valid_until, -vu: Устанавливает дату истечения действия учётной записи в формате YYYY-MM-DD HH:MI:SS. Если не задано, учётная запись остаётся действительной бессрочно.
Пример¶
Чтобы изменить полное имя пользователя jdoe на «Johnathan Doe» и назначить его суперпользователем: bash dignacli modify-user jdoe "Johnathan Doe" --is_superuser
modify-user-pwd¶
Команда modify-user-pwd в digna CLI используется для изменения пароля существующего пользователя в системе digna.
Использование команды¶
bash dignacli modify-user-pwd
Аргументы¶
- USER_NAME: Имя пользователя, для которого нужно изменить пароль (обязательно).
- USER_PWD: Новый пароль пользователя (обязательно).
Пример¶
Чтобы изменить пароль пользователя jdoe на newpassword123: bash dignacli modify-user-pwd jdoe newpassword123
list-users¶
Команда list-users в digna CLI отображает список всех пользователей, зарегистрированных в системе digna.
Использование команды¶
bash dignacli list-users
Выполнение этой команды в digna CLI подключится к репозиторию digna и выведет список всех пользователей, показывая их ID, имя пользователя, полное имя, статус суперпользователя и метки времени истечения действия.
Управление репозиторием¶
upgrade-repo¶
Команда upgrade-repo в digna CLI используется для обновления или инициализации репозитория digna. Эта команда необходима для применения обновлений или первоначальной настройки инфраструктуры репозитория.
Использование команды¶
bash dignacli upgrade-repo [options]
Опции¶
- --simulation-mode, -s: При включении эта опция выполняет команду в режиме симуляции, печатая SQL-запросы, которые будут выполнены, но фактически не выполняя их. Это полезно для предварительного просмотра изменений без внесения модификаций в репозиторий.
Пример¶
Чтобы обновить репозиторий digna, можно выполнить команду без опций:
bash dignacli upgrade-repo
Чтобы запустить обновление в режиме симуляции (чтобы увидеть SQL-запросы без их применения):
bash dignacli upgrade-repo --simulation-mode
Эта команда важна для поддержки системы digna, обеспечивая соответствие схемы базы данных и других компонентов репозитория последней версии программного обеспечения.
encrypt¶
Команда encrypt в digna CLI используется для шифрования пароля.
Использование команды¶
bash dignacli encrypt
Аргументы¶
- PASSWORD: Пароль, который нужно зашифровать (обязательно).
Пример¶
Чтобы зашифровать пароль, необходимо передать пароль в качестве аргумента.
Например, чтобы зашифровать пароль mypassword123, используйте: bash dignacli encrypt mypassword123
Эта команда выводит зашифрованную версию переданного пароля, которую затем можно использовать в безопасных контекстах. Если аргумент пароля не указан, CLI выведет ошибку о пропущенном аргументе.
generate-key¶
Команда generate-key используется для генерации ключа Fernet, который необходим для защиты паролей, хранящихся в репозитории digna.
Использование команды¶
bash dignacli generate-key
Управление данными¶
clean-up¶
Команда clean-up в digna CLI используется для удаления профилей, предсказаний и данных системы Traffic Light для одного или нескольких источников данных в рамках указанного проекта. Эта команда необходима для управления жизненным циклом данных, помогая поддерживать организованную и эффективную среду хранения, очищая устаревшие или ненужные данные.
Использование команды¶
bash dignacli clean-up
Аргументы¶
- PROJECT_NAME: Название проекта, из которого необходимо удалить данные (обязательно). Использование ключевого слова all-projects в этом аргументе указывает digna итеративно применить команду ко всем существующим проектам.
- FROM_DATE: Дата и время начала удаления данных. Допустимые форматы: %Y-%m-%d, %Y-%m-%dT%H:%M:%S или %Y-%m-%d %H:%M:%S (обязательно).
- TO_DATE: Дата и время окончания удаления данных, в тех же форматах, что и FROM_DATE (обязательно).
Опции¶
- --table-name, -tn: Ограничивает операцию очистки конкретной таблицей в проекте.
- --table-filter, -tf: Фильтрует таблицы, чтобы ограничить очистку таблицами, содержащими указанную подстроку в имени.
- --timing, -tm: Показывает продолжительность процесса очистки после завершения.
- --help: Отображает справочную информацию по команде clean-up и завершает выполнение.
Пример¶
Чтобы удалить данные из проекта ProjectA в период с 1 января 2023 по 30 июня 2023:
bash dignacli clean-up ProjectA 2023-01-01 2023-06-30
Чтобы удалить данные только из конкретной таблицы с именем Table1:
bash dignacli clean-up ProjectA 2023-01-01 2023-06-30 --table-name Table1
Эта команда помогает управлять хранением данных и гарантировать, что в репозитории останется только релевантная информация.
inspect¶
Команда inspect в digna CLI используется для создания профилей, предсказаний и данных системы Traffic Light для одного или нескольких источников данных в рамках указанного проекта. Эта команда помогает анализировать и мониторить данные за определённый период.
Использование команды¶
bash dignacli inspect
Аргументы¶
- PROJECT_NAME: Название проекта, для которого необходимо провести инспекцию данных (обязательно). Использование ключевого слова all-projects в этом аргументе указывает digna итеративно применить команду ко всем существующим проектам.
- FROM_DATE: Дата и время начала инспекции данных. Допустимые форматы: %Y-%m-%d, %Y-%m-%dT%H:%M:%S или %Y-%m-%d %H:%M:%S (обязательно).
- TO_DATE: Дата и время окончания инспекции данных, в тех же форматах, что и FROM_DATE (обязательно).
Опции¶
- --table-name, -tn: Ограничивает инспекцию конкретной таблицей в проекте.
- --table-filter, -tf: Фильтрует для инспекции только таблицы, содержащие указанную подстроку в имени.
- --force-profile: Принудительно собирает профили заново. По умолчанию включено force-profile.
- --no-force-profile: Запрещает повторный сбор профилей.
- --force-prediction: Принудительно пересчитывает предсказания. По умолчанию включено force-prediction.
- --no-force-prediction: Запрещает пересчёт предсказаний.
- --force-alert-status: Принудительно пересчитывает статусы оповещений. По умолчанию включено force-alert-status.
- --no-force-alert-status: Запрещает пересчёт статусов оповещений.
- --timing, -tm: Показывает продолжительность процесса инспекции после завершения.
- --alert-notification, -an: Отправляет уведомления об оповещениях на подписанные каналы.
Пример¶
Чтобы просканировать данные для проекта ProjectA с 1 января 2024 по 31 января 2024:
bash dignacli inspect ProjectA 2024-01-01 2024-01-31
Чтобы проверить только определённую таблицу и принудительно пересчитать предсказания:
bash dignacli inspect ProjectA 2024-01-01 2024-01-31 --table-name Table1 --force-prediction
Эта команда полезна для генерации обновлённых профилей и предсказаний, мониторинга целостности данных и управления системой оповещений в рамках заданного временного интервала проекта.
tls-status¶
Команда tls-status в digna CLI используется для запроса статуса Traffic Light System (TLS) для конкретной таблицы в проекте на заданную дату. Traffic Light System предоставляет информацию о состоянии и качестве данных, указывая на возможные проблемы или оповещения, требующие внимания.
Использование команды¶
bash dignacli tls-status
Аргументы¶
- PROJECT_NAME: Название проекта, для которого запрашивается статус TLS (обязательно).
- TABLE_NAME: Конкретная таблица в проекте, для которой требуется статус TLS (обязательно).
- DATE: Дата, на которую запрашивается статус TLS, обычно в формате %Y-%m-%d (обязательно).
Пример¶
Чтобы проверить статус TLS для таблицы с именем UserData в проекте ProjectA на 1 июля 2024 года:
bash dignacli tls-status ProjectA UserData 2024-07-01
Эта команда помогает пользователям контролировать и поддерживать качество данных, предоставляя ясный и применимый отчёт о статусе на основе заранее определённых критериев.
list-projects¶
Команда list-projects в digna CLI используется для отображения списка всех доступных проектов в системе digna.
Использование команды¶
bash dignacli list-projects
Эта команда особенно полезна для администраторов и пользователей, управляющих несколькими проектами, предоставляя быстрый обзор доступных проектов в репозитории digna.
list-ds¶
Команда list-ds в digna CLI используется для отображения списка всех доступных источников данных в указанном проекте. Эта команда полезна для понимания доступных для анализа и управления данных в системе digna.
Использование команды¶
bash dignacli list-ds
Аргументы¶
- PROJECT_NAME: Название проекта, для которого перечисляются источники данных (обязательно).
Пример¶
Чтобы перечислить все источники данных в проекте с именем ProjectA:
bash dignacli list-ds ProjectA
Эта команда предоставляет пользователям обзор источников данных, доступных в проекте, помогая им эффективнее ориентироваться и управлять ландшафтом данных.