digna CLI žinynas 2026.06¶

2026-09-05

Šiame puslapyje aprašomas visas komandų rinkinys, prieinamas digna CLI 2026.06 laidoje, kartu su naudojimo pavyzdžiais ir parinktimis.

Vykdomasis failas vadinasi digna.

CLI pagrindai¶

Apžvalga ir sintaksė¶

2026.06 laidos CLI naudoja struktūrizuotą, kategorijomis pagrįstą komandų hierarchiją:

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

version ir serve yra pavienės komandos be subkomandos:

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

Bendrosios parinktys¶

Toliau nurodytos bendrosios parinktys taikomos visoms komandoms:

--help, -h: Parodo žinyno informaciją apie CLI arba apie konkrečią komandų kategoriją ar subkomandą.
--stacktrace: Įvykus klaidai parodo visą klaidų grandinę, o ne vien aukščiausio lygio pranešimą.

--stacktrace yra bendroji parinktis griežtąja prasme: ją reikia nurodyti prieš komandų kategoriją, o ne po jos.

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

Vėliavėlės --version nėra. Vietoj jos naudokite komandą version.

Būtinos sąlygos¶

Daugumai komandų reikia perskaitomo, galiojančio config.toml failo; kai kurioms papildomai reikia galiojančios licencijos. Toliau pateiktoje lentelėje užfiksuota, ką kiekviena komandų kategorija įkelia prieš imdamasi bet kokio veiksmo:

Komandų kategorija	Reikia `config.toml`	Reikia galiojančios licencijos
`version`	ne	ne
`config check`	ne (kaip tik apie tai komanda ir praneša)	ne
`license check`	ne	tai ir yra patikrinimas
`crypt`	taip	ne
`serve`	taip	ne
`windows`	ne (tarnyba jį nuskaito paleidimo metu)	ne
`project`	taip	ne
`user`	taip	taip
`inspection`	taip	taip
`repo`	taip	taip

Kai reikia licencijos, tikrinamas ir jos parašas, ir galiojimo pabaigos data, o komanda nutraukiama dar prieš paliečiant saugyklą, jei bent vienas patikrinimas nepavyksta.

Išėjimo kodai¶

0: komanda pavyko.
1: komanda nepavyko. Klaidos pranešimas rašomas į stderr su priešdėliu Error:.

help¶

Parinktis --help teikia informaciją apie galimas komandų kategorijas, subkomandas ir parinktis:

Bendrojo žinyno rodymas:
```
digna --help
```
Žinyno gavimas apie konkrečias kategorijas ir komandas:
```
digna user --help
digna user add --help
```

Išvestyje pateikiama: - Komandos aprašas: Komandos paskirties santrauka. - Sintaksė: Privalomi ir neprivalomi argumentai. - Parinktys: Komandai būdingos vėliavėlės ir parametrai.

version¶

Komanda version išveda įdiegtą digna laidą. Ji neskaito jokios konfigūracijos ir netikrina licencijos, todėl veikia ir tokioje diegtyje, kurios config.toml ar licencija trūksta arba yra negaliojanti.

Laidos versija nepriklauso nuo saugyklos schemos versijos, apie kurią praneša repo check.

Komandos naudojimas¶

digna version

Išvesties pavyzdys¶

2026.06

Konfigūracijos valdymas¶

config check¶

Komanda config check patikrina konfigūracijos failą (config.toml) ir įsitikina, kad visi privalomi skyriai bei nuostatos yra ir tinkamai suformatuoti. Kiekvienas skyrius tikrinamas atskirai, todėl sugadintas skyrius [app] neužgožia skyriaus [repo] būsenos.

Pateikiami šie skyriai:

App config ([app])
Repository config ([repo])
Base config ([base])
Logging config ([logging])
Encryption config ([encryption])
OIDC config(s) (oidc_clients) — neprivaloma; trūkstamas raktas patikrinimą praeina, o esantis, bet netaisyklingas sąrašas – ne

