digna CLI Reference 2024.09¶
2024-08-24
CLI Basics¶
help¶
Opțiunea --help oferă informații despre comenzile disponibile și despre utilizarea acestora. Există două moduri principale de a folosi această opțiune:
-
Afișarea ajutorului general:
Utilizați --help imediat după comanda principală digna
bash dignacli --help -
Obținerea ajutorului pentru comenzi specifice:
Pentru informații detaliate despre o comandă anume, adăugați --help la acea comandă. De exemplu, pentru a obține ajutor pentru comanda add-user, rulați: bash dignacli add-user --help
### output:
- Descrierea comenzii: Oferă o descriere detaliată a ceea ce face comanda.
- Sintaxă: Afișează sintaxa exactă, inclusiv argumentele obligatorii și opționale.
- Opțiuni: Listează opțiunile specifice comenzii, împreună cu explicațiile lor.
- Exemple: Furnizează exemple despre cum să executați comanda eficient.
check-repo-connection¶
Comanda check-repo-connection este un utilitar din cadrul instrumentului CLI digna conceput pentru a testa conectivitatea și accesul la un repository digna specific. Această comandă asigură că CLI-ul poate interacționa cu repository-ul.
Command Usage¶
bash dignacli check-repo-connection
La executare cu succes, comanda afișează o confirmare a conexiunii, împreună cu detalii despre repository: versiunea Repository-ului, Host, Database și Schema.
Dacă conexiunea la repository nu reușește, verificați fișierul config.toml pentru a vă asigura că setările de configurare sunt corecte.
version¶
Pentru a verifica versiunea instalată a dignacli, utilizați opțiunea --version.
Command Usage¶
bash dignacli --version
Example Output¶
bash dignacli version 2024.09
logging options¶
Implicit, ieșirea din consolă a comenzilor digna este proiectată să fie minimală. Majoritatea comenzilor oferă posibilitatea de a furniza informații suplimentare, folosind următoarele opțiuni:
-- verbose (-v)
-- debug (-d)
-- logfile (lf)
„verbose” și „debug” definesc nivelul de detaliu, în timp ce comutatorul „logfile” permite redirecționarea ieșirii către un fișier, în loc de fereastra consolei.
User Management¶
add-user¶
Comanda add-user din CLI-ul digna este utilizată pentru a adăuga un utilizator nou în sistemul digna.
Command Usage¶
bash dignacli add-user [OPTIONS] USER_NAME USER_FULL_NAME USER_PASSWORD
Arguments¶
- USER_NAME: Numele de utilizator pentru noul utilizator (obligatoriu).
- USER_FULL_NAME: Numele complet al noului utilizator (obligatoriu).
- USER_PASSWORD: Parola pentru noul utilizator (obligatoriu).
Options¶
- --is_superuser, -su: Flag pentru a desemna noul utilizator ca administrator.
- --valid_until, -vu: Setează o dată de expirare pentru contul utilizatorului în formatul YYYY-MM-DD HH:MI:SS. Dacă nu este setată, contul nu are dată de expirare.
Example¶
Pentru a adăuga un utilizator nou cu username jdoe, nume complet John Doe și parola password123:
bash dignacli add-user [OPTIONS] USER_NAME USER_FULL_NAME USER_PASSWORD
Pentru a adăuga un utilizator nou și a seta o dată de expirare a contului: bash dignacli add-user jdoe "John Doe" password123 --valid_until "2024-12-31 23:59:59"
delete-user¶
Comanda delete-user din CLI-ul digna este utilizată pentru a elimina un utilizator existent din sistemul digna.
Command Usage¶
bash dignacli delete-user USER_NAME
Arguments¶
- USER_NAME: Numele de utilizator al utilizatorului care urmează a fi șters (obligatoriu). Acesta este singurul argument necesar comenzii.
Example¶
bash dignacli delete-user jdoe
Executarea acestei comenzi va elimina utilizatorul jdoe din sistemul digna, revocându-i accesul și ștergând datele și permisiunile asociate din repository.
modify-user¶
Comanda modify-user din CLI-ul digna este utilizată pentru a actualiza detaliile unui utilizator existent în sistemul digna.
Command Usage¶
bash dignacli modify-user
Arguments¶
- USER_NAME: Numele de utilizator al utilizatorului care urmează a fi modificat (obligatoriu).
- USER_FULL_NAME: Noul nume complet pentru utilizator (obligatoriu).
Options¶
- --is_superuser, -su: Setează utilizatorul ca superuser, acordând privilegii ridicate. Acest flag nu necesită o valoare.
- --valid_until, -vu: Setează o dată de expirare pentru contul utilizatorului în formatul YYYY-MM-DD HH:MI:SS. Dacă nu este furnizată, contul rămâne valabil pe termen nelimitat.
Example¶
Pentru a modifica numele complet al utilizatorului jdoe în „Johnathan Doe” și pentru a seta utilizatorul ca superuser: bash dignacli modify-user jdoe "Johnathan Doe" --is_superuser
modify-user-pwd¶
Comanda modify-user-pwd din CLI-ul digna este utilizată pentru a schimba parola unui utilizator existent în sistemul digna.
Command Usage¶
bash dignacli modify-user-pwd
Arguments¶
- USER_NAME: Numele de utilizator al utilizatorului căruia i se schimbă parola (obligatoriu).
- USER_PWD: Noua parolă a utilizatorului (obligatoriu).
Example¶
Pentru a schimba parola utilizatorului jdoe în newpassword123: bash dignacli modify-user-pwd jdoe newpassword123
list-users¶
Comanda list-users din CLI-ul digna afișează o listă a tuturor utilizatorilor înregistrați în sistemul digna.
Command Usage¶
bash dignacli list-users
Executarea acestei comenzi în CLI-ul digna se va conecta la repository-ul digna și va lista toți utilizatorii, afișând ID-ul, numele de utilizator, numele complet, statutul de superuser și timestamp-urile de expirare.
Repository Management¶
upgrade-repo¶
Comanda upgrade-repo din CLI-ul digna este utilizată pentru a upgrada sau inițializa repository-ul digna. Această comandă este esențială pentru aplicarea actualizărilor sau pentru configurarea infrastructurii repository-ului pentru prima dată.
Command Usage¶
bash dignacli upgrade-repo [options]
Options¶
- --simulation-mode, -s: Când este activată, această opțiune rulează comanda în modul de simulare, afișând instrucțiunile SQL care ar fi executate, dar fără a le rula efectiv. Este utilă pentru a previzualiza modificările fără a face schimbări în repository.
Example¶
Pentru a upgrada repository-ul digna, puteți rula comanda fără opțiuni:
bash dignacli upgrade-repo
Pentru a rula upgrade-ul în modul de simulare (pentru a vedea instrucțiunile SQL fără a le aplica):
bash dignacli upgrade-repo --simulation-mode
Această comandă este crucială pentru întreținerea sistemului digna, asigurând că schema bazei de date și celelalte componente ale repository-ului sunt actualizate la cea mai recentă versiune a software-ului.
encrypt¶
Comanda encrypt din CLI-ul digna este utilizată pentru a cripta o parolă.
Command Usage¶
bash dignacli encrypt
Arguments¶
- PASSWORD: Parola care trebuie criptată (obligatoriu).
Example¶
Pentru a cripta o parolă, trebuie să furnizați parola ca argument.
De exemplu, pentru a cripta parola mypassword123, ați folosi: bash dignacli encrypt mypassword123
Această comandă afișează versiunea criptată a parolei furnizate, care poate fi apoi folosită în contexte securizate. Dacă argumentul parolei nu este furnizat, CLI-ul va afișa o eroare indicând argumentul lipsă.
generate-key¶
Comanda generate-key este utilizată pentru a genera o cheie Fernet, esențială pentru securizarea parolelor stocate în repository-ul digna.
Command Usage¶
bash dignacli generate-key
Data Management¶
clean-up¶
Comanda clean-up din CLI-ul digna este utilizată pentru a elimina profile, predicții și date din Traffic Light System pentru una sau mai multe surse de date din cadrul unui proiect specificat. Această comandă este esențială pentru gestionarea ciclului de viață al datelor, ajutând la menținerea unui mediu de date organizat și eficient prin curățarea datelor învechite sau inutile.
Command Usage¶
bash dignacli clean-up
Arguments¶
- PROJECT_NAME: Numele proiectului din care se doresc ștergeri de date (obligatoriu). Utilizarea cuvântului cheie all-projects în acest argument instruiește digna să itereze peste toate proiectele existente și să aplice comanda.
- FROM_DATE: Data și ora de început pentru ștergerea datelor. Formatele acceptate includ %Y-%m-%d, %Y-%m-%dT%H:%M:%S sau %Y-%m-%d %H:%M:%S (obligatoriu).
- TO_DATE: Data și ora de sfârșit pentru ștergerea datelor, urmând aceleași formate ca FROM_DATE (obligatoriu).
Options¶
- --table-name, -tn: Limitează operațiunea de clean-up la un anumit tabel din cadrul proiectului.
- --table-filter, -tf: Filtrează pentru a limita clean-up-ul la tabele care conțin subșirul specificat în numele lor.
- --timing, -tm: Afișează durata procesului de clean-up după finalizare.
- --help: Afișează informații de ajutor pentru comanda clean-up și iese.
Example¶
Pentru a elimina date din proiectul ProjectA între 1 ianuarie 2023 și 30 iunie 2023:
bash dignacli clean-up ProjectA 2023-01-01 2023-06-30
Pentru a elimina date doar dintr-un tabel specific numit Table1:
bash dignacli clean-up ProjectA 2023-01-01 2023-06-30 --table-name Table1
Această comandă ajută la gestionarea spațiului de stocare al datelor și la asigurarea faptului că repository-ul conține numai informațiile relevante.
inspect¶
Comanda inspect din CLI-ul digna este utilizată pentru a crea profile, predicții și date pentru Traffic Light System pentru una sau mai multe surse de date din cadrul unui proiect specificat. Această comandă ajută la analizarea și monitorizarea datelor pe o perioadă definită.
Command Usage¶
bash dignacli inspect
Arguments¶
- PROJECT_NAME: Numele proiectului pentru care se doresc inspecții de date (obligatoriu). Utilizarea cuvântului cheie all-projects în acest argument instruiește digna să itereze peste toate proiectele existente și să aplice comanda.
- FROM_DATE: Data și ora de început pentru inspecția datelor. Formatele acceptate includ %Y-%m-%d, %Y-%m-%dT%H:%M:%S sau %Y-%m-%d %H:%M:%S (obligatoriu).
- TO_DATE: Data și ora de sfârșit pentru inspecția datelor, urmând aceleași formate ca FROM_DATE (obligatoriu).
Options¶
- --table-name, -tn: Limitează inspecția la un anumit tabel din cadrul proiectului.
- --table-filter, -tf: Filtrează pentru a inspecta numai tabele care conțin subșirul specificat în numele lor.
- --force-profile: Forțează re-colectarea profilelor. Implicit este force-profile.
- --no-force-profile: Previne re-colectarea profilelor.
- --force-prediction: Forțează recalcularea predicțiilor. Implicit este force-prediction.
- --no-force-prediction: Previne recalcularea predicțiilor.
- --force-alert-status: Forțează recalcularea stării alertelor. Implicit este force-alert-status.
- --no-force-alert-status: Previne recalcularea stării alertelor.
- --timing, -tm: Afișează durata procesului de inspectare după finalizare.
- --alert-notification, -an: Trimite notificări de alertă către canalele abonate.
Example¶
Pentru a inspecta datele pentru proiectul ProjectA din 1 ianuarie 2024 până în 31 ianuarie 2024:
bash dignacli inspect ProjectA 2024-01-01 2024-01-31
Pentru a inspecta doar un tabel specific și a forța recalcularea predicțiilor:
bash dignacli inspect ProjectA 2024-01-01 2024-01-31 --table-name Table1 --force-prediction
Această comandă este utilă pentru generarea de profile și predicții actualizate, monitorizarea integrității datelor și gestionarea sistemelor de alertă în cadrul unui interval de timp specificat al proiectului.
tls-status¶
Comanda tls-status din CLI-ul digna este utilizată pentru a interoga starea Traffic Light System (TLS) pentru un anumit tabel dintr-un proiect la o dată dată. Traffic Light System oferă informații despre sănătatea și calitatea datelor, indicând eventuale probleme sau alerte care necesită atenție.
Command Usage¶
bash dignacli tls-status
Arguments¶
- PROJECT_NAME: Numele proiectului pentru care se interoghează starea TLS (obligatoriu).
- TABLE_NAME: Tabelul specific din proiect pentru care este necesară starea TLS (obligatoriu).
- DATE: Data pentru care se interoghează starea TLS, de obicei în formatul %Y-%m-%d (obligatoriu).
Example¶
Pentru a verifica starea TLS pentru un tabel numit UserData în proiectul ProjectA la 1 iulie 2024:
bash dignacli tls-status ProjectA UserData 2024-07-01
Această comandă ajută utilizatorii să monitorizeze și să mențină calitatea datelor oferind un raport clar și acționabil pe baza criteriilor predefinite.
list-projects¶
Comanda list-projects din CLI-ul digna este utilizată pentru a afișa o listă a tuturor proiectelor disponibile în sistemul digna.
Command Usage¶
bash dignacli list-projects
Această comandă este deosebit de utilă pentru administratori și utilizatori care gestionează mai multe proiecte, oferind o imagine rapidă a proiectelor disponibile în repository-ul digna.
list-ds¶
Comanda list-ds din CLI-ul digna este utilizată pentru a afișa o listă a tuturor surselor de date disponibile într-un proiect specific. Această comandă este utilă pentru înțelegerea activelor de date disponibile pentru analiză și gestionare în sistemul digna.
Command Usage¶
bash dignacli list-ds
Arguments¶
- PROJECT_NAME: Numele proiectului pentru care se listează sursele de date (obligatoriu).
Example¶
Pentru a lista toate sursele de date din proiectul numit ProjectA:
bash dignacli list-ds ProjectA
Această comandă oferă utilizatorilor o imagine de ansamblu asupra surselor de date disponibile într-un proiect, ajutându-i să navigheze și să gestioneze mai eficient peisajul de date.