digna CLI Reference 2024.11¶
2024-11-03
Αυτή η σελίδα τεκμηριώνει το πλήρες σύνολο εντολών που είναι διαθέσιμες στην CLI της digna έκδοσης 2024.11, συμπεριλαμβανομένων παραδειγμάτων χρήσης και επιλογών.
Βασικά της CLI¶
Χρήση της Επιλογής help¶
Η επιλογή --help παρέχει πληροφορίες σχετικά με τις διαθέσιμες εντολές και τη χρήση τους. Υπάρχουν δύο βασικοί τρόποι χρήσης αυτής της επιλογής:
- Εμφάνιση Γενικής Βοήθειας:
Χρησιμοποιήστε --help αμέσως μετά το κείμενο dignacl
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.11
Χρήση επιλογών καταγραφής (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: Σημαία για να καθορίσετε τον νέο χρήστη ως διαχειριστή.--valid_until,-vu: Ορίζει ημερομηνία λήξης για τον λογαριασμό χρήστη σε μορφήYYYY-MM-DD HH:MI:SS. Εάν δεν οριστεί, ο λογαριασμός δεν έχει ημερομηνία λήξης.
Παράδειγμα¶
Για να προσθέσετε νέο χρήστη με username 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 τους, το όνομα χρήστη, το πλήρες όνομα, την κατάσταση superuser και τα timestamps λήξης.
Διαχείριση Αποθετηρίου¶
Χρήση της εντολής 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 key, το οποίο είναι απαραίτητο για την ασφάλεια των κωδικών που αποθηκεύονται στο αποθετήριο της digna.
Χρήση Εντολής¶
dignacli generate-key
Διαχείριση Δεδομένων¶
Χρήση της εντολής clean-up¶
Η εντολή clean-up στο CLI της digna χρησιμοποιείται για την αφαίρεση προφίλ, προβλέψεων και δεδομένων του συστήματος φωτεινού σηματοδότη (traffic light system) για μία ή περισσότερες πηγές δεδομένων μέσα σε ένα συγκεκριμένο έργο. Αυτή η εντολή είναι σημαντική για τη διαχείριση του κύκλου ζωής των δεδομένων, βοηθώντας στη διατήρηση ενός οργανωμένου και αποδοτικού περιβάλλοντος δεδομένων με την εκκαθάριση παρωχημένων ή μη απαραίτητων δεδομένων.
Χρήση Εντολής¶
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-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 χρησιμοποιείται για τη δημιουργία προφίλ, προβλέψεων και δεδομένων του συστήματος φωτεινού σηματοδότη για μία ή περισσότερες πηγές δεδομένων εντός ενός συγκεκριμένου έργου. Αυτή η εντολή βοηθά στην ανάλυση και την παρακολούθηση δεδομένων για μια ορισμένη περίοδο.
Χρήση Εντολής¶
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: Αποτρέπει τον επανυπολογισμό καταστάσεων ειδοποιήσεων.--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
Αυτή η εντολή παρέχει στους χρήστες μια επισκόπηση των πηγών δεδομένων που είναι διαθέσιμες σε ένα έργο, βοηθώντας τους να περιηγηθούν και να διαχειριστούν το τοπίο των δεδομένων πιο αποτελεσματικά.