Komanda sąmoningai neįkelia programos konfigūracijos taip, kaip tai daro kitos komandos, kad galėtų diagnozuoti config.toml, dėl kurio digna apskritai nepasileistų.

Komandos naudojimas¶

digna config check [OPTIONS]

Parinktys¶

--configpath, -c: Kelias iki konfigūracijos failo arba iki katalogo, kuriame yra config.toml (numatytoji reikšmė ./config.toml).
--json: Išveda patikrinimo ataskaitą JSON formatu. Turi pirmenybę prieš --quiet.
--quiet, -q: Slepia ataskaitą ir remiasi vien išėjimo kodu.

Pavyzdys¶

digna config check

Patikrinti konkretų konfigūracijos failą ir išvestį pateikti JSON formatu:

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

Išvesties pavyzdys¶

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

Trūkstamas failas arba TOML sintaksės klaida nepalieka nieko, ką būtų galima tikrinti skyrius po skyriaus, todėl apie tai pranešama kaip apie vieną klaidą, o ne ataskaitą, nepriklausomai nuo --quiet ar --json.

Saugyklos valdymas¶

repo check¶

Komanda repo check patikrina duomenų bazės ryšį bei saugyklos įdiegimą ir versiją. Ji nepavyksta, jei sukonfigūruotos schemos nėra arba jei ji yra, bet joje nėra digna saugyklos.

Pateikiama versija yra saugyklos schemos versija, kurios numeracija tvarkoma atskirai nuo digna laidos, kurią išveda version.

Komandos naudojimas¶

digna repo check

Išvesties pavyzdys¶

Repo version 3.0.0 installed

repo install¶

Komanda repo install įdiegia naują digna saugyklą į config.toml faile sukonfigūruotą schemą, sukurdama visas reikiamas sekas, lenteles, indeksus, apribojimus ir pradinius įrašus.

Pačios schemos ši komanda nesukuria — ji turi egzistuoti iš anksto. Komanda taip pat atsisako veikti, jei toje schemoje saugykla jau įdiegta, ir nurodo repo upgrade, jei įdiegta versija yra senesnė.

Komandos naudojimas¶

digna repo install

Išvesties pavyzdys¶

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¶

Komanda repo upgrade pritaiko duomenų bazės schemos migracijas, kad esama saugykla būtų pakelta iki versijos, kurios tikisi įdiegta laida. Naujinimai taikomi po vieną versijos žingsnį nustatytu naujinimo keliu, o kiekvienas užbaigtas žingsnis įrašomas saugykloje.

Jei saugykla jau yra laukiamos versijos, komanda praneša, kad naujinti nereikia, ir jokių pakeitimų neatlieka.

Komandos naudojimas¶

digna repo upgrade

Išvesties pavyzdys¶

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¶

Komanda repo prune pašalina eilutes, kurios liko po to, kai buvo ištrintas projektas ar duomenų šaltinis, kuriam jos priklausė. Ištrynus projektą ar duomenų šaltinį, pašalinamas pats objektas, tačiau jo profiliai, prognozės, būsenos ir eilučių skaičiai lieka — tai sąmoningas kompromisas, nes trynimas, kartu valantis ir šias lenteles, priverstų naudotoją ilgai laukti. repo prune yra tvarkymo veiksmas, kuris jas išvalo, ir jį saugu vykdyti bet kuriuo metu: jis šalina tik tas eilutes, kurių projektas ar duomenų šaltinis nebeegzistuoja.

Eilutės, kurias Python backend įrašė į lenteles, nebenaudojamas dabartinėje laidoje, nepaliečiamos.

Komandos naudojimas¶

digna repo prune [OPTIONS]

Parinktys¶

--dry-run: Parodo, kas būtų pašalinta, nieko nepašalinant.

Išvardijamos tik lentelės, kuriose yra našlaičių eilučių. Jei tokių nėra, komanda praneša No orphaned rows found. ir baigia darbą.

