digna CLI Reference 2024.12¶

2024-12-09

Denna sida dokumenterar hela uppsättningen kommandon som finns i digna CLI-release 2024.12, inklusive användningsexempel och alternativ.

2024-12-09

CLI Basics¶

Using help Option¶

Alternativet --help ger information om tillgängliga kommandon och deras användning. Det finns två huvudsakliga sätt att använda detta alternativ:

1. Visa generell hjälp:

   Använd --help direkt efter kommandot dignacli
   

   dignacli --help
   

2. Få hjälp för specifika kommandon:

   För detaljerad information om ett specifikt kommando, lägg till --help efter det kommandot. Till exempel, för att få hjälp med kommandot add-user, kör:

   dignacli add-user --help
   

   ### output:

   • Command Description: Ger en detaljerad beskrivning av vad kommandot gör.
   • Syntax: Visar exakt syntax, inklusive obligatoriska och valfria argument.
   • Options: Lista över eventuella alternativ som är specifika för kommandot, tillsammans med deras förklaringar.
   • Examples: Ger exempel på hur kommandot kan köras effektivt.

Using check-repo-connection Command¶

Kommandot check-repo-connection är ett verktyg inom digna CLI som är avsett att testa anslutning och åtkomst till ett angivet digna repository. Detta kommando säkerställer att CLI:n kan interagera med repositoryt.

Command Usage¶

dignacli check-repo-connection

Vid lyckad körning visar kommandot en bekräftelse på anslutningen, tillsammans med detaljer om repositoryt: Repository version, Host, Database och Schema.

Om repository-anslutningen inte lyckas, kontrollera filen config.toml för korrekta konfigurationsinställningar.

Using ‘version’ command¶

För att kontrollera vilken version av dignacli som är installerad, använd alternativet --version.

Command Usage¶

dignacli --version

Example Output¶

dignacli version 2024.12

Using logging options¶

Som standard är konsolutmatningen för digna-kommandon avsedd att vara minimalistisk. De flesta kommandon erbjuder möjligheten att visa mer information genom följande alternativ:

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

”verbose” och ”debug” definierar detaljnivån, medan växeln ”logfile” tillåter att omdirigera utdata så att det strömmas till en fil istället för konsolfönstret.

User Management¶

Using ‘add-user’ command¶

Kommandot add-user i digna CLI används för att lägga till en ny användare i digna-systemet.

Command Usage¶

dignacli add-user [OPTIONS] USER_NAME USER_FULL_NAME USER_PASSWORD

Arguments¶

• USER_NAME: Användarnamnet för den nya användaren (obligatoriskt).
• USER_FULL_NAME: Den fullständiga namnet för den nya användaren (obligatoriskt).
• USER_PASSWORD: Lösenordet för den nya användaren (obligatoriskt).

Options¶

• --is_superuser, -su: Flagga för att ange den nya användaren som administratör.
• --valid_until, -vu: Sätter ett utgångsdatum för användarkontot i formatet YYYY-MM-DD HH:MI:SS. Om det inte anges har kontot inget utgångsdatum.

Example¶

För att lägga till en ny användare med användarnamn jdoe, fullständigt namn John Doe och lösenord password123:

dignacli add-user [OPTIONS] USER_NAME USER_FULL_NAME USER_PASSWORD

För att lägga till en ny användare och sätta ett utgångsdatum för kontot:

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

Using delete-user command¶

Kommandot delete-user i digna CLI används för att ta bort en befintlig användare från digna-systemet.

Command Usage¶

dignacli delete-user USER_NAME

Arguments¶

• USER_NAME: Användarnamnet för den användare som ska tas bort (obligatoriskt). Detta är det enda argument som krävs av kommandot.

Example¶

dignacli delete-user jdoe

Genom att köra detta kommando tas användaren jdoe bort från digna-systemet, åtkomsten återkallas och deras associerade data och rättigheter tas bort från repositoryt.

Using modify-user Command¶

Kommandot modify-user i digna CLI används för att uppdatera uppgifterna för en befintlig användare i digna-systemet.

Command Usage¶

dignacli modify-user <USER_NAME> <USER_FULL_NAME> [options]

Arguments¶

• USER_NAME: Användarnamnet för den användare som ska ändras (obligatoriskt).
• USER_FULL_NAME: Det nya fullständiga namnet för användaren (obligatoriskt).

Options¶

