digna CLI -referenssi 2026.06¶

2026-09-05

Tämä sivu dokumentoi kaikki komennot, jotka ovat käytettävissä digna CLI -julkaisussa 2026.06, mukaan lukien käyttöesimerkit ja valitsimet.

Suoritettavan tiedoston nimi on digna.

CLI:n perusteet¶

Yleiskatsaus ja syntaksi¶

Julkaisun 2026.06 CLI käyttää jäsenneltyä, luokkiin perustuvaa komentohierarkiaa:

digna [GLOBAL_OPTIONS] <COMMAND_CATEGORY> <SUBCOMMAND> [OPTIONS] [ARGUMENTS]

version ja serve ovat yksittäisiä komentoja ilman alikomentoa:

digna [GLOBAL_OPTIONS] <COMMAND> [OPTIONS] [ARGUMENTS]

Yleiset valitsimet¶

Seuraavat yleiset valitsimet koskevat kaikkia komentoja:

--help, -h: Näyttää ohjetiedot CLI:stä tai tietystä komentoluokasta tai alikomennosta.
--stacktrace: Näyttää virhetilanteessa koko virheketjun pelkän ylimmän tason viestin sijaan.

--stacktrace on yleinen valitsin varsinaisessa merkityksessä: se on annettava ennen komentoluokkaa, ei sen jälkeen.

digna --stacktrace repo check     # correct
digna repo check --stacktrace     # rejected: unknown argument

--version-lippua ei ole. Käytä sen sijaan komentoa version.

Edellytykset¶

Useimmat komennot tarvitsevat luettavan ja kelvollisen config.toml-tiedoston; jotkin vaativat lisäksi voimassa olevan lisenssin. Seuraava taulukko kertoo, mitä kukin komentoluokka lataa ennen kuin se tekee mitään:

Komentoluokka	Tarvitsee `config.toml`-tiedoston	Tarvitsee voimassa olevan lisenssin
`version`	ei	ei
`config check`	ei (se on juuri se, mistä komento raportoi)	ei
`license check`	ei	se on itse tarkistus
`crypt`	kyllä	ei
`serve`	kyllä	ei
`windows`	ei (palvelu lukee sen käynnistyessään)	ei
`project`	kyllä	ei
`user`	kyllä	kyllä
`inspection`	kyllä	kyllä
`repo`	kyllä	kyllä

Kun lisenssi vaaditaan, tarkistetaan sekä sen allekirjoitus että voimassaolon päättymispäivä, ja komento keskeytyy ennen tietovaraston koskettamista, jos jompikumpi epäonnistuu.

Paluukoodit¶

0: komento onnistui.
1: komento epäonnistui. Virheilmoitus kirjoitetaan stderr-virtaan etuliitteellä Error:.

help¶

Valitsin --help antaa tietoa käytettävissä olevista komentoluokista, alikomennoista ja valitsimista:

Yleisen ohjeen näyttäminen:
```
digna --help
```
Ohjeen hakeminen tietyille luokille ja komennoille:
```
digna user --help
digna user add --help
```

Tuloste sisältää: - Komennon kuvauksen: Yhteenvedon komennon tarkoituksesta. - Syntaksin: Pakolliset ja valinnaiset argumentit. - Valitsimet: Komennolle ominaiset liput ja parametrit.

version¶

Komento version tulostaa asennetun digna-julkaisun. Se ei lue mitään asetuksia eikä vahvista lisenssiä, joten se toimii myös asennuksessa, jonka config.toml tai lisenssi puuttuu tai on virheellinen.

Julkaisun versio on riippumaton tietovaraston skeeman versiosta, jonka repo check raportoi.

Komennon käyttö¶

digna version

Esimerkkituloste¶

2026.06

Asetusten hallinta¶

config check¶

Komento config check vahvistaa asetustiedoston (config.toml) tarkistamalla, että kaikki pakolliset osiot ja asetukset ovat olemassa ja oikein muotoiltuja. Kukin osio vahvistetaan erikseen, joten rikkinäinen [app]-osio ei peitä [repo]-osion tilaa.