Pavyzdys¶

digna repo prune

Išvesties pavyzdys¶

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

✅ Removed 117854 orphaned row(s).

Norint pamatyti tą pačią ataskaitą nieko nepašalinant:

digna repo prune --dry-run

Eilučių skaičiai identiški; skiriasi tik paskutinė eilutė:

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

Dry run - nothing was removed.

Šifravimo valdymas¶

crypt gen-key¶

Komanda crypt gen-key sugeneruoja naują AES-GCM šifravimo raktą, skirtą naudoti kaip šifravimo raktą faile config.toml. Įkeliamas config.toml jau turi būti, nors sugeneruotas raktas nuo jo ir nepriklauso.

Komandos naudojimas¶

digna crypt gen-key

Išvesties pavyzdys¶

Encryption key: <base64-encoded key>

crypt encrypt¶

Komanda crypt encrypt užšifruoja eilutę (pavyzdžiui, duomenų bazės slaptažodį) naudodama faile config.toml sukonfigūruotą AES-GCM raktą ir išveda šifruotą tekstą.

Komandos naudojimas¶

digna crypt encrypt <VALUE>

Argumentai¶

VALUE: Šifruotina atvirojo teksto eilutė (privaloma).

Pavyzdys¶

digna crypt encrypt mysecretpassword

crypt decrypt¶

Komanda crypt decrypt iššifruoja AES-GCM užšifruotą eilutę naudodama faile config.toml sukonfigūruotą raktą ir išveda atvirąjį tekstą.

Komandos naudojimas¶

digna crypt decrypt <VALUE>

Argumentai¶

VALUE: Iššifruotina šifruoto teksto eilutė (privaloma).

Pavyzdys¶

digna crypt decrypt "encrypted_string_here"

Naudotojų valdymas¶

user add¶

Komanda user add sukuria naują naudotojo paskyrą digna saugykloje. Komanda nepavyksta, jei naudotojas nurodytu el. pašto adresu jau yra.

Komandos naudojimas¶

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

Argumentai¶

EMAIL: Naudotojo el. pašto adresas (privaloma).
PASSWORD: Pradinis naudotojo slaptažodis (privaloma).
DISPLAY_NAME: Visas rodomas naudotojo vardas (privaloma).

Parinktys¶

--admin, -a: Sukuria naudotoją su administratoriaus (supernaudotojo) teisėmis.

Pavyzdys¶

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

Norint sukurti administratoriaus paskyrą:

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

Išvesties pavyzdys¶

User created with ID: 42

user list¶

Komanda user list lentelės pavidalu išvardija visus registruotus naudotojus su ID, el. paštu, rodomu vardu ir administratoriaus žyme.

Komandos naudojimas¶

digna user list

Išvesties pavyzdys¶

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

user modify¶

Komanda user modify atnaujina esamos naudotojo paskyros, atpažįstamos pagal el. pašto adresą, rodomą vardą ir administratoriaus teises.

Ir rodomas vardas, ir administratoriaus žymė visada įrašomi. --admin yra jungiklis, o ne reikšmė: jos praleidimas atšaukia administratoriaus teises, todėl nurodykite ją visada, kai naudotojas turi jas išlaikyti arba gauti.

Komandos naudojimas¶

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

Argumentai¶

EMAIL: Keistino naudotojo el. paštas (privaloma).
DISPLAY_NAME: Atnaujintas rodomas vardas (privaloma).

Parinktys¶

--admin, -a: Suteikia administratoriaus teises. Praleiskite, kad jas atšauktumėte.
--valid-until, -v: Priimama dėl suderinamumo, tačiau šiuo metu netaikoma. Ją nurodžius išvedamas įspėjimas ir niekas nepakeičiama.

Pavyzdys¶

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

Išvesties pavyzdys¶

User jdoe@example.com modified successfully

user modify-pwd¶