• --is_superuser, -su: Sätter användaren som superuser och ger förhöjda privilegier. Denna flagga kräver inget värde.
• --valid_until, -vu: Sätter ett utgångsdatum för användarkontot i formatet YYYY-MM-DD HH:MI:SS. Om det inte anges förblir kontot giltigt på obestämd tid.

Example¶

För att ändra fullständigt namn för användaren jdoe till ”Johnathan Doe” och sätta användaren som superuser:

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

Using modify-user-pwd Command¶

Kommandot modify-user-pwd i digna CLI används för att byta lösenord för en befintlig användare i digna-systemet.

Command Usage¶

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

Arguments¶

• USER_NAME: Användarnamnet för den användare vars lösenord ska ändras (obligatoriskt).
• USER_PWD: Det nya lösenordet för användaren (obligatoriskt).

Example¶

För att ändra lösenordet för användaren jdoe till newpassword123:

dignacli modify-user-pwd jdoe newpassword123

Using list-users Command¶

Kommandot list-users i digna CLI visar en lista över alla användare som är registrerade i digna-systemet.

Command Usage¶

dignacli list-users

När detta kommando körs i digna CLI kommer det att ansluta till digna-repositoryt och lista alla användare, visa deras ID, användarnamn, fullständiga namn, superuser-status och utgångstidsstämplar.

Repository Management¶

Using upgrade-repo Command¶

Kommandot upgrade-repo i digna CLI används för att uppgradera eller initiera digna-repositoryt. Detta kommando är nödvändigt för att tillämpa uppdateringar eller för att sätta upp repository-infrastrukturen för första gången.

Command Usage¶

dignacli upgrade-repo [options]

Options¶

• --simulation-mode, -s: När detta är aktiverat körs kommandot i simuleringsläge, vilket skriver ut de SQL-satser som skulle köras men utför dem inte. Detta är användbart för att förhandsgranska ändringar utan att göra några modifieringar i repositoryt.

Example¶

För att uppgradera digna-repositoryt kan du köra kommandot utan några alternativ:

dignacli upgrade-repo

dignacli upgrade-repo --simulation-mode

Detta kommando är viktigt för att underhålla digna-systemet och säkerställa att databasens schema och andra repository-komponenter är uppdaterade i förhållande till den senaste programvaruversionen.

Using encrypt Command¶

Kommandot encrypt i digna CLI används för att kryptera ett lösenord.

Command Usage¶

dignacli encrypt <PASSWORD>

Arguments¶

• PASSWORD: Lösenordet som ska krypteras (obligatoriskt).

Example¶

För att kryptera ett lösenord måste du ange lösenordet som ett argument.
Till exempel, för att kryptera lösenordet mypassword123 använder du:

dignacli encrypt mypassword123

Using generate-key Command¶

Kommandot generate-key används för att generera en Fernet-nyckel, vilken är nödvändig för att säkra lösenord som lagras i digna-repositoryt.

Command Usage¶

dignacli generate-key

Data Management¶

Using clean-up Command¶

Kommandot clean-up i digna CLI används för att ta bort profiler, prediktioner och trafikljussystemdata för en eller flera datakällor inom ett angivet projekt. Detta kommando är viktigt för livscykelhantering av data och hjälper till att hålla en organiserad och effektiv data-miljö genom att rensa ut föråldrad eller onödig data.

Command Usage¶

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

Arguments¶

• PROJECT_NAME: Namnet på projektet där data ska tas bort (obligatoriskt). Genom att använda nyckelordet all-projects i detta argument instrueras digna att iterera över alla befintliga projekt och tillämpa kommandot.
• FROM_DATE: Startdatum och tid för data-borttagningen. Acceptabla format inkluderar %Y-%m-%d, %Y-%m-%dT%H:%M:%S eller %Y-%m-%d %H:%M:%S (obligatoriskt).
• TO_DATE: Slutdatum och tid för data-borttagningen, med samma format som FROM_DATE (obligatoriskt).

Options¶

• --table-name, -tn: Begränsar clean-up-operationen till en specifik tabell inom projektet.
• --table-filter, -tf: Filtrerar för att begränsa clean-up till tabeller som innehåller den angivna delsträngen i sina namn.
• --timing, -tm: Visar tidsåtgången för clean-up-processen efter avslutad körning.
• --help: Visar hjälpinformation för clean-up-kommandot och avslutar.

Example¶