Raportoitavat osiot ovat:

App config ([app])
Repository config ([repo])
Base config ([base])
Logging config ([logging])
Encryption config ([encryption])
OIDC config(s) (oidc_clients) — valinnainen; puuttuva avain läpäisee tarkistuksen, mutta olemassa oleva mutta virheellisesti muotoiltu luettelo epäonnistuu

Komento ei tarkoituksella lataa sovelluksen asetuksia samalla tavalla kuin muut komennot, jotta se voi diagnosoida config.toml-tiedoston, joka estäisi digna-ohjelmistoa käynnistymästä lainkaan.

Komennon käyttö¶

digna config check [OPTIONS]

Valitsimet¶

--configpath, -c: Polku asetustiedostoon tai hakemistoon, joka sisältää config.toml-tiedoston (oletus ./config.toml).
--json: Tulostaa vahvistusraportin JSON-muodossa. Ohittaa valitsimen --quiet.
--quiet, -q: Piilottaa raportin ja luottaa yksinomaan paluukoodiin.

Esimerkki¶

digna config check

Tietyn asetustiedoston vahvistaminen ja tulosteen muotoilu JSON-muotoon:

digna config check --configpath /etc/digna/config.toml --json

Esimerkkituloste¶

Configuration validation report (source: config.toml):
 - App config: OK
 - Repository config: OK
 - Base config: OK
 - Logging config: OK
 - Encryption config: FAILED
    missing field `aes_gcm_key`
 - OIDC config(s): OK

Overall: FAILED

Puuttuva tiedosto tai TOML-syntaksivirhe ei jätä mitään osioittain vahvistettavaa, ja siitä raportoidaan yhtenä virheenä raportin sijaan riippumatta valitsimista --quiet tai --json.

Tietovaraston hallinta¶

repo check¶

Komento repo check testaa tietokantayhteyden ja varmistaa tietovaraston asennuksen ja version. Se epäonnistuu, jos määritettyä skeemaa ei ole olemassa tai jos se on olemassa mutta ei sisällä digna-tietovarastoa.

Raportoitava versio on tietovaraston skeeman versio, jonka versiointi on erillinen version-komennon tulostamasta digna-julkaisusta.

Komennon käyttö¶

digna repo check

Esimerkkituloste¶

Repo version 3.0.0 installed

repo install¶

Komento repo install asentaa uuden digna-tietovaraston config.toml-tiedostossa määritettyyn skeemaan luoden kaikki tarvittavat sekvenssit, taulut, indeksit, rajoitteet ja alkutietueet.

Tämä komento ei luo itse skeemaa — sen on oltava olemassa etukäteen. Komento myös kieltäytyy suorittumasta, jos kyseiseen skeemaan on jo asennettu tietovarasto, ja ohjaa komentoon repo upgrade, jos asennettu versio on vanhempi.

Komennon käyttö¶

digna repo install

Esimerkkituloste¶

Installing repo version 3.0.0
✅ Sequences created.
✅ Tables and Indices created.
✅ Constraints created.
✅ Records inserted.
✅ Repo version 3.0.0 successfully installed.

repo upgrade¶

Komento repo upgrade soveltaa tietokantaskeeman migraatioita nostaakseen olemassa olevan tietovaraston versioon, jota asennettu julkaisu odottaa. Päivitykset sovelletaan yksi versioaskel kerrallaan kiinteää päivityspolkua pitkin, ja jokainen valmistunut askel kirjataan tietovarastoon.

Jos tietovarasto on jo odotetussa versiossa, komento ilmoittaa, ettei päivitystä tarvita, eikä tee muutoksia.

Komennon käyttö¶

digna repo upgrade

Esimerkkituloste¶

Upgrading from 2.3.1 to 2.3.2...
Upgrading from 2.3.2 to 3.0.0...
✅ Repo successfully upgraded to version 3.0.0.

repo prune¶

