Перейти к содержанию

digna CLI Reference 2024.11

2024-11-03

На этой странице задокументирован полный набор команд, доступных в CLI digna релиза 2024.11, включая примеры использования и опции.

Основы CLI

Использование опции --help

Опция --help предоставляет информацию о доступных командах и их использовании. Существует два основных способа использования этой опции:

  1. Отображение общего справки:

    Используйте --help сразу после ключевого слова dignacli

    dignacli --help

  2. Получение справки по конкретным командам:

    Для подробной информации о конкретной команде добавьте --help к этой команде.
    Например, чтобы получить справку по команде add-user, выполните: 

    dignacli add-user --help

    ### вывод:

    • Описание команды: Подробно объясняет, что делает команда.
    • Синтаксис: Показывает точный синтаксис, включая обязательные и опциональные аргументы.
    • Опции: Перечисляет опции, специфичные для команды, с их описанием.
    • Примеры: Приводит примеры эффективного выполнения команды.

Использование команды check-repo-connection

Команда check-repo-connection — это утилита в CLI digna, предназначенная для проверки подключения и доступа к указанному репозиторию digna. Эта команда гарантирует, что CLI может взаимодействовать с репозиторием.

Использование команды

dignacli check-repo-connection

При успешном выполнении команда выводит подтверждение соединения, а также детали о репозитории: версия репозитория, хост, база данных и схема.

Если подключение к репозиторию не удалось, проверьте файл config.toml на предмет корректных настроек.

Использование команды --version

Чтобы проверить установленную версию dignacli, используйте опцию --version.

Использование команды

dignacli --version

Пример вывода

dignacli version 2024.11

Использование опций логирования

По умолчанию вывод в консоль команд digna минималистичен. Большинство команд предоставляют возможность вывести дополнительную информацию с помощью следующих опций:

-- verbose (-v)
-- debug (-d)
-- logfile (lf)

«verbose» и «debug» определяют уровень детализации, тогда как переключатель «logfile» позволяет перенаправить вывод в файл вместо консоли.

Управление пользователями

Использование команды add-user

Команда add-user в CLI digna используется для добавления нового пользователя в систему digna.

Использование команды

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:

dignacli add-user [OPTIONS] USER_NAME USER_FULL_NAME USER_PASSWORD

Чтобы добавить нового пользователя и задать дату истечения аккаунта: 

dignacli add-user jdoe "John Doe" password123 --valid_until "2024-12-31 23:59:59"

Использование команды delete-user

Команда delete-user в CLI digna используется для удаления существующего пользователя из системы digna.

Использование команды

dignacli delete-user USER_NAME

Аргументы

  • USER_NAME: Имя пользователя, которого необходимо удалить (обязательно). Это единственный обязательный аргумент для команды.

Пример

dignacli delete-user jdoe

Выполнение этой команды удалит пользователя jdoe из системы digna, отзовет его доступ и удалит связанные с ним данные и права из репозитория.

Использование команды modify-user

Команда modify-user в CLI digna используется для обновления данных существующего пользователя в системе digna.

Использование команды

dignacli modify-user <USER_NAME> <USER_FULL_NAME> [options]

Аргументы

  • USER_NAME: Имя пользователя, которого необходимо изменить (обязательно).
  • USER_FULL_NAME: Новое полное имя пользователя (обязательно).

Опции

  • --is_superuser, -su: Делает пользователя суперпользователем, предоставляя расширенные права. Этот флаг не требует значения.
  • --valid_until, -vu: Устанавливает дату истечения действия аккаунта в формате YYYY-MM-DD HH:MI:SS. Если не указано, аккаунт остается действительным бесконечно.

Пример

Чтобы изменить полное имя пользователя jdoe на “Johnathan Doe” и назначить пользователя суперпользователем: 

dignacli modify-user jdoe "Johnathan Doe" --is_superuser

Использование команды modify-user-pwd

Команда modify-user-pwd в CLI digna используется для изменения пароля существующего пользователя в системе digna.

Использование команды

dignacli modify-user-pwd <USER_NAME> <USER_PWD>

Аргументы

  • USER_NAME: Имя пользователя, для которого необходимо изменить пароль (обязательно).
  • USER_PWD: Новый пароль пользователя (обязательно).

Пример

Чтобы изменить пароль пользователя jdoe на newpassword123: 

dignacli modify-user-pwd jdoe newpassword123

Использование команды list-users

Команда list-users в CLI digna отображает список всех пользователей, зарегистрированных в системе digna.

Использование команды

dignacli list-users

Выполнение этой команды в CLI digna подключится к репозиторию digna и выведет всех пользователей, показывая их ID, имя пользователя, полное имя, статус суперпользователя и метки времени истечения действия.

Управление репозиторием

Использование команды upgrade-repo

Команда upgrade-repo в CLI digna используется для обновления или инициализации репозитория digna. Эта команда необходима для применения обновлений или первоначальной настройки инфраструктуры репозитория.

Использование команды

dignacli upgrade-repo [options]

Опции

  • --simulation-mode, -s: При включении эта опция запускает команду в режиме симуляции, который выводит SQL-запросы, которые были бы выполнены, но фактически не выполняет их. Это полезно для предварительного просмотра изменений без внесения модификаций в репозиторий.

Пример

Чтобы обновить репозиторий digna, можно выполнить команду без опций:

