Перейти до змісту

digna CLI Reference 2024.11

2024-11-03

Ця сторінка документує повний набір команд, доступних у CLI digna версії 2024.11, включаючи приклади використання та опції.

Основи CLI

Використання опції help

Опція --help надає інформацію про доступні команди та їх використання. Існує два основні способи використання цієї опції:

  1. Відображення загальної довідки:

    Використовуйте –help одразу після ключового слова dignacl
    ```bash 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 використовується для видалення профілів, прогнозів та даних системи светофорів для одного або декількох джерел даних у вказаному проєкті. Ця команда важлива для управління життєвим циклом даних, допомагаючи підтримувати впорядковане та ефективне середовище шляхом очищення застарілих або непотрібних даних.

Використання команди

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 використовується для створення профілів, прогнозів та даних системи светофорів для одного або декількох джерел даних у вказаному проєкті. Ця команда допомагає аналізувати та моніторити дані за визначений період.

Використання команди

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

Ця команда надає користувачам огляд джерел даних, доступних у проєкті, допомагаючи ефективніше орієнтуватися та керувати ландшафтом даних.