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