dignacli upgrade-repo
Чтобы запустить обновление в режиме симуляции (чтобы увидеть SQL-запросы без их применения):

dignacli upgrade-repo --simulation-mode

Эта команда важна для поддержки системы digna, обеспечивая соответствие схемы базы данных и других компонентов репозитория последней версии ПО.

Использование команды encrypt

Команда encrypt в CLI digna используется для шифрования пароля.

Использование команды

dignacli encrypt <PASSWORD>

Аргументы

  • PASSWORD: Пароль, который необходимо зашифровать (обязательно).

Пример

Чтобы зашифровать пароль, нужно передать пароль в качестве аргумента.
Например, чтобы зашифровать пароль mypassword123, используйте: 

dignacli encrypt mypassword123
Эта команда выводит зашифрованную версию указанного пароля, которую затем можно использовать в безопасных контекстах. Если аргумент с паролем не указан, CLI выдаст ошибку о пропущенном аргументе.

Использование команды generate-key

Команда generate-key используется для генерации ключа Fernet, который необходим для защиты паролей, хранящихся в репозитории digna.

Использование команды

dignacli generate-key

Управление данными

Использование команды clean-up

Команда clean-up в CLI digna используется для удаления профилей, предсказаний и данных системы светофора (traffic light system) для одного или нескольких источников данных в указанном проекте. Эта команда важна для управления жизненным циклом данных, помогая поддерживать упорядоченную и эффективную среду, удаляя устаревшие или ненужные данные.

Использование команды

dignacli clean-up <PROJECT_NAME> <FROM_DATE> <TO_DATE> [options]

Аргументы

  • 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:

dignacli clean-up ProjectA 2023-01-01 2023-06-30

Чтобы удалить данные только из конкретной таблицы с именем Table1:

dignacli clean-up ProjectA 2023-01-01 2023-06-30 --table-name Table1

Эта команда помогает управлять хранением данных и гарантирует, что в репозитории остаётся только релевантная информация.

Использование команды inspect

Команда inspect в CLI digna используется для создания профилей, предсказаний и данных системы светофора (traffic light system) для одного или нескольких источников данных в указанном проекте. Эта команда помогает анализировать и отслеживать данные за определённый период.

Использование команды

dignacli inspect <PROJECT_NAME> <FROM_DATE> <TO_DATE> [options]

Аргументы

  • 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: Фильтрует инспекцию только по таблицам, содержащим указанную подстроку в имени.
  • --do-profile: Запускает повторный сбор профилей. По умолчанию включено (do-profile).
  • --no-do-profile: Отключает повторный сбор профилей.
  • --do-prediction: Запускает перерасчёт предсказаний. По умолчанию включено (do-prediction).
  • --no-do-prediction: Отключает перерасчёт предсказаний.
  • --do-alert-status: Запускает перерасчёт статусов оповещений. По умолчанию включено (do-alert-status).
  • --no-do-alert-status: Отключает перерасчёт статусов оповещений.
  • --timing, -tm: Показывает длительность процесса инспекции после завершения.

Пример

Чтобы просмотреть данные проекта ProjectA с 1 января 2024 по 31 января 2024:

dignacli inspect ProjectA 2024-01-01 2024-01-31

Чтобы просмотреть только конкретную таблицу и принудительно пересчитать предсказания:

dignacli inspect ProjectA 2024-01-01 2024-01-31 --table-name Table1 --force-prediction
Эта команда полезна для генерации обновлённых профилей и предсказаний, мониторинга целостности данных и управления системой оповещений в рамках указанного временного интервала проекта.

Использование команды tls-status

Команда tls-status в CLI digna используется для запроса статуса системы светофора (Traffic Light System, TLS) для конкретной таблицы в проекте на указанную дату. Система светофора предоставляет информацию о состоянии и качестве данных, указывая на возможные проблемы или оповещения, требующие внимания.

Использование команды

dignacli tls-status <PROJECT_NAME> <TABLE_NAME> <DATE>

Аргументы

  • PROJECT_NAME: Имя проекта, для которого запрашивается статус TLS (обязательно).
  • TABLE_NAME: Конкретная таблица в проекте, для которой требуется статус TLS (обязательно).
  • DATE: Дата, для которой запрашивается статус TLS, обычно в формате %Y-%m-%d (обязательно).

Пример

Чтобы проверить статус TLS для таблицы UserData в проекте ProjectA на 1 июля 2024:

dignacli tls-status ProjectA UserData 2024-07-01

Эта команда помогает пользователям мониторить и поддерживать качество данных, предоставляя чёткий и пригодный для действий отчёт на основе предопределённых критериев.

Использование команды list-projects

Команда list-projects в CLI digna используется для отображения списка всех доступных проектов в системе digna.

Использование команды

dignacli list-projects

Эта команда особенно полезна для администраторов и пользователей, управляющих несколькими проектами, предоставляя быстрый обзор доступных проектов в репозитории digna.

Использование команды list-ds

Команда list-ds в CLI digna используется для отображения списка всех доступных источников данных в указанном проекте. Эта команда полезна для понимания доступных данных для анализа и управления в системе digna.

Использование команды

dignacli list-ds <PROJECT_NAME>

Аргументы

  • PROJECT_NAME: Имя проекта, для которого перечисляются источники данных (обязательно).

Пример

Чтобы перечислить все источники данных в проекте с именем ProjectA:

dignacli list-ds ProjectA

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