Komento repo prune poistaa rivit, jotka ovat jääneet jäljelle, kun niiden projekti tai tietolähde on poistettu. Projektin tai tietolähteen poistaminen poistaa itse objektin, mutta jättää sen profiilit, ennusteet, tilat ja rivimäärät paikalleen — tämä on tietoinen valinta, sillä poisto, joka tyhjentäisi myös nämä taulut, pitäisi käyttäjän odottamassa. repo prune on siivousajo, joka poistaa ne, ja sen voi turvallisesti suorittaa milloin tahansa: se poistaa vain rivejä, joiden projektia tai tietolähdettä ei enää ole olemassa.

Python-taustajärjestelmän kirjoittamiin riveihin tauluissa, joita nykyinen julkaisu ei enää käytä, ei kosketa.

Komennon käyttö¶

digna repo prune [OPTIONS]

Valitsimet¶

--dry-run: Raportoi, mitä poistettaisiin, poistamatta mitään.

Vain taulut, joissa on orpoja rivejä, luetellaan. Jos niitä ei ole, komento ilmoittaa No orphaned rows found. ja päättyy.

Esimerkki¶

digna repo prune

Esimerkkituloste¶

"check"                                 29342
check_profile                           29342
check_prediction                        29342
check_status                            29342
column_status                              32
inspection_query                          253
---------------------------------------------
total                                  117854

✅ Removed 117854 orphaned row(s).

Saman raportin näkeminen poistamatta mitään:

digna repo prune --dry-run

Rivimäärät ovat samat; vain viimeinen rivi eroaa:

---------------------------------------------
total                                  117854

Dry run - nothing was removed.

Salauksen hallinta¶

crypt gen-key¶

Komento crypt gen-key luo uuden AES-GCM-salausavaimen käytettäväksi salausavaimena config.toml-tiedostossa. Ladattavan config.toml-tiedoston on oltava jo olemassa, vaikka luotu avain ei riipu siitä.

Komennon käyttö¶

digna crypt gen-key

Esimerkkituloste¶

Encryption key: <base64-encoded key>

crypt encrypt¶

Komento crypt encrypt salaa merkkijonon (kuten tietokannan salasanan) config.toml-tiedostossa määritetyllä AES-GCM-avaimella ja tulostaa salatun tekstin.

Komennon käyttö¶

digna crypt encrypt <VALUE>

Argumentit¶

VALUE: Salattava selkokielinen merkkijono (pakollinen).

Esimerkki¶

digna crypt encrypt mysecretpassword

crypt decrypt¶

Komento crypt decrypt purkaa AES-GCM-salatun merkkijonon config.toml-tiedostossa määritetyllä avaimella ja tulostaa selkokielisen tekstin.

Komennon käyttö¶

digna crypt decrypt <VALUE>

Argumentit¶

VALUE: Purettava salattu merkkijono (pakollinen).

Esimerkki¶

digna crypt decrypt "encrypted_string_here"

Käyttäjien hallinta¶

user add¶

Komento user add luo uuden käyttäjätilin digna-tietovarastoon. Komento epäonnistuu, jos annetulla sähköpostiosoitteella on jo käyttäjä.

Komennon käyttö¶

digna user add <EMAIL> <PASSWORD> <DISPLAY_NAME> [OPTIONS]

Argumentit¶

EMAIL: Käyttäjän sähköpostiosoite (pakollinen).
PASSWORD: Käyttäjän alkuperäinen salasana (pakollinen).
DISPLAY_NAME: Käyttäjän täydellinen näyttönimi (pakollinen).

Valitsimet¶

--admin, -a: Luo käyttäjän pääkäyttäjän (superuser) oikeuksin.

Esimerkki¶

digna user add jdoe@example.com "SecurePass123!" "John Doe"

Pääkäyttäjätilin luominen:

digna user add admin@example.com "AdminPass123!" "Admin User" --admin

Esimerkkituloste¶

User created with ID: 42

user list¶

