Gå til innhold

digna CLI-referanse 2024.11

2024-11-03

Denne siden dokumenterer hele settet med kommandoer tilgjengelig i digna CLI-utgivelsen 2024.11, inkludert bruks-eksempler og alternativer.

CLI-grunnleggende

Bruke help-alternativet

Alternativet --help gir informasjon om tilgjengelige kommandoer og hvordan de brukes. Det finnes to hovedmåter å bruke dette alternativet på:

  1. Vise generell hjelp:

    Bruk --help umiddelbart etter nøkkelordet digna

    dignacli --help

  2. Få hjelp for spesifikke kommandoer:

    For detaljert informasjon om en spesifikk kommando, legg til --help etter den kommandoen.
    For eksempel, for å få hjelp med add-user-kommandoen, kjør: 

    dignacli add-user --help

    ### utdata:

    • Kommando-beskrivelse: Gir en detaljert beskrivelse av hva kommandoen gjør.
    • Syntaks: Viser eksakt syntaks, inkludert påkrevde og valgfrie argumenter.
    • Alternativer: Lister opp eventuelle alternativer som er spesifikke for kommandoen, sammen med forklaringer.
    • Eksempler: Gir eksempler på hvordan kommandoen kan kjøres effektivt.

Bruke check-repo-connection-kommandoen

Kommandoen check-repo-connection er et verktøy i digna CLI som er designet for å teste tilkobling og tilgang til et angitt digna-repository. Denne kommandoen sikrer at CLI-en kan kommunisere med repositoryet.

Kommando-bruk

dignacli check-repo-connection

Ved vellykket kjøring vil kommandoen gi en bekreftelse på tilkoblingen, sammen med detaljer om repositoryet: Repository-versjon, Host, Database og Schema.

Hvis repository-tilkoblingen ikke lykkes, sjekk filen config.toml for korrekte konfigurasjonsinnstillinger.

Bruke version-kommandoen

For å sjekke installert versjon av dignacli, bruk alternativet --version.

Kommando-bruk

dignacli --version

Eksempel på output

dignacli version 2024.11

Bruke logge-alternativer

Som standard er konsollutskriften fra digna-kommandoer laget for å være minimalistisk. De fleste kommandoer tilbyr muligheten til å gi tilleggsinformasjon ved å bruke følgende alternativer:

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

“verbose” og “debug” definerer detaljnivået, mens “logfile”-bryteren tillater å omdirigere utskrift til en fil i stedet for konsollen.

Brukeradministrasjon

Bruke add-user-kommandoen

Kommandoen add-user i digna CLI brukes for å legge til en ny bruker i digna-systemet.

Kommando-bruk

dignacli add-user [OPTIONS] USER_NAME USER_FULL_NAME USER_PASSWORD

Argumenter

  • USER_NAME: Brukernavnet for den nye brukeren (påkrevd).
  • USER_FULL_NAME: Fullt navn til den nye brukeren (påkrevd).
  • USER_PASSWORD: Passordet for den nye brukeren (påkrevd).

Alternativer

  • --is_superuser, -su: Flagg for å angi den nye brukeren som administrator.
  • --valid_until, -vu: Setter en utløpsdato for brukerkontoen i formatet YYYY-MM-DD HH:MI:SS. Hvis ikke satt, har kontoen ingen utløpsdato.

Eksempel

For å legge til en ny bruker med brukernavn jdoe, fullt navn John Doe og passord password123:

dignacli add-user [OPTIONS] USER_NAME USER_FULL_NAME USER_PASSWORD

For å legge til en ny bruker og sette en utløpsdato for kontoen: 

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

Bruke delete-user-kommandoen

Kommandoen delete-user i digna CLI brukes til å fjerne en eksisterende bruker fra digna-systemet.

Kommando-bruk

dignacli delete-user USER_NAME

Argumenter

  • USER_NAME: Brukernavnet til brukeren som skal slettes (påkrevd). Dette er det eneste argumentet som kreves av kommandoen.

Eksempel

dignacli delete-user jdoe

Ved kjøring av denne kommandoen vil brukeren jdoe bli fjernet fra digna-systemet, med tilbakekalling av tilgang og sletting av tilknyttede data og rettigheter i repositoryet.

Bruke modify-user-kommandoen

Kommandoen modify-user i digna CLI brukes til å oppdatere opplysninger om en eksisterende bruker i digna-systemet.

Kommando-bruk

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

Argumenter

  • USER_NAME: Brukernavnet til brukeren som skal endres (påkrevd).
  • USER_FULL_NAME: Det nye fulle navnet for brukeren (påkrevd).

Alternativer

  • --is_superuser, -su: Angir brukeren som superuser og gir forhøyede rettigheter. Dette flagget krever ikke en verdi.
  • --valid_until, -vu: Setter en utløpsdato for brukerkontoen i formatet YYYY-MM-DD HH:MI:SS. Hvis ikke oppgitt, forblir kontoen gyldig på ubestemt tid.

