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

digna CLI Reference 2024.12

2024-12-09

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

2024-12-09

Основи 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.12

Використання параметрів логування

За замовчуванням консольний вивід команд 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: Зупиняє перерахунок статусів алертів.
  • --iterative: Виконує інспекцію періоду шляхом щоденних ітерацій. За замовчуванням — iterative.
  • --no-iterative: Виконує інспекцію всього періоду за один прохід.
  • --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) для конкретної таблиці в проекті на вказану дату. Traffic Light System дає уявлення про стан та якість даних, вказуючи на можливі проблеми або алерти, що потребують уваги.

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

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

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