Komento user list luettelee kaikki rekisteröidyt käyttäjät taulukkomuodossa tunnisteen, sähköpostiosoitteen, näyttönimen ja pääkäyttäjälipun kera.

Komennon käyttö¶

digna user list

Esimerkkituloste¶

ID                   EMAIL                          DISPLAY NAME                   ADMIN
-----------------------------------------------------------------------------------------------
42                   jdoe@example.com               John Doe                       false
43                   admin@example.com              Admin User                     true

user modify¶

Komento user modify päivittää olemassa olevan, sähköpostiosoitteella yksilöidyn käyttäjätilin näyttönimen ja pääkäyttäjäoikeudet.

Sekä näyttönimi että pääkäyttäjälippu kirjoitetaan aina. --admin on kytkin, ei arvo: sen pois jättäminen poistaa pääkäyttäjäoikeudet, joten anna se aina, kun käyttäjän on säilytettävä ne tai saatava ne.

Komennon käyttö¶

digna user modify <EMAIL> <DISPLAY_NAME> [OPTIONS]

Argumentit¶

EMAIL: Muokattavan käyttäjän sähköpostiosoite (pakollinen).
DISPLAY_NAME: Päivitetty näyttönimi (pakollinen).

Valitsimet¶

--admin, -a: Myöntää pääkäyttäjäoikeudet. Jätä pois poistaaksesi ne.
--valid-until, -v: Hyväksytään yhteensopivuuden vuoksi, mutta sitä ei tällä hetkellä sovelleta. Sen antaminen tulostaa varoituksen eikä muuta mitään.

Esimerkki¶

digna user modify jdoe@example.com "Johnathan Doe" --admin

Esimerkkituloste¶

User jdoe@example.com modified successfully

user modify-pwd¶

Komento user modify-pwd päivittää olemassa olevan käyttäjätilin salasanan.

Komennon käyttö¶

digna user modify-pwd <EMAIL> <PASSWORD>

Argumentit¶

EMAIL: Sen käyttäjän sähköpostiosoite, jonka salasana päivitetään (pakollinen).
PASSWORD: Uusi salasana (pakollinen).

Esimerkki¶

digna user modify-pwd jdoe@example.com "NewSecurePass456!"

user delete¶

Komento user delete poistaa käyttäjätilin järjestelmästä.

Komennon käyttö¶

digna user delete <EMAIL>

Argumentit¶

EMAIL: Poistettavan käyttäjän sähköpostiosoite (pakollinen).

Esimerkki¶

digna user delete jdoe@example.com

Projektien ja tietolähteiden hallinta¶

project list¶

Komento project list luettelee kaikki tietovarastossa saatavilla olevat projektit näyttäen niiden tunnisteen, nimen ja kuvauksen.

Komennon käyttö¶

digna project list

Esimerkkituloste¶

ID                   NAME                           DESCRIPTION
------------------------------------------------------------------------------------------------------
7                    ProjectA                       Sales data quality
8                    ProjectB                       Finance data quality

project list-ds¶

Komento project list-ds luettelee kaikki tiettyyn projektiin liitetyt tietolähteet näyttäen niiden tunnisteen, nimen, tyypin, skeeman ja taulun nimen.

Komennon käyttö¶

digna project list-ds <PROJECT_NAME>

Argumentit¶

PROJECT_NAME: Sen projektin nimi, jonka tietolähteet luetellaan (pakollinen). Nimen on täsmättävä täsmälleen.

Esimerkki¶

digna project list-ds ProjectA

Esimerkkituloste¶

ID                   NAME                           KIND            SCHEMA               TABLE
-------------------------------------------------------------------------------------------------------------
101                  orders                         Table           sales                orders
102                  customers                      Table           sales                customers

project export-ds¶

Komento project export-ds vie projektin tietolähteet JSON-dokumenttiin.

Jos kumpaakaan valitsinta --table-name tai --table-id ei anneta, viedään kaikki projektin tietolähteet.

Komennon käyttö¶

digna project export-ds <PROJECT_NAME> [OPTIONS]

Argumentit¶