För att ta bort data från projektet ProjectA mellan 1 januari 2023 och 30 juni 2023:

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

För att bara ta bort data från en specifik tabell med namnet Table1:

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

Detta kommando hjälper till att hantera datalagring och säkerställer att repositoryt endast innehåller relevant information.

Using inspect Command¶

Kommandot inspect i digna CLI används för att skapa profiler, prediktioner och trafikljussystemdata för en eller flera datakällor inom ett angivet projekt. Detta kommando hjälper till att analysera och övervaka data över en definierad period.

Command Usage¶

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

Arguments¶

• PROJECT_NAME: Namnet på projektet som data ska inspekteras för (obligatoriskt). Genom att använda nyckelordet all-projects i detta argument instrueras digna att iterera över alla befintliga projekt och tillämpa kommandot.
• FROM_DATE: Startdatum och tid för data-inspektionen. Acceptabla format inkluderar %Y-%m-%d, %Y-%m-%dT%H:%M:%S eller %Y-%m-%d %H:%M:%S (obligatoriskt).
• TO_DATE: Slutdatum och tid för data-inspektionen, med samma format som FROM_DATE (obligatoriskt).

Options¶

• --table-name, -tn: Begränsar inspektionen till en specifik tabell inom projektet.
• --table-filter, -tf: Filtrerar för att endast inspektera tabeller som innehåller den angivna delsträngen i sina namn.
• --do-profile: Triggar ominsamling av profiler. Standard är do-profile.
• --no-do-profile: Förhindrar ominsamling av profiler.
• --do-prediction: Triggar omberäkning av prediktioner. Standard är do-prediction.
• --no-do-prediction: Förhindrar omberäkning av prediktioner.
• --do-alert-status: Triggar omberäkning av alert-statusar. Standard är do-alert-status.
• --no-do-alert-status: Förhindrar omberäkning av alert-statusar.
• --iterative: Triggar inspektion av perioden med dagliga iterationer. Standard är iterative.
• --no-iterative: Triggar inspektion av hela perioden på en gång.
• --timing, -tm: Visar varaktigheten för inspektionsprocessen efter avslutad körning.

Example¶

För att inspektera data för projektet ProjectA från 1 januari 2024 till 31 januari 2024:

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

För att inspektera endast en viss tabell och tvinga omberäkning av prediktioner:

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

Using tls-status Command¶

Kommandot tls-status i digna CLI används för att fråga efter status för Traffic Light System (TLS) för en specifik tabell inom ett projekt på ett givet datum. Trafikljussystemet ger insikter om datans hälsa och kvalitet och indikerar eventuella problem eller varningar som kan kräva åtgärd.

Command Usage¶

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

Arguments¶

• PROJECT_NAME: Namnet på projektet som TLS-statusen frågas för (obligatoriskt).
• TABLE_NAME: Den specifika tabellen inom projektet som TLS-statusen behövs för (obligatoriskt).
• DATE: Datumet som TLS-statusen frågas för, vanligtvis i formatet %Y-%m-%d (obligatoriskt).

Example¶

För att kontrollera TLS-statusen för en tabell med namnet UserData i projektet ProjectA den 1 juli 2024:

dignacli tls-status ProjectA UserData 2024-07-01

Detta kommando hjälper användare att övervaka och upprätthålla datakvalitet genom att tillhandahålla en tydlig och handlingsbar statusrapport baserad på fördefinierade kriterier.

Using list-projects Command¶

Kommandot list-projects i digna CLI används för att visa en lista över alla tillgängliga projekt inom digna-systemet.

Command Usage¶

dignacli list-projects

Detta kommando är särskilt användbart för administratörer och användare som hanterar flera projekt och ger en snabb överblick över tillgängliga projekt i digna-repositoryt.

Using list-ds Command¶

Kommandot list-ds i digna CLI används för att visa en lista över alla tillgängliga datakällor inom ett angivet projekt. Detta kommando är användbart för att förstå vilka dataresurser som finns för analys och hantering i digna-systemet.

Command Usage¶

dignacli list-ds <PROJECT_NAME>

Arguments¶

• PROJECT_NAME: Namnet på projektet för vilket datakällorna listas (obligatoriskt).

Example¶

För att lista alla datakällor i projektet som heter ProjectA:

dignacli list-ds ProjectA

Detta kommando ger användare en överblick över de datakällor som finns i ett projekt och hjälper dem att navigera och hantera datalandskapet mer effektivt.