digna CLI Reference 2024.09¶

2024-08-24

CLI Basics¶

help¶

L'opzione --help fornisce informazioni sui comandi disponibili e sul loro utilizzo. Ci sono due modi principali per utilizzare questa opzione:

Visualizzare l'help generale:

Usa --help immediatamente dopo la parola chiave dignacli
bash dignacli --help
Ottenere aiuto per comandi specifici:

Per informazioni dettagliate su un comando specifico, aggiungi --help a quel comando.
Ad esempio, per ottenere aiuto sul comando add-user, esegui: bash dignacli add-user --help

### output:
- Descrizione del comando: Fornisce una descrizione dettagliata di cosa fa il comando.
- Sintassi: Mostra la sintassi esatta, inclusi argomenti obbligatori e opzionali.
- Opzioni: Elenca le opzioni specifiche del comando, insieme alle loro spiegazioni.
- Esempi: Fornisce esempi di come eseguire efficacemente il comando.

check-repo-connection¶

Il comando check-repo-connection è un'utilità all'interno dello strumento CLI digna progettata per testare la connettività e l'accesso a un repository digna specificato. Questo comando garantisce che la CLI possa interagire con il repository.

Utilizzo del comando¶

bash dignacli check-repo-connection

Alla corretta esecuzione, il comando restituisce una conferma della connessione, insieme ai dettagli sul repository: versione del repository, host, database e schema.

Se la connessione al repository non riesce, controlla il file config.toml per verificare le impostazioni di configurazione corrette.

version¶

Per verificare la versione installata di dignacli, usa l'opzione --version.

Utilizzo del comando¶

bash dignacli --version

Esempio di output¶

bash dignacli version 2024.09

logging options¶

Per impostazione predefinita, l'output della console dei comandi digna è progettato per essere minimalista. La maggior parte dei comandi offre la possibilità di fornire informazioni aggiuntive utilizzando le seguenti opzioni:

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

“verbose” e “debug” definiscono il livello di dettaglio, mentre l'opzione “logfile” consente di reindirizzare l'output in modo che venga scritto su un file invece che nella finestra della console.

User Management¶

add-user¶

Il comando add-user nella CLI digna viene utilizzato per aggiungere un nuovo utente al sistema digna.

Utilizzo del comando¶

bash dignacli add-user [OPTIONS] USER_NAME USER_FULL_NAME USER_PASSWORD

Argomenti¶

USER_NAME: Il nome utente per il nuovo utente (obbligatorio).
USER_FULL_NAME: Il nome completo del nuovo utente (obbligatorio).
USER_PASSWORD: La password per il nuovo utente (obbligatorio).

Opzioni¶

--is_superuser, -su: Flag per designare il nuovo utente come amministratore.
--valid_until, -vu: Imposta una data di scadenza per l'account utente nel formato YYYY-MM-DD HH:MI:SS. Se non impostata, l'account non avrà data di scadenza.

Esempio¶

Per aggiungere un nuovo utente con nome utente jdoe, nome completo John Doe e password password123:

bash dignacli add-user [OPTIONS] USER_NAME USER_FULL_NAME USER_PASSWORD

Per aggiungere un nuovo utente e impostare una data di scadenza per l'account: bash dignacli add-user jdoe "John Doe" password123 --valid_until "2024-12-31 23:59:59"

delete-user¶

Il comando delete-user nella CLI digna viene utilizzato per rimuovere un utente esistente dal sistema digna.

Utilizzo del comando¶

bash dignacli delete-user USER_NAME

Argomenti¶

USER_NAME: Il nome utente dell'utente da eliminare (obbligatorio). Questo è l'unico argomento richiesto dal comando.

Esempio¶

bash dignacli delete-user jdoe

L'esecuzione di questo comando rimuoverà l'utente jdoe dal sistema digna, revocando il suo accesso ed eliminando i dati e i permessi associati dal repository.

modify-user¶

Il comando modify-user nella CLI digna viene utilizzato per aggiornare i dettagli di un utente esistente nel sistema digna.

Utilizzo del comando¶

bash dignacli modify-user [options]

Argomenti¶

USER_NAME: Il nome utente dell'utente da modificare (obbligatorio).
USER_FULL_NAME: Il nuovo nome completo per l'utente (obbligatorio).

Opzioni¶

--is_superuser, -su: Imposta l'utente come superuser, concedendo privilegi elevati. Questo flag non richiede un valore.
--valid_until, -vu: Imposta una data di scadenza per l'account utente nel formato YYYY-MM-DD HH:MI:SS. Se non fornita, l'account rimane valido indefinitamente.

Esempio¶