PROJECT_NAME: Sen projektin nimi, josta tietolähteet viedään (pakollinen).

Valitsimet¶

--table-name, -n: Vietävien tietolähteiden nimet. Useita nimiä voi antaa välilyönnein eroteltuina.
--table-id, -i: Vietävien tietolähteiden tunnisteet. Useita tunnisteita voi antaa välilyönnein eroteltuina.
--exportfile, -f: Polku, johon viedyt tietolähteet tallennetaan (oletus: data_sources_export.json).

Esimerkki¶

Kaikkien tietolähteiden vieminen projektista ProjectA:

digna project export-ds ProjectA --exportfile my_export.json

Tiettyjen taulujen vieminen:

digna project export-ds ProjectA --table-name users orders -f users_orders_export.json

Esimerkkituloste¶

Successfully exported 2 data source(s) to users_orders_export.json

project import-ds¶

Komento project import-ds tuo tietolähteet vientitiedostosta kohdeprojektiin ja raportoi objektikohtaisesti, mitä luotiin, päivitettiin tai ohitettiin.

Komennon käyttö¶

digna project import-ds <PROJECT_NAME> <EXPORT_FILE> [OPTIONS]

Argumentit¶

PROJECT_NAME: Kohdeprojektin nimi, johon tuodaan (pakollinen).
EXPORT_FILE: Polku JSON-vientitiedostoon (pakollinen).

Valitsimet¶

--output-file, -o: Tiedosto, johon tuontiraportti kirjoitetaan. Ilman sitä raportti menee stdout-virtaan.
--output-format, -f: Tuontiraportin muoto — table, json tai csv (oletus: table).

Esimerkki¶

digna project import-ds ProjectB my_export.json

Koneluettavan raportin tallentaminen:

digna project import-ds ProjectB my_export.json --output-format json --output-file import_report.json

Raportti kattaa neljä objektitasoa — tietolähde, tietojoukon määrittely, attribuutti ja validointisääntö — kunkin osalta tuontitoimenpiteen, tuloksen, syntyneen objektin tunnisteen ja mahdolliset lisätiedot.

project plan-import-ds¶

Komento project plan-import-ds esikatselee tietolähteiden tuontia kohdeprojektiin näyttäen, mitkä objektit luotaisiin, päivitettäisiin tai ohitettaisiin, muuttamatta mitään. Se ottaa saman vientitiedoston ja samat raportointivalitsimet kuin project import-ds ja lisää askelnumeron kutakin suunniteltua objektia kohti.

Komennon käyttö¶

digna project plan-import-ds <PROJECT_NAME> <EXPORT_FILE> [OPTIONS]

Argumentit¶

PROJECT_NAME: Kohdeprojektin nimi (pakollinen).
EXPORT_FILE: Polku vientitiedostoon (pakollinen).

Valitsimet¶

--output-file, -o: Tiedosto, johon tuontisuunnitelma kirjoitetaan. Ilman sitä suunnitelma menee stdout-virtaan.
--output-format, -f: Tuontisuunnitelman muoto — table, json tai csv (oletus: table).

Esimerkki¶

digna project plan-import-ds ProjectB my_export.json

project cleanup¶

Komento project cleanup poistaa tarkastustulokset, jotka projektiin on kertynyt tietyltä päivämääräväliltä — profiilit, ennusteet, rivimäärät sekä jokaisen tarkistuksen, attribuutin, tietojoukon ja tietolähteen tilan. Se poistaa täsmälleen sen, minkä näiden päivämäärien tarkastus kirjoitti, joten välin voi tarkastaa jälkikäteen uudelleen tulosten muodostamiseksi.

Timeliness- ja Schema Tracker -historiaa ei poisteta: ne kirjaavat, mitä digna havaitsi tiettynä päivänä, eivätkä ole siitä johdettuja tuloksia, joten menneen päivämäärävälin siivous jättää ne ennalleen.