Eksempel

For å endre fullt navn for brukeren jdoe til “Johnathan Doe” og sette brukeren som superuser: 

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

Bruke modify-user-pwd-kommandoen

Kommandoen modify-user-pwd i digna CLI brukes til å endre passordet for en eksisterende bruker i digna-systemet.

Kommando-bruk

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

Argumenter

  • USER_NAME: Brukernavnet til brukeren hvis passord skal endres (påkrevd).
  • USER_PWD: Det nye passordet for brukeren (påkrevd).

Eksempel

For å endre passordet for brukeren jdoe til newpassword123: 

dignacli modify-user-pwd jdoe newpassword123

Bruke list-users-kommandoen

Kommandoen list-users i digna CLI viser en liste over alle brukere som er registrert i digna-systemet.

Kommando-bruk

dignacli list-users

Kjøring av denne kommandoen i digna CLI vil koble til digna-repositoryet og liste opp alle brukere, med deres ID, brukernavn, fulle navn, superuser-status og utløpstidspunkt.

Repository-administrasjon

Bruke upgrade-repo-kommandoen

Kommandoen upgrade-repo i digna CLI brukes til å oppgradere eller initialisere digna-repositoryet. Denne kommandoen er nødvendig for å anvende oppdateringer eller sette opp repository-infrastrukturen for første gang.

Kommando-bruk

dignacli upgrade-repo [options]

Alternativer

  • --simulation-mode, -s: Når aktivert, kjører dette alternativet kommandoen i simulasjonsmodus, som skriver ut SQL-setningene som ville blitt kjørt, men utfører dem ikke. Dette er nyttig for å forhåndsvise endringer uten å gjøre modifikasjoner i repositoryet.

Eksempel

For å oppgradere digna-repositoryet kan du kjøre kommandoen uten alternativer:

dignacli upgrade-repo
For å kjøre oppgraderingen i simulasjonsmodus (for å se SQL-setningene uten å anvende dem):

dignacli upgrade-repo --simulation-mode

Denne kommandoen er viktig for å vedlikeholde digna-systemet, og sikre at databaseskjemaet og andre repository-komponenter er oppdatert med den nyeste versjonen av programvaren.

Bruke encrypt-kommandoen

Kommandoen encrypt i digna CLI brukes for å kryptere et passord.

Kommando-bruk

dignacli encrypt <PASSWORD>

Argumenter

  • PASSWORD: Passordet som skal krypteres (påkrevd).

Eksempel

For å kryptere et passord må du oppgi passordet som et argument.
For eksempel, for å kryptere passordet mypassword123, vil du bruke: 

dignacli encrypt mypassword123
Denne kommandoen skriver ut den krypterte versjonen av det angitte passordet, som deretter kan brukes i sikre sammenhenger. Hvis passord-argumentet ikke oppgis, vil CLI-en vise en feil som indikerer manglende argument.

Bruke generate-key-kommandoen

Kommandoen generate-key brukes til å generere en Fernet-nøkkel, som er nødvendig for å sikre passord som lagres i digna-repositoryet.

Kommando-bruk

dignacli generate-key

Databehandling

Bruke clean-up-kommandoen

Kommandoen clean-up i digna CLI brukes til å fjerne profiler, prediksjoner og data fra Traffic Light System for én eller flere datakilder innen et angitt prosjekt. Denne kommandoen er viktig for livssyklushåndtering av data, og hjelper med å opprettholde et organisert og effektivt data-miljø ved å rydde ut foreldet eller unødvendig data.

Kommando-bruk

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

Argumenter

  • PROJECT_NAME: Navnet på prosjektet hvorfra data skal fjernes (påkrevd). Bruk av nøkkelordet all-projects i dette argumentet instruerer digna om å iterere over alle eksisterende prosjekter og anvende denne kommandoen.
  • FROM_DATE: Startdato og tidspunkt for datarensingen. Akseptable formater inkluderer %Y-%m-%d, %Y-%m-%dT%H:%M:%S, eller %Y-%m-%d %H:%M:%S (påkrevd).
  • TO_DATE: Sluttdato og tidspunkt for datarensingen, med samme formater som FROM_DATE (påkrevd).

Alternativer

  • --table-name, -tn: Begrens clean-up-operasjonen til en spesifikk tabell innen prosjektet.
  • --table-filter, -tf: Filtre for å begrense clean-up til tabeller som inneholder den angitte delstrengen i navnene.
  • --timing, -tm: Viser tidsforbruket for clean-up-prosessen etter fullføring.
  • --help: Viser hjelpeinformasjon for clean-up-kommandoen og avslutter.

Eksempel

For å fjerne data fra prosjektet ProjectA mellom 1. januar 2023 og 30. juni 2023:

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