Komanda user modify-pwd atnaujina esamos naudotojo paskyros slaptažodį.

Komandos naudojimas¶

digna user modify-pwd <EMAIL> <PASSWORD>

Argumentai¶

EMAIL: Naudotojo, kurio slaptažodis atnaujinamas, el. paštas (privaloma).
PASSWORD: Naujas slaptažodis (privaloma).

Pavyzdys¶

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

user delete¶

Komanda user delete pašalina naudotojo paskyrą iš sistemos.

Komandos naudojimas¶

digna user delete <EMAIL>

Argumentai¶

EMAIL: Šalintino naudotojo el. paštas (privaloma).

Pavyzdys¶

digna user delete jdoe@example.com

Projektų ir duomenų šaltinių valdymas¶

project list¶

Komanda project list išvardija visus saugykloje esančius projektus, parodydama jų ID, pavadinimą ir aprašą.

Komandos naudojimas¶

digna project list

Išvesties pavyzdys¶

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

project list-ds¶

Komanda project list-ds išvardija visus su nurodytu projektu susietus duomenų šaltinius, parodydama jų ID, pavadinimą, rūšį, schemą ir lentelės pavadinimą.

Komandos naudojimas¶

digna project list-ds <PROJECT_NAME>

Argumentai¶

PROJECT_NAME: Projekto, kurio duomenų šaltinius reikia išvardyti, pavadinimas (privaloma). Pavadinimas turi sutapti tiksliai.

Pavyzdys¶

digna project list-ds ProjectA

Išvesties pavyzdys¶

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

project export-ds¶

Komanda project export-ds eksportuoja projekto duomenų šaltinius į JSON dokumentą.

Jei nenurodoma nei --table-name, nei --table-id, eksportuojami visi projekto duomenų šaltiniai.

Komandos naudojimas¶

digna project export-ds <PROJECT_NAME> [OPTIONS]

Argumentai¶

PROJECT_NAME: Projekto, iš kurio eksportuojami duomenų šaltiniai, pavadinimas (privaloma).

Parinktys¶

--table-name, -n: Eksportuotinų duomenų šaltinių pavadinimai. Kelis pavadinimus galima nurodyti atskiriant tarpais.
--table-id, -i: Eksportuotinų duomenų šaltinių ID. Kelis ID galima nurodyti atskiriant tarpais.
--exportfile, -f: Kelias, kuriuo įrašomi eksportuoti duomenų šaltiniai (numatytoji reikšmė: data_sources_export.json).

Pavyzdys¶

Norint eksportuoti visus duomenų šaltinius iš ProjectA:

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

Norint eksportuoti konkrečias lenteles:

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

Išvesties pavyzdys¶

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

project import-ds¶

Komanda project import-ds importuoja duomenų šaltinius iš eksporto failo į paskirties projektą ir kiekvieno objekto atžvilgiu praneša, kas buvo sukurta, atnaujinta ar praleista.

Komandos naudojimas¶

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

Argumentai¶

PROJECT_NAME: Paskirties projekto, į kurį importuojama, pavadinimas (privaloma).
EXPORT_FILE: Kelias iki JSON eksporto failo (privaloma).

Parinktys¶

--output-file, -o: Failas, į kurį rašoma importo ataskaita. Be jo ataskaita siunčiama į stdout.
--output-format, -f: Importo ataskaitos formatas — table, json arba csv (numatytoji reikšmė: table).

Pavyzdys¶

digna project import-ds ProjectB my_export.json

Norint gauti kompiuterio skaitomą ataskaitą:

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

Ataskaita apima keturis objektų lygmenis — duomenų šaltinį, duomenų rinkinio apibrėžtį, atributą ir tikrinimo taisyklę — kiekvieną su jo importo veiksmu, rezultatu, gauto objekto ID ir papildoma informacija.

project plan-import-ds¶