Per modificare il nome completo dell'utente jdoe in “Johnathan Doe” e impostare l'utente come superuser: bash dignacli modify-user jdoe "Johnathan Doe" --is_superuser

modify-user-pwd¶

Il comando modify-user-pwd nella CLI digna viene utilizzato per cambiare la password di un utente esistente nel sistema digna.

Utilizzo del comando¶

bash dignacli modify-user-pwd

Argomenti¶

USER_NAME: Il nome utente dell'utente la cui password deve essere cambiata (obbligatorio).
USER_PWD: La nuova password per l'utente (obbligatorio).

Esempio¶

Per cambiare la password dell'utente jdoe in newpassword123: bash dignacli modify-user-pwd jdoe newpassword123

list-users¶

Il comando list-users nella CLI digna visualizza un elenco di tutti gli utenti registrati nel sistema digna.

Utilizzo del comando¶

bash dignacli list-users

L'esecuzione di questo comando nella CLI digna si connetterà al repository digna e elencherà tutti gli utenti, mostrando il loro ID, nome utente, nome completo, stato di superuser e timestamp di scadenza.

Repository Management¶

upgrade-repo¶

Il comando upgrade-repo nella CLI digna viene utilizzato per aggiornare o inizializzare il repository digna. Questo comando è essenziale per applicare aggiornamenti o configurare l'infrastruttura del repository per la prima volta.

Utilizzo del comando¶

bash dignacli upgrade-repo [options]

Opzioni¶

--simulation-mode, -s: Quando abilitata, questa opzione esegue il comando in modalità simulazione, stampando le istruzioni SQL che verrebbero eseguite ma senza eseguirle effettivamente. Questo è utile per visualizzare le modifiche senza apportare alterazioni al repository.

Esempio¶

Per aggiornare il repository digna, puoi eseguire il comando senza opzioni:

bash dignacli upgrade-repo

Per eseguire l'upgrade in modalità simulazione (per vedere le istruzioni SQL senza applicarle):

bash dignacli upgrade-repo --simulation-mode

Questo comando è fondamentale per mantenere il sistema digna, assicurando che lo schema del database e altri componenti del repository siano aggiornati all'ultima versione del software.

encrypt¶

Il comando encrypt nella CLI digna viene utilizzato per criptare una password.

Utilizzo del comando¶

bash dignacli encrypt

Argomenti¶

PASSWORD: La password che deve essere criptata (obbligatorio).

Esempio¶

Per criptare una password, devi fornire la password come argomento.
Ad esempio, per criptare la password mypassword123, utilizzeresti: bash dignacli encrypt mypassword123

Questo comando restituisce la versione criptata della password fornita, che può poi essere utilizzata in contesti sicuri. Se l'argomento della password non viene fornito, la CLI mostrerà un errore indicando l'argomento mancante.

generate-key¶

Il comando generate-key viene utilizzato per generare una chiave Fernet, essenziale per proteggere le password memorizzate nel repository digna.

Utilizzo del comando¶

bash dignacli generate-key

Data Management¶

clean-up¶

Il comando clean-up nella CLI digna viene utilizzato per rimuovere profili, previsioni e dati del Traffic Light System per una o più sorgenti di dati all'interno di un progetto specificato. Questo comando è essenziale per la gestione del ciclo di vita dei dati, aiutando a mantenere un ambiente dati organizzato ed efficiente eliminando dati obsoleti o non necessari.

Utilizzo del comando¶

bash dignacli clean-up [options]

Argomenti¶

PROJECT_NAME: Il nome del progetto dal quale rimuovere i dati (obbligatorio). Usando la parola chiave all-projects in questo argomento, si istruisce digna a iterare su tutti i progetti esistenti e applicare questo comando.
FROM_DATE: La data e l'ora di inizio per la rimozione dei dati. I formati accettabili includono %Y-%m-%d, %Y-%m-%dT%H:%M:%S o %Y-%m-%d %H:%M:%S (obbligatorio).
TO_DATE: La data e l'ora di fine per la rimozione dei dati, seguendo gli stessi formati di FROM_DATE (obbligatorio).

Opzioni¶

--table-name, -tn: Limita l'operazione di clean-up a una tabella specifica all'interno del progetto.
--table-filter, -tf: Filtra per limitare il clean-up alle tabelle che contengono la sottostringa specificata nei loro nomi.
--timing, -tm: Visualizza la durata del processo di clean-up al termine.
--help: Visualizza le informazioni di aiuto per il comando clean-up ed esce.

Esempio¶

Per rimuovere i dati dal progetto ProjectA tra il 1º gennaio 2023 e il 30 giugno 2023:

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

Per rimuovere i dati solo da una tabella specifica chiamata Table1:

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

Questo comando aiuta a gestire lo storage dei dati e a garantire che il repository contenga solo informazioni rilevanti.