For å fjerne data kun fra en spesifikk tabell kalt Table1:

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

Denne kommandoen hjelper med å styre datalagring og sikre at repositoryet kun inneholder relevant informasjon.

Bruke inspect-kommandoen

Kommandoen inspect i digna CLI brukes til å lage profiler, prediksjoner og data for Traffic Light System for én eller flere datakilder innen et angitt prosjekt. Denne kommandoen hjelper med å analysere og overvåke data over en definert periode.

Kommando-bruk

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

Argumenter

  • PROJECT_NAME: Navnet på prosjektet som data skal inspiseres for (påkrevd). Bruk av nøkkelordet all-projects i dette argumentet instruerer digna om å iterere over alle eksisterende prosjekter og anvende denne kommandoen.
  • FROM_DATE: Startdato og tidspunkt for data-inspeksjonen. Akseptable formater inkluderer %Y-%m-%d, %Y-%m-%dT%H:%M:%S, eller %Y-%m-%d %H:%M:%S (påkrevd).
  • TO_DATE: Sluttdato og tidspunkt for data-inspeksjonen, med samme formater som FROM_DATE (påkrevd).

Alternativer

  • --table-name, -tn: Begrens inspeksjonen til en spesifikk tabell innen prosjektet.
  • --table-filter, -tf: Filtrer for å inspisere kun tabeller som inneholder den angitte delstrengen i navnene.
  • --do-profile: Trigger gjeninnsamling av profiler. Standard er do-profile.
  • --no-do-profile: Forhindrer gjeninnsamling av profiler.
  • --do-prediction: Trigger rekalkulering av prediksjoner. Standard er do-prediction.
  • --no-do-prediction: Forhindrer rekalkulering av prediksjoner.
  • --do-alert-status: Trigger rekalkulering av varslingsstatus. Standard er do-alert-status.
  • --no-do-alert-status: Forhindrer rekalkulering av varslingsstatus.
  • --timing, -tm: Viser varigheten av inspeksjonsprosessen etter fullføring.

Eksempel

For å inspisere data for prosjektet ProjectA fra 1. januar 2024 til 31. januar 2024:

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

For å inspisere kun en spesifikk tabell og tvinge rekalkulering av prediksjoner:

dignacli inspect ProjectA 2024-01-01 2024-01-31 --table-name Table1 --force-prediction
Denne kommandoen er nyttig for å generere oppdaterte profiler og prediksjoner, overvåke dataintegritet og håndtere varslingssystemer innen et angitt prosjekt-tidsrom.

Bruke tls-status-kommandoen

Kommandoen tls-status i digna CLI brukes til å spørre om status for Traffic Light System (TLS) for en spesifikk tabell i et prosjekt på en gitt dato. Traffic Light System gir innsikt i datakvalitet og -helse, og indikerer eventuelle problemer eller varsler som trenger oppmerksomhet.

Kommando-bruk

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

Argumenter

  • PROJECT_NAME: Navnet på prosjektet som TLS-statusen forespørres for (påkrevd).
  • TABLE_NAME: Den spesifikke tabellen i prosjektet som TLS-statusen gjelder for (påkrevd).
  • DATE: Datoen som TLS-statusen gjelder for, typisk i formatet %Y-%m-%d (påkrevd).

Eksempel

For å sjekke TLS-status for en tabell kalt UserData i prosjektet ProjectA den 1. juli 2024:

dignacli tls-status ProjectA UserData 2024-07-01

Denne kommandoen hjelper brukere med å overvåke og opprettholde datakvalitet ved å gi en klar og handlingsbar statusrapport basert på forhåndsdefinerte kriterier.

Bruke list-projects-kommandoen

Kommandoen list-projects i digna CLI brukes til å vise en liste over alle tilgjengelige prosjekter i digna-systemet.

Kommando-bruk

dignacli list-projects

Denne kommandoen er spesielt nyttig for administratorer og brukere som administrerer flere prosjekter, og gir en rask oversikt over tilgjengelige prosjekter i digna-repositoryet.

Bruke list-ds-kommandoen

Kommandoen list-ds i digna CLI brukes til å vise en liste over alle tilgjengelige datakilder innen et angitt prosjekt. Denne kommandoen er nyttig for å forstå hvilke dataressurser som er tilgjengelige for analyse og administrasjon i digna-systemet.

Kommando-bruk

dignacli list-ds <PROJECT_NAME>

Argumenter

  • PROJECT_NAME: Navnet på prosjektet som datakildene skal listes for (påkrevd).

Eksempel

For å liste alle datakilder i prosjektet kalt ProjectA:

dignacli list-ds ProjectA

Denne kommandoen gir brukere en oversikt over datakildene som er tilgjengelige i et prosjekt, og hjelper dem å navigere og administrere data-landskapet mer effektivt.