Jokainen tietolähde siivotaan omassa transaktiossaan, joten keskeytynyt ajo jättää tietolähteet joko kokonaan siivotuiksi tai koskemattomiksi, ei puoliksi siivotuiksi.

Komennon käyttö¶

digna project cleanup <PROJECT_NAME> <FROM_DATE> <TO_DATE> [OPTIONS]

Argumentit¶

PROJECT_NAME: Siivottava projekti (pakollinen). Yksi projekti kutsua kohden.
FROM_DATE: Ensimmäinen päivä, jonka tulokset poistetaan, YYYY-MM-DD (pakollinen).
TO_DATE: Viimeinen päivä, jonka tulokset poistetaan (mukaan lukien), YYYY-MM-DD (pakollinen).

Valitsimet¶

--table-name, -n: Rajaa siivouksen näihin tietolähteisiin. Useita nimiä voi antaa välilyönnein eroteltuina.
--table-filter: Rajaa siivouksen tietolähteisiin, joiden nimi sisältää tämän merkkijonon.
--dry-run: Luettelee tietolähteet, jotka siivottaisiin, poistamatta mitään.
--timing: Näyttää, kauanko siivous kesti.

--table-name ja --table-filter yhdistyvät TAI-ehtona — tietolähde siivotaan, jos se on nimetty tai jos merkkijono täsmää. Komento epäonnistuu, jos mikään tietolähde ei täsmää, sen sijaan että se ilmoittaisi onnistuneesta siivouksesta, joka ei tehnyt mitään.

Esimerkki¶

digna project cleanup ProjectA 2026-01-01 2026-06-30

Rajattuna yhteen tietolähteeseen:

digna project cleanup ProjectA 2026-01-01 2026-06-30 --table-name Table1

Esimerkkituloste¶

Cleaning up project 'ProjectA' from 2026-01-01 to 2026-06-30:
- Table1
- Table2
- Table3

✅ Cleaned up 3 data source(s).

Siivottavien tietolähteiden näkeminen poistamatta mitään:

digna project cleanup ProjectA 2026-01-01 2026-06-30 --dry-run

Jokainen rivi on merkitty, joten koeajoa ei voi sekoittaa oikeaan ajoon:

Cleaning up project 'ProjectA' from 2026-01-01 to 2026-06-30:
- Table1 (dry run, nothing removed)
- Table2 (dry run, nothing removed)
- Table3 (dry run, nothing removed)

Dry run - 3 data source(s) would be cleaned up.

Tarkastusten hallinta¶

inspection run¶

Komento inspection run luo tarkastuspyynnön projektille ja päivämääräväliä varten ja — annettujen valitsimien mukaan — joko odottaa sitä, palaa välittömästi tai suorittaa sen omassa prosessissaan.

Kolme suoritustilaa ovat:

Oletus (ei lippua): pyyntö asetetaan taustajärjestelmän jonoon, ja CLI kysyy sen tilaa kahden sekunnin välein tulostaen tehtävien edistymisen, kunnes tarkastus saavuttaa lopputilan. Käynnissä oleva digna serve vaaditaan, muuten kukaan ei poimi pyyntöä.
--async-mode: pyyntö asetetaan jonoon ja sen tunniste tulostetaan välittömästi. Seuraa sitä komennolla inspection status.
--bypass-backend: tarkastuksen suorittaa CLI-prosessi itse eikä sitä aseteta jonoon, joten käynnissä olevaa palvelinta ei tarvita.

--async-mode ja --bypass-backend sulkevat toisensa pois.

Kaikissa tiloissa komento päättyy nollasta poikkeavaan paluukoodiin, jos tarkastus ei valmistunut onnistuneesti.

Komennon käyttö¶

digna inspection run <PROJECT_NAME> <START_DATE> <END_DATE> [OPTIONS]

Argumentit¶

PROJECT_NAME: Kohdeprojektin nimi (pakollinen). Nimen on täsmättävä täsmälleen.
START_DATE: Päivämäärävälin alkupäivä muodossa YYYY-MM-DD (pakollinen).
END_DATE: Päivämäärävälin loppupäivä muodossa YYYY-MM-DD (pakollinen).

