digna CLI Reference 2024.09¶
2024-08-24
CLI Basics¶
help¶
Η επιλογή --help παρέχει πληροφορίες σχετικά με τις διαθέσιμες εντολές και τη χρήση τους. Υπάρχουν δύο βασικοί τρόποι χρήσης αυτής της επιλογής:
-
Εμφάνιση Γενικής Βοήθειας:
Χρησιμοποιήστε το --help αμέσως μετά το κλειδί dignacli
bash dignacli --help -
Λήψη Βοήθειας για Συγκεκριμένες Εντολές:
Για λεπτομερείς πληροφορίες σχετικά με μια συγκεκριμένη εντολή, προσθέστε --help σε εκείνη την εντολή. Για παράδειγμα, για να λάβετε βοήθεια για την εντολή add-user, εκτελέστε: bash dignacli add-user --help
### output:
- Περιγραφή Εντολής: Παρέχει μια λεπτομερή περιγραφή του τι κάνει η εντολή.
- Συντακτικό: Δείχνει το ακριβές συντακτικό, συμπεριλαμβανομένων των απαιτούμενων και προαιρετικών ορισμάτων.
- Επιλογές: Καταγράφει τις επιλογές που αφορούν την εντολή, μαζί με τις εξηγήσεις τους.
- Παραδείγματα: Παρέχει παραδείγματα του πώς να εκτελέσετε αποτελεσματικά την εντολή.
check-repo-connection¶
Η εντολή check-repo-connection είναι ένα βοηθητικό εργαλείο μέσα στο digna CLI που προορίζεται για έλεγχο της συνδεσιμότητας και της πρόσβασης σε ένα συγκεκριμένο αποθετήριο digna. Αυτή η εντολή διασφαλίζει ότι το CLI μπορεί να αλληλεπιδράσει με το αποθετήριο.
Command Usage¶
bash dignacli check-repo-connection
Με την επιτυχή εκτέλεση, η εντολή εμφανίζει μια επιβεβαίωση της σύνδεσης, μαζί με λεπτομέρειες σχετικά με το αποθετήριο: έκδοση αποθετηρίου, Host, Database και Schema.
Εάν η σύνδεση με το αποθετήριο δεν είναι επιτυχής, ελέγξτε το αρχείο config.toml για τις σωστές ρυθμίσεις.
version¶
Για να ελέγξετε την εγκατεστημένη έκδοση του dignacli, χρησιμοποιήστε την επιλογή --version.
Command Usage¶
bash dignacli --version
Example Output¶
bash dignacli version 2024.09
logging options¶
Από προεπιλογή, η έξοδος στο κονσόλα των εντολών του digna είναι σχεδιασμένη να είναι μινιμαλιστική. Οι περισσότερες εντολές προσφέρουν τη δυνατότητα παροχής πρόσθετων πληροφοριών, χρησιμοποιώντας τις ακόλουθες επιλογές:
-- verbose (-v)
-- debug (-d)
-- logfile (lf)
Οι “verbose” και “debug” ορίζουν το επίπεδο λεπτομέρειας, ενώ η επιλογή “logfile” επιτρέπει την ανακατεύθυνση της εξόδου ώστε να αποθηκεύεται σε αρχείο αντί να εμφανίζεται στο παράθυρο της κονσόλας.
User Management¶
add-user¶
Η εντολή add-user στο digna CLI χρησιμοποιείται για την προσθήκη ενός νέου χρήστη στο σύστημα digna.
Command Usage¶
bash dignacli add-user [OPTIONS] USER_NAME USER_FULL_NAME USER_PASSWORD
Arguments¶
- USER_NAME: Το όνομα χρήστη για τον νέο χρήστη (απαιτείται).
- USER_FULL_NAME: Το πλήρες όνομα του νέου χρήστη (απαιτείται).
- USER_PASSWORD: Ο κωδικός πρόσβασης του νέου χρήστη (απαιτείται).
Options¶
- --is_superuser, -su: Σημαία για την ανάθεση του νέου χρήστη ως διαχειριστή.
- --valid_until, -vu: Ορίζει ημερομηνία λήξης για τον λογαριασμό χρήστη με τη μορφή YYYY-MM-DD HH:MI:SS. Εάν δεν οριστεί, ο λογαριασμός δεν έχει ημερομηνία λήξης.
Example¶
Για να προσθέσετε έναν νέο χρήστη με όνομα χρήστη jdoe, πλήρες όνομα John Doe και κωδικό password123:
bash dignacli add-user [OPTIONS] USER_NAME USER_FULL_NAME USER_PASSWORD
Για να προσθέσετε έναν νέο χρήστη και να ορίσετε ημερομηνία λήξης του λογαριασμού: bash dignacli add-user jdoe "John Doe" password123 --valid_until "2024-12-31 23:59:59"
delete-user¶
Η εντολή delete-user στο digna CLI χρησιμοποιείται για την αφαίρεση ενός υπάρχοντος χρήστη από το σύστημα digna.
Command Usage¶
bash dignacli delete-user USER_NAME
Arguments¶
- USER_NAME: Το όνομα χρήστη του λογαριασμού που θα διαγραφεί (απαιτείται). Αυτό είναι το μόνο όρισμα που απαιτείται από την εντολή.
Example¶
bash dignacli delete-user jdoe
Η εκτέλεση αυτής της εντολής θα αφαιρέσει τον χρήστη jdoe από το σύστημα digna, ανακαλώντας την πρόσβασή του και διαγράφοντας τα συναφή δεδομένα και δικαιώματά του από το αποθετήριο.
modify-user¶
Η εντολή modify-user στο digna CLI χρησιμοποιείται για την ενημέρωση των στοιχείων ενός υπάρχοντος χρήστη στο σύστημα digna.
Command Usage¶
bash dignacli modify-user
Arguments¶
- USER_NAME: Το όνομα χρήστη του λογαριασμού που πρόκειται να τροποποιηθεί (απαιτείται).
- USER_FULL_NAME: Το νέο πλήρες όνομα για τον χρήστη (απαιτείται).
Options¶
- --is_superuser, -su: Ορίζει τον χρήστη ως superuser, παραχωρώντας αυξημένα προνόμια. Αυτή η σημαία δεν απαιτεί τιμή.
- --valid_until, -vu: Ορίζει ημερομηνία λήξης για τον λογαριασμό χρήστη με τη μορφή YYYY-MM-DD HH:MI:SS. Εάν δεν παρασχεθεί, ο λογαριασμός παραμένει έγκυρος επ’ αόριστον.
Example¶
Για να τροποποιήσετε το πλήρες όνομα του χρήστη jdoe σε “Johnathan Doe” και να ορίσετε τον χρήστη ως superuser: bash dignacli modify-user jdoe "Johnathan Doe" --is_superuser
modify-user-pwd¶
Η εντολή modify-user-pwd στο digna CLI χρησιμοποιείται για την αλλαγή του κωδικού πρόσβασης ενός υπάρχοντος χρήστη στο σύστημα digna.
Command Usage¶
bash dignacli modify-user-pwd
Arguments¶
- USER_NAME: Το όνομα χρήστη του λογαριασμού του οποίου θα αλλάξει ο κωδικός (απαιτείται).
- USER_PWD: Ο νέος κωδικός για τον χρήστη (απαιτείται).
Example¶
Για να αλλάξετε τον κωδικό του χρήστη jdoe σε newpassword123: bash dignacli modify-user-pwd jdoe newpassword123
list-users¶
Η εντολή list-users στο digna CLI εμφανίζει μια λίστα με όλους τους χρήστες που είναι καταχωρημένοι στο σύστημα digna.
Command Usage¶
bash dignacli list-users
Η εκτέλεση αυτής της εντολής στο digna CLI θα συνδεθεί με το αποθετήριο digna και θα καταγράψει όλους τους χρήστες, εμφανίζοντας το ID τους, το όνομα χρήστη, το πλήρες όνομα, την κατάσταση superuser και τις χρονικές σφραγίδες λήξης.
Repository Management¶
upgrade-repo¶
Η εντολή upgrade-repo στο digna CLI χρησιμοποιείται για την αναβάθμιση ή την αρχικοποίηση του αποθετηρίου digna. Αυτή η εντολή είναι κρίσιμη για την εφαρμογή ενημερώσεων ή τη ρύθμιση της υποδομής του αποθετηρίου για πρώτη φορά.
Command Usage¶
bash dignacli upgrade-repo [options]
Options¶
- --simulation-mode, -s: Όταν είναι ενεργοποιημένη, η επιλογή αυτή εκτελεί την εντολή σε λειτουργία προσομοίωσης, η οποία εμφανίζει τις δηλώσεις SQL που θα εκτελεστούν αλλά δεν τις εφαρμόζει πραγματικά. Αυτό είναι χρήσιμο για προεπισκόπηση των αλλαγών χωρίς να γίνουν τροποποιήσεις στο αποθετήριο.
Example¶
Για να αναβαθμίσετε το αποθετήριο digna, μπορείτε να εκτελέσετε την εντολή χωρίς επιλογές:
bash dignacli upgrade-repo
Για να εκτελέσετε την αναβάθμιση σε λειτουργία προσομοίωσης (για να δείτε τις δηλώσεις SQL χωρίς να τις εφαρμόσετε):
bash dignacli upgrade-repo --simulation-mode
Αυτή η εντολή είναι ζωτικής σημασίας για τη συντήρηση του συστήματος digna, διασφαλίζοντας ότι το σχήμα της βάσης δεδομένων και άλλα στοιχεία του αποθετηρίου είναι ενημερωμένα με την τελευταία έκδοση του λογισμικού.
encrypt¶
Η εντολή encrypt στο digna CLI χρησιμοποιείται για την κρυπτογράφηση ενός κωδικού.
Command Usage¶
bash dignacli encrypt
Arguments¶
- PASSWORD: Ο κωδικός που πρέπει να κρυπτογραφηθεί (απαιτείται).
Example¶
Για να κρυπτογραφήσετε έναν κωδικό, πρέπει να παρέχετε τον κωδικό ως όρισμα.
Για παράδειγμα, για να κρυπτογραφήσετε τον κωδικό mypassword123, θα χρησιμοποιούσατε: bash dignacli encrypt mypassword123
Αυτή η εντολή εμφανίζει την κρυπτογραφημένη έκδοση του παρεχόμενου κωδικού, η οποία μπορεί στη συνέχεια να χρησιμοποιηθεί σε ασφαλή περιβάλλοντα. Εάν δεν δοθεί το όρισμα του κωδικού, το CLI θα εμφανίσει ένα σφάλμα που υποδεικνύει το ελλείπον όρισμα.
generate-key¶
Η εντολή generate-key χρησιμοποιείται για τη δημιουργία ενός Fernet key, το οποίο είναι απαραίτητο για την ασφαλή αποθήκευση κωδικών στο αποθετήριο digna.
Command Usage¶
bash dignacli generate-key
Data Management¶
clean-up¶
Η εντολή clean-up στο digna CLI χρησιμοποιείται για την αφαίρεση προφίλ, προβλέψεων και δεδομένων του Traffic Light System για μία ή περισσότερες πηγές δεδομένων εντός ενός καθορισμένου έργου. Αυτή η εντολή είναι απαραίτητη για τη διαχείριση του κύκλου ζωής των δεδομένων, βοηθώντας στη διατήρηση ενός οργανωμένου και αποδοτικού περιβάλλοντος δεδομένων με τον καθαρισμό παλαιών ή περιττών δεδομένων.
Command Usage¶
bash dignacli clean-up
Arguments¶
- PROJECT_NAME: Το όνομα του έργου από το οποίο θα αφαιρεθούν τα δεδομένα (απαιτείται). Η χρήση της λέξης-κλειδιού all-projects σε αυτό το όρισμα υποδεικνύει στο digna να επαναλάβει τη διαδικασία για όλα τα υπάρχοντα έργα και να εφαρμόσει αυτή την εντολή.
- FROM_DATE: Η ημερομηνία και ώρα έναρξης για την αφαίρεση των δεδομένων. Επιτρεπόμενες μορφές περιλαμβάνουν %Y-%m-%d, %Y-%m-%dT%H:%M:%S ή %Y-%m-%d %H:%M:%S (απαιτείται).
- TO_DATE: Η ημερομηνία και ώρα λήξης για την αφαίρεση των δεδομένων, με τις ίδιες αποδεκτές μορφές όπως το FROM_DATE (απαιτείται).
Options¶
- --table-name, -tn: Περιορίζει τη λειτουργία clean-up σε έναν συγκεκριμένο πίνακα εντός του έργου.
- --table-filter, -tf: Φιλτράρει για να περιορίσει τον καθαρισμό σε πίνακες που περιέχουν την καθορισμένη υποσυμβολοσειρά στο όνομά τους.
- --timing, -tm: Εμφανίζει τη διάρκεια του καθαρισμού μετά την ολοκλήρωση.
- --help: Εμφανίζει πληροφορίες βοήθειας για την εντολή clean-up και τερματίζει.
Example¶
Για να αφαιρέσετε δεδομένα από το έργο ProjectA μεταξύ 1 Ιανουαρίου 2023 και 30 Ιουνίου 2023:
bash dignacli clean-up ProjectA 2023-01-01 2023-06-30
Για να αφαιρέσετε δεδομένα μόνο από έναν συγκεκριμένο πίνακα με όνομα Table1:
bash dignacli clean-up ProjectA 2023-01-01 2023-06-30 --table-name Table1
Αυτή η εντολή βοηθά στη διαχείριση του αποθηκευτικού χώρου και διασφαλίζει ότι το αποθετήριο περιέχει μόνο τις σχετικές πληροφορίες.
inspect¶
Η εντολή inspect στο digna CLI χρησιμοποιείται για τη δημιουργία προφίλ, προβλέψεων και δεδομένων του Traffic Light System για μία ή περισσότερες πηγές δεδομένων εντός ενός καθορισμένου έργου. Αυτή η εντολή βοηθά στην ανάλυση και παρακολούθηση των δεδομένων μέσα σε ένα ορισμένο χρονικό διάστημα.
Command Usage¶
bash dignacli inspect
Arguments¶
- PROJECT_NAME: Το όνομα του έργου για το οποίο θα ελεγχθούν τα δεδομένα (απαιτείται). Η χρήση της λέξης-κλειδιού all-projects σε αυτό το όρισμα υποδεικνύει στο digna να επαναλάβει τη διαδικασία για όλα τα υπάρχοντα έργα και να εφαρμόσει αυτή την εντολή.
- FROM_DATE: Η ημερομηνία και ώρα έναρξης για την επιθεώρηση των δεδομένων. Επιτρεπόμενες μορφές περιλαμβάνουν %Y-%m-%d, %Y-%m-%dT%H:%M:%S ή %Y-%m-%d %H:%M:%S (απαιτείται).
- TO_DATE: Η ημερομηνία και ώρα λήξης για την επιθεώρηση των δεδομένων, με τις ίδιες αποδεκτές μορφές όπως το FROM_DATE (απαιτείται).
Options¶
- --table-name, -tn: Περιορίζει την επιθεώρηση σε έναν συγκεκριμένο πίνακα εντός του έργου.
- --table-filter, -tf: Φιλτράρει για να επιθεωρηθούν μόνο πίνακες που περιέχουν την καθορισμένη υποσυμβολοσειρά στο όνομά τους.
- --force-profile: Αναγκάζει την επανασυλλογή προφίλ. Η προεπιλογή είναι force-profile.
- --no-force-profile: Αποτρέπει την επανασυλλογή προφίλ.
- --force-prediction: Αναγκάζει τον επαναυπολογισμό των προβλέψεων. Η προεπιλογή είναι force-prediction.
- --no-force-prediction: Αποτρέπει τον επαναυπολογισμό των προβλέψεων.
- --force-alert-status: Αναγκάζει τον επαναυπολογισμό των καταστάσεων ειδοποίησης. Η προεπιλογή είναι force-alert-status.
- --no-force-alert-status: Αποτρέπει τον επαναυπολογισμό των καταστάσεων ειδοποίησης.
- --timing, -tm: Εμφανίζει τη διάρκεια της διαδικασίας επιθεώρησης μετά την ολοκλήρωση.
- --alert-notification, -an: Αποστέλλει ειδοποιήσεις συναγερμού στα εγγεγραμμένα κανάλια.
Example¶
Για να επιθεωρήσετε δεδομένα για το έργο ProjectA από 1 Ιανουαρίου 2024 έως 31 Ιανουαρίου 2024:
bash dignacli inspect ProjectA 2024-01-01 2024-01-31
Για να επιθεωρήσετε μόνο έναν συγκεκριμένο πίνακα και να αναγκάσετε τον επαναυπολογισμό των προβλέψεων:
bash dignacli inspect ProjectA 2024-01-01 2024-01-31 --table-name Table1 --force-prediction
Αυτή η εντολή είναι χρήσιμη για τη δημιουργία ενημερωμένων προφίλ και προβλέψεων, την παρακολούθηση της ακεραιότητας των δεδομένων και τη διαχείριση των συστημάτων ειδοποιήσεων εντός ενός ορισμένου χρονικού πλαισίου έργου.
tls-status¶
Η εντολή tls-status στο digna CLI χρησιμοποιείται για να ερωτηθεί η κατάσταση του Traffic Light System (TLS) για έναν συγκεκριμένο πίνακα εντός ενός έργου σε μια δεδομένη ημερομηνία. Το Traffic Light System παρέχει πληροφορίες για την υγεία και την ποιότητα των δεδομένων, υποδεικνύοντας τυχόν προβλήματα ή ειδοποιήσεις που χρειάζονται προσοχή.
Command Usage¶
bash dignacli tls-status
Arguments¶
- PROJECT_NAME: Το όνομα του έργου για το οποίο ζητείται η κατάσταση TLS (απαιτείται).
- TABLE_NAME: Ο συγκεκριμένος πίνακας εντός του έργου για τον οποίο χρειάζεται η κατάσταση TLS (απαιτείται).
- DATE: Η ημερομηνία για την οποία ζητείται η κατάσταση TLS, συνήθως με τη μορφή %Y-%m-%d (απαιτείται).
Example¶
Για να ελέγξετε την κατάσταση TLS για έναν πίνακα με όνομα UserData στο έργο ProjectA στις 1 Ιουλίου 2024:
bash dignacli tls-status ProjectA UserData 2024-07-01
Αυτή η εντολή βοηθά τους χρήστες να παρακολουθούν και να διατηρούν την ποιότητα των δεδομένων, παρέχοντας μια σαφή και εφαρμόσιμη αναφορά κατάστασης βάσει προκαθορισμένων κριτηρίων.
list-projects¶
Η εντολή list-projects στο digna CLI χρησιμοποιείται για να εμφανίσει μια λίστα με όλα τα διαθέσιμα έργα στο σύστημα digna.
Command Usage¶
bash dignacli list-projects
Αυτή η εντολή είναι ιδιαίτερα χρήσιμη για διαχειριστές και χρήστες που διαχειρίζονται πολλαπλά έργα, παρέχοντας μια γρήγορη επισκόπηση των διαθέσιμων έργων στο αποθετήριο digna.
list-ds¶
Η εντολή list-ds στο digna CLI χρησιμοποιείται για να εμφανίσει μια λίστα με όλες τις διαθέσιμες πηγές δεδομένων εντός ενός συγκεκριμένου έργου. Αυτή η εντολή είναι χρήσιμη για την κατανόηση των δεδομένων που είναι διαθέσιμα για ανάλυση και διαχείριση στο σύστημα digna.
Command Usage¶
bash dignacli list-ds
Arguments¶
- PROJECT_NAME: Το όνομα του έργου για το οποίο καταγράφονται οι πηγές δεδομένων (απαιτείται).
Example¶
Για να καταγράψετε όλες τις πηγές δεδομένων στο έργο με όνομα ProjectA:
bash dignacli list-ds ProjectA
Αυτή η εντολή παρέχει στους χρήστες μια επισκόπηση των πηγών δεδομένων που είναι διαθέσιμες σε ένα έργο, βοηθώντας τους να πλοηγηθούν και να διαχειριστούν το τοπίο των δεδομένων πιο αποτελεσματικά.