विषय पर बढ़ें

digna CLI Reference 2024.11

2024-11-03

यह पृष्ठ digna CLI रिलीज़ 2024.11 में उपलब्ध पूर्ण कमांड सेट का दस्तावेज़ीकरण करता है, जिसमें उपयोग के उदाहरण और विकल्प शामिल हैं।

CLI बुनियादी बातें

help विकल्प का उपयोग

--help विकल्प उपलब्ध कमांड्स और उनके उपयोग के बारे में जानकारी प्रदान करता है। इस विकल्प के उपयोग के दो मुख्य तरीके हैं:

  1. सामान्य सहायता प्रदर्शित करना:

    –help का उपयोग dignacl कीवर्ड के तुरंत बाद करें
    ```bash dignacli --help

  2. विशिष्ट कमांड्स के लिए सहायता प्राप्त करना:

    किसी विशिष्ट कमांड के बारे में विस्तृत जानकारी के लिए उस कमांड के अंत में --help जोड़ें।
    उदाहरण के लिए, add-user कमांड के लिए मदद प्राप्त करने के लिए चलाएँ: 

    dignacli add-user --help

    ### आउटपुट:

    • कमांड विवरण: बताता है कि कमांड क्या करता है।
    • सिंटैक्स: सटीक सिंटैक्स दिखाता है, जिसमें आवश्यक और वैकल्पिक आर्ग्यूमेंट्स शामिल हैं।
    • विकल्प: कमांड से संबंधित किसी भी विकल्प की सूची और उनके विवरण।
    • उदाहरण: यह दर्शाता है कि कमांड को प्रभावी ढंग से कैसे चलाया जाए।

check-repo-connection कमांड का उपयोग

check-repo-connection कमांड digna CLI टूल के भीतर एक उपयोगिता है जो निर्दिष्ट digna रिपॉज़िटरी तक कनेक्टिविटी और एक्सेस का परीक्षण करने के लिए डिज़ाइन की गई है। यह कमांड सुनिश्चित करती है कि CLI रिपॉज़िटरी के साथ इंटरैक्ट कर सकता है।

कमांड उपयोग

dignacli check-repo-connection

सफल निष्पादन पर, कमांड कनेक्शन की पुष्टि के साथ रिपॉज़िटरी के बारे में विवरण आउटपुट करती है: Repository version, Host, Database और Schema।

यदि रिपॉज़िटरी कनेक्शन सफल नहीं होता है, तो सही कॉन्फ़िगरेशन सेटिंग्स के लिए config.toml फ़ाइल की जाँच करें।

‘version’ कमांड का उपयोग

इंस्टॉल किए गए dignacli संस्करण की जाँच करने के लिए --version विकल्प का उपयोग करें।

कमांड उपयोग

dignacli --version

उदाहरण आउटपुट

dignacli version 2024.11

लॉगिंग विकल्पों का उपयोग

डिफॉल्ट रूप से, digna कमांड्स का कंसोल आउटपुट न्यूनतम रखने के लिए डिज़ाइन किया गया है। अधिकांश कमांड अतिरिक्त जानकारी प्रदान करने की संभावना देते हैं, जिनके लिए निम्न विकल्प उपलब्ध हैं:

-- verbose (-v)
-- debug (-d)
-- logfile (lf)

“verbose” और “debug” जानकारी के स्तर को परिभाषित करते हैं, जबकि “logfile” स्विच आउटपुट को कंसोल की बजाय किसी फ़ाइल में स्ट्रीम करने की अनुमति देता है।

उपयोगकर्ता प्रबंधन

‘add-user’ कमांड का उपयोग

digna CLI में add-user कमांड का उपयोग सिस्टम में नया उपयोगकर्ता जोड़ने के लिए किया जाता है।

कमांड उपयोग

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। यदि सेट नहीं किया गया है, तो खाते की कोई समाप्ति तिथि नहीं होती।

उदाहरण

यूज़रनेम 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 कमांड का उपयोग

digna CLI में delete-user कमांड मौजूदा उपयोगकर्ता को सिस्टम से हटाने के लिए उपयोग किया जाता है।

कमांड उपयोग

dignacli delete-user USER_NAME

आर्ग्यूमेंट्स

  • USER_NAME: हटाए जाने वाले उपयोगकर्ता का यूज़रनेम (आवश्यक)। यह कमांड द्वारा आवश्यक केवल आर्ग्यूमेंट है।

उदाहरण

dignacli delete-user jdoe

यह कमांड उपयोगकर्ता jdoe को digna सिस्टम से हटा देगी, उनका एक्सेस रद्द कर देगी और रिपॉज़िटरी से संबंधित डेटा व अनुमतियाँ मिटा देगी।

modify-user कमांड का उपयोग

digna CLI में modify-user कमांड मौजूदा उपयोगकर्ता के विवरण अपडेट करने के लिए उपयोग की जाती है।

कमांड उपयोग

dignacli modify-user <USER_NAME> <USER_FULL_NAME> [options]

आर्ग्यूमेंट्स

  • USER_NAME: संशोधित किए जाने वाले उपयोगकर्ता का यूज़रनेम (आवश्यक)।
  • USER_FULL_NAME: उपयोगकर्ता के लिए नया पूरा नाम (आवश्यक)।

विकल्प

  • --is_superuser, -su: उपयोगकर्ता को सुपरयूज़र के रूप में सेट करता है, जो बढ़ी हुई विशेषाधिकार देता है। इस फ़्लैग को किसी मान की आवश्यकता नहीं है।
  • --valid_until, -vu: उपयोगकर्ता खाते के लिए समाप्ति तिथि सेट करता है, प्रारूप YYYY-MM-DD HH:MI:SS। यदि प्रदान नहीं किया गया है, तो खाता अनिश्चितकालीन रूप से मान्य रहता है।

उदाहरण

उपयोगकर्ता jdoe का पूरा नाम “Johnathan Doe” में बदलने और उसे सुपरयूज़र बनाने के लिए: 

dignacli modify-user jdoe "Johnathan Doe" --is_superuser

modify-user-pwd कमांड का उपयोग

digna CLI में modify-user-pwd कमांड मौजूदा उपयोगकर्ता का पासवर्ड बदलने के लिए उपयोग की जाती है।

कमांड उपयोग

dignacli modify-user-pwd <USER_NAME> <USER_PWD>

आर्ग्यूमेंट्स

  • USER_NAME: उस उपयोगकर्ता का यूज़रनेम जिसका पासवर्ड बदला जाना है (आवश्यक)।
  • USER_PWD: उपयोगकर्ता के लिए नया पासवर्ड (आवश्यक)।

उदाहरण

उपयोगकर्ता jdoe का पासवर्ड newpassword123 में बदलने के लिए: 

dignacli modify-user-pwd jdoe newpassword123

list-users कमांड का उपयोग

digna CLI में list-users कमांड सिस्टम में पंजीकृत सभी उपयोगकर्ताओं की सूची दिखाती है।

कमांड उपयोग

dignacli list-users

इस कमांड को चलाने पर digna CLI रिपॉज़िटरी से कनेक्ट होकर सभी उपयोगकर्ताओं की सूची प्रदर्शित करेगा, जिसमें उनका ID, यूज़रनेम, पूरा नाम, सुपरयूज़र स्थिति और समाप्ति टाइमस्टैम्प शामिल होंगे।

रिपॉज़िटरी प्रबंधन

upgrade-repo कमांड का उपयोग

digna CLI में upgrade-repo कमांड का उपयोग रिपॉज़िटरी को अपग्रेड या इनिशियलाइज़ करने के लिए किया जाता है। यह कमांड अपडेट लागू करने या पहली बार रिपॉज़िटरी इन्फ्रास्ट्रक्चर सेटअप करने के लिए आवश्यक है।

कमांड उपयोग

dignacli upgrade-repo [options]

विकल्प

  • --simulation-mode, -s: इस विकल्प को सक्षम करने पर कमांड सिमुलेशन मोड में चलता है, जो उन SQL स्टेटमेंट्स को प्रिंट करता है जिन्हें निष्पादित किया जाएगा लेकिन वास्तव में उन्हें नहीं चलाया जाता। यह रिपॉज़िटरी में कोई बदलाव किए बिना परिवर्तनों का पूर्वावलोकन करने के लिए उपयोगी है।

उदाहरण

digna रिपॉज़िटरी को अपग्रेड करने के लिए, आप कमांड बिना किसी विकल्प के चला सकते हैं:

dignacli upgrade-repo
सिमुलेशन मोड में अपग्रेड चलाने के लिए (SQL स्टेटमेंट्स देखने के लिए बिना लागू किए):

dignacli upgrade-repo --simulation-mode

यह कमांड digna सिस्टम के रखरखाव के लिए महत्वपूर्ण है, यह सुनिश्चित करने के लिए कि डेटाबेस स्कीमा और अन्य रिपॉज़िटरी घटक सॉफ़्टवेयर के नवीनतम संस्करण के साथ अद्यतित हैं।

encrypt कमांड का उपयोग

encrypt कमांड का उपयोग पासवर्ड को एन्क्रिप्ट करने के लिए किया जाता है।

कमांड उपयोग

dignacli encrypt <PASSWORD>

आर्ग्यूमेंट्स

  • PASSWORD: वह पासवर्ड जिसे एन्क्रिप्ट करना है (आवश्यक)।

उदाहरण

पासवर्ड को एन्क्रिप्ट करने के लिए पासवर्ड को एक आर्ग्यूमेंट के रूप में प्रदान करें।
उदाहरण के लिए, पासवर्ड mypassword123 को एन्क्रिप्ट करने के लिए आप उपयोग करेंगे: 

dignacli encrypt mypassword123
यह कमांड प्रदान किए गए पासवर्ड का एन्क्रिप्टेड संस्करण आउटपुट करती है, जिसे सुरक्षित संदर्भों में उपयोग किया जा सकता है। यदि पासवर्ड आर्ग्यूमेंट प्रदान नहीं किया गया है, तो CLI गायब आर्ग्यूमेंट का संकेत देती हुई त्रुटि प्रदर्शित करेगा।

generate-key कमांड का उपयोग

generate-key कमांड Fernet की जनरेट करने के लिए उपयोग की जाती है, जो कि digna रिपॉज़िटरी में संग्रहीत पासवर्ड्स को सुरक्षित करने के लिए आवश्यक है।

कमांड उपयोग

dignacli generate-key

डेटा प्रबंधन

clean-up कमांड का उपयोग

digna CLI में clean-up कमांड एक या एक से अधिक डेटा स्रोतों के लिए प्रोफ़ाइल, भविष्यवाणियाँ और ट्रैफ़िक लाइट सिस्टम डेटा को निर्दिष्ट प्रोजेक्ट के भीतर हटाने के लिए उपयोग की जाती है। यह कमांड डेटा लाइफ़साइकल प्रबंधन के लिए आवश्यक है, पुराने या गैर-ज़रूरी डेटा को साफ़ करके एक सुव्यवस्थित और कुशल डेटा वातावरण बनाए रखने में मदद करती है।

कमांड उपयोग

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: क्लीन-अप ऑपरेशन को प्रोजेक्ट के किसी विशिष्ट टेबल तक सीमित करता है।
  • --table-filter, -tf: उन टेबल्स को फ़िल्टर करता है जिनके नामों में निर्दिष्ट सबस्ट्रिंग मौजूद हो।
  • --timing, -tm: क्लीन-अप प्रक्रिया के पूरा होने के बाद समय की अवधि दिखाता है।
  • --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 कमांड का उपयोग

digna CLI में inspect कमांड एक या एक से अधिक डेटा स्रोतों के लिए प्रोफ़ाइल, भविष्यवाणियाँ और ट्रैफ़िक लाइट सिस्टम डेटा बनाने के लिए उपयोग की जाती है। यह कमांड किसी निर्दिष्ट प्रोजेक्ट के भीतर परिभाषित अवधि के लिए डेटा का विश्लेषण और निगरानी करने में मदद करती है।

कमांड उपयोग

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 कमांड का उपयोग

digna CLI में tls-status कमांड किसी प्रोजेक्ट के भीतर किसी विशेष टेबल के लिए दिए गए दिनांक पर ट्रैफ़िक लाइट सिस्टम (TLS) की स्थिति पूछने के लिए उपयोग की जाती है। ट्रैफ़िक लाइट सिस्टम डेटा की स्वास्थ्य और गुणवत्ता पर अंतर्दृष्टि प्रदान करता है, जो किसी भी समस्याओं या अलर्ट्स को इंगित कर सकता है जिनपर कार्रवाई की आवश्यकता हो सकती है।

कमांड उपयोग

dignacli tls-status <PROJECT_NAME> <TABLE_NAME> <DATE>

आर्ग्यूमेंट्स

  • PROJECT_NAME: उस प्रोजेक्ट का नाम जिसके लिए TLS स्थिति पूछी जा रही है (आवश्यक)।
  • TABLE_NAME: प्रोजेक्ट के भीतर वह विशिष्ट टेबल जिसके लिए TLS स्थिति आवश्यक है (आवश्यक)।
  • DATE: वह तारीख जिसके लिए TLS स्थिति पूछी जा रही है, आमतौर पर प्रारूप %Y-%m-%d में (आवश्यक)।

उदाहरण

ProjectA प्रोजेक्ट में UserData नामक टेबल के लिए 1 जुलाई 2024 को TLS स्थिति जाँचने के लिए:

dignacli tls-status ProjectA UserData 2024-07-01

यह कमांड उपयोगकर्ताओं को प्री-परिभाषित मापदंडों के आधार पर स्पष्ट और क्रियाशील स्थिति रिपोर्ट प्रदान करके डेटा गुणवत्ता की निगरानी और बनाए रखने में मदद करता है।

list-projects कमांड का उपयोग

digna CLI में list-projects कमांड सिस्टम में उपलब्ध सभी प्रोजेक्ट्स की सूची प्रदर्शित करने के लिए उपयोग की जाती है।

कमांड उपयोग

dignacli list-projects

यह कमांड विशेष रूप से उन व्यवस्थापकों और उपयोगकर्ताओं के लिए उपयोगी है जो कई प्रोजेक्ट्स का प्रबंधन करते हैं, रिपॉज़िटरी में उपलब्ध प्रोजेक्ट्स का त्वरित ओवरव्यू प्रदान करती है।

list-ds कमांड का उपयोग

digna CLI में list-ds कमांड किसी निर्दिष्ट प्रोजेक्ट के भीतर उपलब्ध सभी डेटा स्रोतों की सूची प्रदर्शित करने के लिए उपयोग की जाती है। यह कमांड विश्लेषण और प्रबंधन के लिए उपलब्ध डेटा एसेट्स को समझने में सहायक है।

कमांड उपयोग

dignacli list-ds <PROJECT_NAME>

आर्ग्यूमेंट्स

  • PROJECT_NAME: उस प्रोजेक्ट का नाम जिसके लिए डेटा स्रोत सूचीबद्ध किए जा रहे हैं (आवश्यक)।

उदाहरण

ProjectA नामक प्रोजेक्ट में सभी डेटा स्रोतों की सूची देखने के लिए:

dignacli list-ds ProjectA

यह कमांड उपयोगकर्ताओं को एक प्रोजेक्ट में उपलब्ध डेटा स्रोतों का अवलोकन प्रदान करती है, जिससे वे डेटा परिदृश्य को अधिक प्रभावी ढंग से नेविगेट और प्रबंधित कर सकें।