Komanda project plan-import-ds parodo duomenų šaltinių importo į paskirties projektą peržiūrą – kurie objektai būtų sukurti, atnaujinti ar praleisti – nieko nekeisdama. Ji priima tą patį eksporto failą ir tas pačias ataskaitos parinktis kaip project import-ds ir prie kiekvieno suplanuoto objekto prideda žingsnio numerį.

Komandos naudojimas¶

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

Argumentai¶

PROJECT_NAME: Paskirties projekto pavadinimas (privaloma).
EXPORT_FILE: Kelias iki eksporto failo (privaloma).

Parinktys¶

--output-file, -o: Failas, į kurį rašomas importo planas. Be jo planas siunčiamas į stdout.
--output-format, -f: Importo plano formatas — table, json arba csv (numatytoji reikšmė: table).

Pavyzdys¶

digna project plan-import-ds ProjectB my_export.json

project cleanup¶

Komanda project cleanup pašalina patikrų rezultatus, kuriuos projektas sukaupė per nurodytą datų intervalą — profilius, prognozes, eilučių skaičius ir visas patikrinimų, atributų, duomenų rinkinių ir duomenų šaltinių būsenas. Ji pašalina būtent tai, ką įrašė tų datų patikra, todėl vėliau intervalą galima patikrinti iš naujo ir rezultatus atkurti.

Timeliness ir Schema Tracker istorija nešalinama: joje fiksuojama, ką digna stebėjo tam tikrą dieną, o ne iš to išvestas rezultatas, todėl praeities datų intervalo išvalymas jos nepaliečia.

Kiekvienas duomenų šaltinis valomas atskiroje transakcijoje, todėl nutrauktas vykdymas palieka nepaliestus arba visiškai išvalytus duomenų šaltinius, o ne iš dalies išvalytą.

Komandos naudojimas¶

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

Argumentai¶

PROJECT_NAME: Valomas projektas (privaloma). Vienu iškvietimu – vienas projektas.
FROM_DATE: Pirmoji data, kurios rezultatai šalinami, YYYY-MM-DD (privaloma).
TO_DATE: Paskutinė data, kurios rezultatai šalinami, imtinai, YYYY-MM-DD (privaloma).

Parinktys¶

--table-name, -n: Apriboja valymą šiais duomenų šaltiniais. Kelis pavadinimus galima nurodyti atskiriant tarpais.
--table-filter: Apriboja valymą duomenų šaltiniais, kurių pavadinime yra ši poeilutė.
--dry-run: Išvardija duomenų šaltinius, kurie būtų išvalyti, nieko nepašalinant.
--timing: Parodo, kiek laiko užtruko valymas.

--table-name ir --table-filter jungiami kaip OR — duomenų šaltinis išvalomas, jei jis nurodytas pavadinimu arba jei atitinka poeilutė. Jei neatitinka nė vienas duomenų šaltinis, komanda baigiasi klaida, o ne praneša apie sėkmę valymo, kuris nieko nepadarė.

Pavyzdys¶

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

Apribojus vienu duomenų šaltiniu:

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

Išvesties pavyzdys¶

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

✅ Cleaned up 3 data source(s).

Norint pamatyti, kurie duomenų šaltiniai būtų išvalyti, nieko nepašalinant:

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

Kiekviena eilutė pažymėta, todėl bandomojo vykdymo neįmanoma supainioti su tikru:

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.

Patikrų valdymas¶

inspection run¶

Komanda inspection run sukuria patikros užklausą projektui ir datų intervalui, o paskui – priklausomai nuo nurodytų parinkčių – arba jos laukia, arba iškart grąžina valdymą, arba vykdo ją savo pačios procese.

Trys vykdymo režimai yra šie:

Numatytasis (be vėliavėlės): užklausa įtraukiama į vidinės posistemės eilę, o CLI kas dvi sekundes tikrina jos būseną ir išveda užduočių eigą, kol patikra pasiekia galutinę būseną. Būtinas veikiantis digna serve, kitaip užklausos niekas nepaims.
--async-mode: užklausa įtraukiama į eilę, o jos ID išvedamas iškart. Sekimui naudokite inspection status.
--bypass-backend: patikrą vykdo pats CLI procesas ir ji į eilę neįtraukiama, todėl veikiančio serverio nereikia.