Valitsimet¶

--table-name: Rajaa tarkastuksen projektin yhteen tietolähteeseen, joka annetaan tietolähteen nimellä. Ilman sitä tarkastetaan kaikki projektin tietolähteet.
--async-mode: Asettaa tarkastuksen jonoon ja tulostaa pyynnön tunnisteen sen sijaan, että odottaisi sitä. Ei voi yhdistää valitsimeen --bypass-backend.
--bypass-backend: Suorittaa tarkastuksen suoraan CLI-prosessissa sen sijaan, että asettaisi sen taustajärjestelmän jonoon. Ei voi yhdistää valitsimeen --async-mode.

Esimerkki¶

digna inspection run ProjectA 2024-01-01 2024-01-31

Asynkronisen tarkastuksen lähettäminen:

digna inspection run ProjectA 2024-01-01 2024-01-31 --async-mode

Yhden tietolähteen tarkastaminen:

digna inspection run ProjectA 2024-01-01 2024-01-31 --table-name orders

Esimerkkituloste¶

Oletustila:

Inspection request submitted. Waiting for completion (Request ID: 1024)...
Progress: 3/10 tasks completed (0 failed)
Progress: 10/10 tasks completed (0 failed)
Inspection completed successfully.
Inspection successful for project: ProjectA

Asynkroninen tila:

Inspection request submitted successfully. Request ID: 1024

inspection status¶

Komento inspection status kysyy tarkastuspyynnön tilaa ja tehtävien edistymistä pyynnön tunnisteen perusteella.

Komennon käyttö¶

digna inspection status <INSPECTION_REQUEST_ID>

Argumentit¶

INSPECTION_REQUEST_ID: Tarkastuspyynnön numeerinen tunniste (pakollinen).

Esimerkki¶

digna inspection status 1024

Esimerkkituloste¶

Inspection Request ID: 1024
Status: Running
Project ID: 7
Date Range: 2024-01-01 to 2024-01-31
Progress: 3/10 tasks completed (0 failed)

inspection abort¶

Komento inspection abort pyytää käynnissä olevien tai odottavien tarkastuspyyntöjen peruuttamista. Se kirjaa pysäytystapahtuman jokaiselle kyseessä olevalle pyynnölle; taustajärjestelmä toimii sen perusteella, joten keskeytys on pysäytyspyyntö eikä välitön lopetus.

Komennon käyttö¶

digna inspection abort [INSPECTION_REQUEST_ID] [OPTIONS]

Argumentit¶

INSPECTION_REQUEST_ID: Keskeytettävän tarkastuspyynnön tunniste. Pakollinen, ellei valitsinta --killall anneta.

Valitsimet¶

--killall: Keskeyttää kaikki parhaillaan käynnissä olevat ja odottavat tarkastuspyynnöt. Ohittaa samalla annetun pyyntötunnisteen.

Esimerkki¶

Tietyn pyynnön keskeyttäminen:

digna inspection abort 1024

Kaikkien aktiivisten ja jonossa olevien tarkastusten keskeyttäminen:

digna inspection abort --killall

Esimerkkituloste¶

--killall raportoi, mitä se teki; yksittäisen pyynnön keskeyttäminen ei tuota tulostetta ja ilmoittaa onnistumisesta paluukoodillaan.

All running and pending inspections have been aborted.

Lisenssien hallinta¶

license check¶

Komento license check vahvistaa license.toml-tiedoston tarkistamalla sen allekirjoituksen asennuksen mukana toimitettua julkista avainta vasten ja varmistamalla, ettei se ole vanhentunut. Se ei lue sovelluksen asetuksia, joten se toimii myös ennen kuin config.toml on määritetty.

Komennon käyttö¶

digna license check

Esimerkkituloste¶

License is valid

Virheellisestä allekirjoituksesta ja vanhentuneesta lisenssistä raportoidaan erillisinä virheinä, molemmista paluukoodilla 1.

