digna CLI Довідник 2024.09¶
2024-08-24
Основи CLI¶
help¶
Опція --help надає інформацію про доступні команди та їх використання. Існує два основні способи використання цієї опції:
-
Відображення загальної допомоги:
Використовуйте --help одразу після ключового слова digna
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 у CLI digna використовується для додавання нового користувача в систему 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 у CLI digna використовується для видалення існуючого користувача зі системи digna.
Використання команди¶
bash dignacli delete-user USER_NAME
Аргументи¶
- USER_NAME: Ім'я користувача, якого потрібно видалити (обов'язково). Це єдиний аргумент, необхідний для команди.
Приклад¶
bash dignacli delete-user jdoe
Виконання цієї команди видалить користувача jdoe з системи digna, відкличе його доступ і видалить пов'язані дані та дозволи з репозиторію.
modify-user¶
Команда modify-user у CLI digna використовується для оновлення даних існуючого користувача в системі 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 у CLI digna використовується для зміни пароля існуючого користувача в системі digna.
Використання команди¶
bash dignacli modify-user-pwd
Аргументи¶
- USER_NAME: Ім'я користувача, пароль якого потрібно змінити (обов'язково).
- USER_PWD: Новий пароль користувача (обов'язково).
Приклад¶
Щоб змінити пароль користувача jdoe на newpassword123: bash dignacli modify-user-pwd jdoe newpassword123
list-users¶
Команда list-users у CLI digna відображає список усіх користувачів, зареєстрованих у системі digna.
Використання команди¶
bash dignacli list-users
Виконання цієї команди у CLI digna підключиться до репозиторію digna та виведе список усіх користувачів, показуючи їхній ID, ім'я користувача, повне ім'я, статус суперкористувача та мітки часу закінчення терміну дії.
Керування репозиторієм¶
upgrade-repo¶
Команда upgrade-repo у CLI digna використовується для оновлення або ініціалізації репозиторію 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 у CLI digna використовується для шифрування пароля.
Використання команди¶
bash dignacli encrypt
Аргументи¶
- PASSWORD: Пароль, який потрібно зашифрувати (обов'язково).
Приклад¶
Щоб зашифрувати пароль, необхідно передати його як аргумент.
Наприклад, щоб зашифрувати пароль mypassword123, використайте: bash dignacli encrypt mypassword123
Ця команда виводить зашифровану версію наданого пароля, яку потім можна використовувати в безпечних контекстах. Якщо аргумент пароля не надано, CLI відобразить помилку про відсутній аргумент.
generate-key¶
Команда generate-key використовується для генерації Fernet-ключа, який необхідний для захисту паролів, збережених у репозиторії digna.
Використання команди¶
bash dignacli generate-key
Керування даними¶
clean-up¶
Команда clean-up у CLI digna використовується для видалення профілів, прогнозів і даних системи світлофора (traffic light system) для одного або кількох джерел даних у зазначеному проекті. Ця команда важлива для управління життєвим циклом даних, допомагаючи підтримувати організоване та ефективне середовище шляхом очищення застарілих або непотрібних даних.
Використання команди¶
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 у CLI digna використовується для створення профілів, прогнозів і даних системи світлофора (traffic light system) для одного або кількох джерел даних у зазначеному проекті. Ця команда допомагає аналізувати та моніторити дані за визначений період.
Використання команди¶
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 у CLI digna використовується для отримання статусу Traffic Light System (TLS) для конкретної таблиці в проекті на задану дату. Система світлофора надає уявлення про стан та якість даних, вказуючи на проблеми або тривоги, які потребують уваги.
Використання команди¶
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 у CLI digna використовується для відображення списку всіх доступних проектів у системі digna.
Використання команди¶
bash dignacli list-projects
Ця команда особливо корисна для адміністраторів та користувачів, які керують кількома проектами, надаючи швидкий огляд доступних проектів у репозиторії digna.
list-ds¶
Команда list-ds у CLI digna використовується для відображення списку всіх доступних джерел даних у вказаному проекті. Ця команда корисна для розуміння даних, доступних для аналізу та керування у системі digna.
Використання команди¶
bash dignacli list-ds
Аргументи¶
- PROJECT_NAME: Назва проекту, для якого перераховуються джерела даних (обов'язково).
Приклад¶
Щоб перелічити всі джерела даних у проекті з назвою ProjectA:
bash dignacli list-ds ProjectA
Ця команда дає користувачам огляд джерел даних, доступних у проєкті, допомагаючи орієнтуватися та ефективніше керувати ландшафтом даних.