--async-mode ir --bypass-backend viena kitą paneigia.

Visais režimais komanda baigiasi ne nuliniu išėjimo kodu, jei patikra nebuvo sėkmingai užbaigta.

Komandos naudojimas¶

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

Argumentai¶

PROJECT_NAME: Paskirties projekto pavadinimas (privaloma). Pavadinimas turi sutapti tiksliai.
START_DATE: Datų intervalo pradžios data YYYY-MM-DD formatu (privaloma).
END_DATE: Datų intervalo pabaigos data YYYY-MM-DD formatu (privaloma).

Parinktys¶

--table-name: Apriboja patikrą vienu projekto duomenų šaltiniu, nurodomu pagal duomenų šaltinio pavadinimą. Be jos tikrinami visi projekto duomenų šaltiniai.
--async-mode: Įtraukia patikrą į eilę ir išveda užklausos ID, užuot jos laukusi. Negalima derinti su --bypass-backend.
--bypass-backend: Vykdo patikrą tiesiogiai CLI procese, užuot įtraukusi ją į vidinės posistemės eilę. Negalima derinti su --async-mode.

Pavyzdys¶

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

Norint pateikti asinchroninę patikrą:

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

Norint patikrinti vieną duomenų šaltinį:

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

Išvesties pavyzdys¶

Numatytasis režimas:

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

Asinchroninis režimas:

Inspection request submitted successfully. Request ID: 1024

inspection status¶

Komanda inspection status pagal užklausos ID pateikia patikros užklausos būseną ir užduočių eigą.

Komandos naudojimas¶

digna inspection status <INSPECTION_REQUEST_ID>

Argumentai¶

INSPECTION_REQUEST_ID: Skaitinis patikros užklausos ID (privaloma).

Pavyzdys¶

digna inspection status 1024

Išvesties pavyzdys¶

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¶

Komanda inspection abort prašo atšaukti vykdomas arba laukiančias patikros užklausas. Kiekvienai paveiktai užklausai ji įrašo stabdymo įvykį; pagal jį veikia vidinė posistemė, todėl nutraukimas yra prašymas sustoti, o ne momentinis nužudymas.

Komandos naudojimas¶

digna inspection abort [INSPECTION_REQUEST_ID] [OPTIONS]

Argumentai¶

INSPECTION_REQUEST_ID: Nutrauktinos patikros užklausos ID. Privaloma, nebent nurodyta --killall.

Parinktys¶

--killall: Nutraukia visas šiuo metu vykdomas ir laukiančias patikros užklausas. Turi pirmenybę prieš kartu nurodytą užklausos ID.

Pavyzdys¶

Norint nutraukti konkrečią užklausą:

digna inspection abort 1024

Norint nutraukti visas aktyvias ir eilėje esančias patikras:

digna inspection abort --killall

Išvesties pavyzdys¶

--killall praneša, ką atliko; vienos užklausos nutraukimas išvesties nepateikia, o apie sėkmę praneša savo išėjimo kodu.

All running and pending inspections have been aborted.

Licencijų valdymas¶

license check¶

Komanda license check patikrina failą license.toml: sutikrina jo parašą su kartu su diegtimi pateiktu viešuoju raktu ir įsitikina, kad licencija nepasibaigusi. Ji neskaito jokios programos konfigūracijos, todėl veikia dar prieš sukonfigūruojant config.toml.

Komandos naudojimas¶

digna license check

Išvesties pavyzdys¶

License is valid

Apie negaliojantį parašą ir pasibaigusią licenciją pranešama kaip apie skirtingas klaidas, abiem atvejais su išėjimo kodu 1.

Serverio ir foninės tarnybos¶

serve¶