Palvelin- ja taustapalvelut¶

serve¶

Komento serve käynnistää digna-REST-API-palvelimen sekä taustalla toimivan tarkastusten ajastimen ja tarkastusten hallinnan. Käynnistyessään se myös merkitsee epäonnistuneeksi jokaisen tarkastuksen, jonka tietovarasto edelleen kirjaa käynnissä olevaksi, koska mikään ei ole voinut säilyä aiemmasta prosessista.

Komento toimii edustalla, kunnes se pysäytetään.

Komennon käyttö¶

digna serve [OPTIONS]

Valitsimet¶

--address: Verkko-osoite, johon API-palvelin sidotaan (oletus: 127.0.0.1).
--port: Portin numero, jota kuunnellaan (oletus: 8000).

Esimerkki¶

digna serve --address 0.0.0.0 --port 8000

Esimerkkituloste¶

Server running on http://0.0.0.0:8000

Windows-palvelun hallinta¶

Käytettävissä vain Windowsissa. Komennot rekisteröivät digna-taustajärjestelmän Windowsin palvelunhallintaan ja ohjaavat sitä; itse palvelu suorittaa komentoa serve taustalla. Jokainen komento on suoritettava järjestelmänvalvojan oikeuksin avatusta komentokehotteesta, ja jokainen hyväksyy valitsimen --name, jotta muulla kuin oletusnimellä rekisteröityyn palveluun voidaan viitata.

windows install¶

Komento windows install rekisteröi digna-järjestelmän Windows-palveluksi.

Tässä annetut osoite ja portti tallennetaan palvelun rekisteröintiin, ja palvelu sitoutuu niihin — niitä ei lueta tiedostosta config.toml. Jos haluat muuttaa niitä myöhemmin, poista palvelun asennus ja asenna se uudelleen.

Komennon käyttö¶

digna windows install [OPTIONS]

Valitsimet¶

--name: Nimi, jolla palvelu rekisteröidään (oletus: digna).
--display-name: services.msc-näkymässä näytettävä nimi (oletus: digna).
--description: services.msc-näkymässä näytettävä kuvaus (oletus: digna data quality backend).
--address: Osoite, johon palvelu sitoo API:nsa (oletus: 127.0.0.1).
--port: Portti, johon palvelu sitoo API:nsa (oletus: 8000).
--working-dir: Hakemisto, jossa config.toml ja license.toml sijaitsevat ja jonka palvelu asettaa työhakemistokseen (oletus: digna-suoritustiedoston hakemisto).
--start-type: Milloin palvelu käynnistyy — auto Windowsin mukana, manual vain pyydettäessä, disabled rekisteröity mutta kieltäytyy käynnistymästä (oletus: auto).
--account: Tili, jolla palvelu suoritetaan, esim. DOMAIN\user tai .\user (oletus: LocalSystem).
--password: Tilin --account salasana.

Esimerkki¶

digna windows install --address 0.0.0.0 --port 8082

Rekisteröinti toisella nimellä toimialuetilillä suoritettuna:

digna windows install --name digna-test --display-name "digna (test)" --account DOMAIN\svc_digna --password <password>

windows start¶

Komento windows start käynnistää rekisteröidyn palvelun.

Komennon käyttö¶

digna windows start [OPTIONS]

Valitsimet¶

--name: Nimi, jolla palvelu on rekisteröity (oletus: digna).

windows stop¶

Komento windows stop pysäyttää käynnissä olevan palvelun. Pysäytä palvelu ennen kuin korvaat yhtään sovellustiedostoa.

Komennon käyttö¶

digna windows stop [OPTIONS]

Valitsimet¶

--name: Nimi, jolla palvelu on rekisteröity (oletus: digna).

windows uninstall¶

Komento windows uninstall poistaa palvelun rekisteröinnin. Pysäytä se ensin.

Komennon käyttö¶

digna windows uninstall [OPTIONS]

Valitsimet¶

--name: Nimi, jolla palvelu on rekisteröity (oletus: digna).