digna CLI Reference 2024.11¶

2024-11-03

Questa pagina documenta l'insieme completo dei comandi disponibili nella CLI di digna release 2024.11, inclusi esempi d'uso e opzioni.

Nozioni di base della CLI¶

Utilizzo dell'opzione help¶

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

1. Visualizzare l'help generale:

   Usa --help immediatamente dopo la parola chiave dignacli
   

   dignacli --help
   

2. 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:

   dignacli add-user --help
   

   ### output:

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

Utilizzo del comando check-repo-connection¶

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

Utilizzo del comando¶

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 ha successo, verifica che il file config.toml contenga le impostazioni di configurazione corrette.

Utilizzo del comando ‘version’¶

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

Utilizzo del comando¶

dignacli --version

Esempio di output¶

dignacli version 2024.11

Utilizzo delle opzioni di logging¶

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

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

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

Gestione utenti¶

Utilizzo del comando ‘add-user’¶

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

Utilizzo del comando¶

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 ha data di scadenza.

Esempio¶

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

dignacli add-user [OPTIONS] USER_NAME USER_FULL_NAME USER_PASSWORD

Per aggiungere un nuovo utente e impostare una data di scadenza dell'account:

dignacli add-user jdoe "John Doe" password123 --valid_until "2024-12-31 23:59:59"

Utilizzo del comando delete-user¶

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

Utilizzo del comando¶

dignacli delete-user USER_NAME

Argomenti¶

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

Esempio¶

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.

Utilizzo del comando modify-user¶

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

Utilizzo del comando¶

dignacli modify-user <USER_NAME> <USER_FULL_NAME> [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:

dignacli modify-user jdoe "Johnathan Doe" --is_superuser

Utilizzo del comando modify-user-pwd¶

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

Utilizzo del comando¶

dignacli modify-user-pwd <USER_NAME> <USER_PWD>

Argomenti¶

• USER_NAME: Il nome utente dell'utente di cui si vuole cambiare la password (obbligatorio).
• USER_PWD: La nuova password per l'utente (obbligatorio).

Esempio¶

Per cambiare la password dell'utente jdoe in newpassword123:

dignacli modify-user-pwd jdoe newpassword123

Utilizzo del comando list-users¶

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

Utilizzo del comando¶

dignacli list-users

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

Gestione del repository¶

Utilizzo del comando upgrade-repo¶

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

Utilizzo del comando¶

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 effettuarle realmente. Questo è utile per visualizzare le modifiche senza apportare alcuna modifica al repository.

Esempio¶

Per aggiornare il repository di digna, puoi eseguire il comando senza alcuna opzione:

dignacli upgrade-repo

dignacli upgrade-repo --simulation-mode

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

Utilizzo del comando encrypt¶

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

Utilizzo del comando¶

dignacli encrypt <PASSWORD>

Argomenti¶

• PASSWORD: La password che deve essere crittografata (obbligatorio).

Esempio¶

Per crittografare una password, devi fornire la password come argomento.
Ad esempio, per crittografare la password mypassword123, useresti:

dignacli encrypt mypassword123

Utilizzo del comando generate-key¶

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

Utilizzo del comando¶

dignacli generate-key

Gestione dei dati¶

Utilizzo del comando clean-up¶

Il comando clean-up nella CLI di digna viene utilizzato per rimuovere profili, previsioni e dati del sistema di semafori (traffic light system) per una o più sorgenti 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 ordinato ed efficiente eliminando dati obsoleti o non necessari.

Utilizzo del comando¶

dignacli clean-up <PROJECT_NAME> <FROM_DATE> <TO_DATE> [options]

Argomenti¶

• PROJECT_NAME: Il nome del progetto dal quale rimuovere i dati (obbligatorio). Usare la parola chiave all-projects in questo argomento istruisce digna a iterare su tutti i progetti esistenti e applicare questo comando.
• FROM_DATE: La data e ora di inizio per la rimozione dei dati. I formati accettati includono %Y-%m-%d, %Y-%m-%dT%H:%M:%S, o %Y-%m-%d %H:%M:%S (obbligatorio).
• TO_DATE: La data e 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 nel loro nome.
• --timing, -tm: Mostra la durata del processo di clean-up al termine.
• --help: Mostra 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:

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

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

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.

Utilizzo del comando inspect¶

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

Utilizzo del comando¶

dignacli inspect <PROJECT_NAME> <FROM_DATE> <TO_DATE> [options]

Argomenti¶

• PROJECT_NAME: Il nome del progetto per il quale ispezionare i dati (obbligatorio). Usare la parola chiave all-projects in questo argomento istruisce digna a iterare su tutti i progetti esistenti e applicare questo comando.
• FROM_DATE: La data e ora di inizio per l'ispezione dei dati. I formati accettati includono %Y-%m-%d, %Y-%m-%dT%H:%M:%S, o %Y-%m-%d %H:%M:%S (obbligatorio).
• TO_DATE: La data e 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.
• --do-profile: Avvia la raccolta (recollection) dei profili. Il valore predefinito è do-profile.
• --no-do-profile: Impedisce la raccolta dei profili.
• --do-prediction: Avvia il ricalcolo delle previsioni. Il valore predefinito è do-prediction.
• --no-do-prediction: Impedisce il ricalcolo delle previsioni.
• --do-alert-status: Avvia il ricalcolo degli stati di allerta. Il valore predefinito è do-alert-status.
• --no-do-alert-status: Impedisce il ricalcolo degli stati di allerta.
• --timing, -tm: Mostra la durata del processo di ispezione al termine.

Esempio¶

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

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

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

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

Utilizzo del comando tls-status¶

Il comando tls-status nella CLI di digna viene utilizzato per interrogare lo stato del Traffic Light System (TLS) per una specifica tabella all'interno di un progetto in una data determinata. 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¶

dignacli tls-status <PROJECT_NAME> <TABLE_NAME> <DATE>

Argomenti¶

• PROJECT_NAME: Il nome del progetto per il quale si sta interrogando lo 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 si sta interrogando lo 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:

dignacli tls-status ProjectA UserData 2024-07-01

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

Utilizzo del comando list-projects¶

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

Utilizzo del comando¶

dignacli list-projects

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

Utilizzo del comando list-ds¶

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

Utilizzo del comando¶

dignacli list-ds <PROJECT_NAME>

Argomenti¶

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

Esempio¶

Per elencare tutte le sorgenti dati nel progetto chiamato ProjectA:

dignacli list-ds ProjectA

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