inspect¶

Il comando inspect nella CLI digna viene utilizzato per creare profili, previsioni e dati del Traffic Light System per una o più sorgenti di dati all'interno di un progetto specificato. Questo comando aiuta ad analizzare e monitorare i dati in un periodo definito.

Utilizzo del comando¶

bash dignacli inspect [options]

Argomenti¶

PROJECT_NAME: Il nome del progetto per il quale ispezionare i dati (obbligatorio). Usando la parola chiave all-projects in questo argomento, si istruisce digna a iterare su tutti i progetti esistenti e applicare questo comando.
FROM_DATE: La data e l'ora di inizio per l'ispezione dei dati. I formati accettabili includono %Y-%m-%d, %Y-%m-%dT%H:%M:%S o %Y-%m-%d %H:%M:%S (obbligatorio).
TO_DATE: La data e l'ora di fine per l'ispezione dei dati, seguendo gli stessi formati di FROM_DATE (obbligatorio).

Opzioni¶

--table-name, -tn: Limita l'ispezione a una tabella specifica all'interno del progetto.
--table-filter, -tf: Filtra per ispezionare solo le tabelle che contengono la sottostringa specificata nei loro nomi.
--force-profile: Forza la ricollezione dei profili. Il valore predefinito è force-profile.
--no-force-profile: Previene la ricollezione dei profili.
--force-prediction: Forza il ricalcolo delle previsioni. Il valore predefinito è force-prediction.
--no-force-prediction: Previene il ricalcolo delle previsioni.
--force-alert-status: Forza il ricalcolo degli stati di allerta. Il valore predefinito è force-alert-status.
--no-force-alert-status: Previene il ricalcolo degli stati di allerta.
--timing, -tm: Visualizza la durata del processo di ispezione al termine.
--alert-notification, -an: Invia notifiche di allerta ai canali sottoscritti.

Esempio¶

Per ispezionare i dati del progetto ProjectA dal 1º gennaio 2024 al 31 gennaio 2024:

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

Per ispezionare solo una tabella specifica e forzare il ricalcolo delle previsioni:

bash dignacli inspect ProjectA 2024-01-01 2024-01-31 --table-name Table1 --force-prediction

Questo comando è utile per generare profili e previsioni aggiornate, monitorare l'integrità dei dati e gestire i sistemi di allerta all'interno di un intervallo temporale di progetto specificato.

tls-status¶

Il comando tls-status nella CLI digna viene utilizzato per interrogare lo stato del Traffic Light System (TLS) per una specifica tabella all'interno di un progetto in una data indicata. Il Traffic Light System fornisce informazioni sulla salute e sulla qualità dei dati, indicando eventuali problemi o allarmi che potrebbero richiedere attenzione.

Utilizzo del comando¶

bash dignacli tls-status

Argomenti¶

PROJECT_NAME: Il nome del progetto per il quale viene richiesta la stato TLS (obbligatorio).
TABLE_NAME: La tabella specifica all'interno del progetto per la quale è necessario lo stato TLS (obbligatorio).
DATE: La data per la quale viene richiesta la stato TLS, tipicamente nel formato %Y-%m-%d (obbligatorio).

Esempio¶

Per verificare lo stato TLS per una tabella chiamata UserData nel progetto ProjectA il 1º luglio 2024:

bash dignacli tls-status ProjectA UserData 2024-07-01

Questo comando aiuta gli utenti a monitorare e mantenere la qualità dei dati fornendo un report chiaro e azionabile basato su criteri predefiniti.

list-projects¶

Il comando list-projects nella CLI digna viene utilizzato per visualizzare un elenco di tutti i progetti disponibili nel sistema digna.

Utilizzo del comando¶

bash dignacli list-projects

Questo comando è particolarmente utile per amministratori e utenti che gestiscono più progetti, fornendo una panoramica rapida dei progetti disponibili nel repository digna.

list-ds¶

Il comando list-ds nella CLI digna viene utilizzato per visualizzare un elenco di tutte le sorgenti di dati disponibili all'interno di un progetto specificato. Questo comando è utile per comprendere le risorse dati disponibili per analisi e gestione nel sistema digna.

Utilizzo del comando¶

bash dignacli list-ds

Argomenti¶

PROJECT_NAME: Il nome del progetto per il quale vengono elencate le sorgenti di dati (obbligatorio).

Esempio¶

Per elencare tutte le sorgenti di dati nel progetto chiamato ProjectA:

bash dignacli list-ds ProjectA

Questo comando fornisce agli utenti una panoramica delle sorgenti di dati disponibili in un progetto, aiutandoli a navigare e gestire più efficacemente il panorama dei dati.