Komanda serve paleidžia digna REST API serverį kartu su fonine patikrų planuokle ir patikrų tvarkykle. Paleidimo metu ji taip pat pažymi kaip nepavykusias visas patikras, kurias saugykla vis dar laiko vykdomomis, nes iš ankstesnio proceso niekas negalėjo išlikti.

Komanda veikia priekiniame plane, kol nesustabdoma.

Komandos naudojimas¶

digna serve [OPTIONS]

Parinktys¶

--address: Tinklo adresas, prie kurio susiejamas API serveris (numatytoji reikšmė: 127.0.0.1).
--port: Prievado numeris, kurio klausomasi (numatytoji reikšmė: 8000).

Pavyzdys¶

digna serve --address 0.0.0.0 --port 8000

Išvesties pavyzdys¶

Server running on http://0.0.0.0:8000

Windows tarnybos valdymas¶

Prieinama tik Windows sistemoje. Šios komandos užregistruoja digna backend Windows tarnybų tvarkytuvėje ir jį valdo; pati tarnyba fone vykdo serve. Kiekvieną komandą reikia vykdyti iš komandų eilutės su administratoriaus teisėmis, ir kiekviena priima --name, kad būtų galima kreiptis į tarnybą, užregistruotą ne numatytuoju pavadinimu.

windows install¶

Komanda windows install užregistruoja digna kaip Windows tarnybą.

Čia nurodyti adresas ir prievadas įrašomi į tarnybos registraciją ir prie jų tarnyba susiejama — jie neskaitomi iš config.toml. Norėdami juos vėliau pakeisti, pašalinkite tarnybą ir įdiekite ją iš naujo.

Komandos naudojimas¶

digna windows install [OPTIONS]

Parinktys¶

--name: Pavadinimas, kuriuo registruojama tarnyba (numatytoji reikšmė: digna).
--display-name: Pavadinimas, rodomas services.msc (numatytoji reikšmė: digna).
--description: Aprašas, rodomas services.msc (numatytoji reikšmė: digna data quality backend).
--address: Adresas, prie kurio tarnyba susieja savo API (numatytoji reikšmė: 127.0.0.1).
--port: Prievadas, prie kurio tarnyba susieja savo API (numatytoji reikšmė: 8000).
--working-dir: Katalogas su config.toml ir license.toml, kurį tarnyba naudoja kaip darbinį katalogą (numatytoji reikšmė: digna vykdomojo failo katalogas).
--start-type: Kada tarnyba paleidžiama — auto kartu su Windows, manual tik paprašius, disabled užregistruota, bet atsisako pasileisti (numatytoji reikšmė: auto).
--account: Paskyra, kuria vykdoma tarnyba, pvz., DOMAIN\user arba .\user (numatytoji reikšmė: LocalSystem).
--password: --account paskyros slaptažodis.

Pavyzdys¶

digna windows install --address 0.0.0.0 --port 8082

Registravimas antru pavadinimu, vykdant domeno paskyra:

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

windows start¶

Komanda windows start paleidžia užregistruotą tarnybą.

Komandos naudojimas¶

digna windows start [OPTIONS]

Parinktys¶

--name: Pavadinimas, kuriuo užregistruota tarnyba (numatytoji reikšmė: digna).

windows stop¶

Komanda windows stop sustabdo veikiančią tarnybą. Prieš keisdami bet kurį programos failą, sustabdykite tarnybą.

Komandos naudojimas¶

digna windows stop [OPTIONS]

Parinktys¶

--name: Pavadinimas, kuriuo užregistruota tarnyba (numatytoji reikšmė: digna).

windows uninstall¶

Komanda windows uninstall išregistruoja tarnybą. Pirmiausia ją sustabdykite.

Komandos naudojimas¶

digna windows uninstall [OPTIONS]

Parinktys¶

--name: Pavadinimas, kuriuo užregistruota tarnyba (numatytoji reikšmė: digna).