विषय पर बढ़ें

digna CLI संदर्भ 2024.12

2024-12-09

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

2024-12-09

CLI बेसिक्स

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

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

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

    --help को कीवर्ड dignacli के तुरंत बाद उपयोग करें।
    ```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 and Schema.

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

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

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

कमांड उपयोग

dignacli --version

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

dignacli version 2024.12

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

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

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

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

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

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

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

उदाहरण

उपयोगकर्ता 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 कमांड मौजूदा उपयोगकर्ता को digna सिस्टम से हटाने के लिए उपयोग किया जाता है।

कमांड उपयोग

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 कमांड digna सिस्टम में पंजीकृत सभी उपयोगकर्ताओं की सूची प्रदर्शित करता है।

कमांड उपयोग

dignacli list-users

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

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

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

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

कमांड उपयोग

dignacli upgrade-repo [options]

विकल्प

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

उदाहरण

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

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

dignacli upgrade-repo --simulation-mode

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

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

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

कमांड उपयोग

dignacli encrypt <PASSWORD>

आर्गुमेंट्स

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

उदाहरण

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

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

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

generate-key कमांड Fernet key जनरेट करने के लिए उपयोग किया जाता है, जो 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: अलर्ट स्टेटस की पुनर्गणना को रोकता है।
  • --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 कमांड का उपयोग

digna CLI में tls-status कमांड किसी प्रोजेक्ट के भीतर किसी विशिष्ट तालिका के लिए किसी दिए गए दिनांक पर 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 में (अनिवार्य)।

उदाहरण

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

dignacli tls-status ProjectA UserData 2024-07-01

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

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

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

कमांड उपयोग

dignacli list-projects

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

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

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

कमांड उपयोग

dignacli list-ds <PROJECT_NAME>

आर्गुमेंट्स

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

उदाहरण

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

dignacli list-ds ProjectA

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