विषय पर बढ़ें

digna CLI संदर्भ 2024.09

2024-08-24

CLI मूल बातें

help

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

  1. सामान्य सहायता दिखाना:

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

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

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

    ### आउटपुट:

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

check-repo-connection

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

कमांड उपयोग

bash dignacli check-repo-connection

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

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

version

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

कमांड उपयोग

bash dignacli --version

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

bash dignacli version 2024.09

लॉगिंग विकल्प

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

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

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

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

add-user

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

कमांड उपयोग

bash 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 के साथ नया उपयोगकर्ता जोड़ने के लिए:

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

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

कमांड उपयोग

bash dignacli delete-user USER_NAME

आर्गुमेंट्स

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

उदाहरण

bash dignacli delete-user jdoe

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

modify-user

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

कमांड उपयोग

bash dignacli modify-user [options]

आर्गुमेंट्स

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

विकल्प

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

उदाहरण

उदाहरण के लिए, उपयोगकर्ता jdoe का पूरा नाम “Johnathan Doe” में बदलने और उसे सुपरयूज़र बनाने के लिए: bash dignacli modify-user jdoe "Johnathan Doe" --is_superuser

modify-user-pwd

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

कमांड उपयोग

bash dignacli modify-user-pwd

आर्गुमेंट्स

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

उदाहरण

उदाहरण के लिए, उपयोगकर्ता jdoe का पासवर्ड newpassword123 में बदलने के लिए: bash dignacli modify-user-pwd jdoe newpassword123

list-users

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

कमांड उपयोग

bash dignacli list-users

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

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

upgrade-repo

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

कमांड उपयोग

bash dignacli upgrade-repo [options]

विकल्प

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

उदाहरण

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

bash dignacli upgrade-repo

SQL स्टेटमेंट्स को देखे बिना अपग्रेड सिमुलेशन मोड में चलाने के लिए:

bash dignacli upgrade-repo --simulation-mode

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

encrypt

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

कमांड उपयोग

bash dignacli encrypt

आर्गुमेंट्स

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

उदाहरण

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

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

generate-key

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

कमांड उपयोग

bash dignacli generate-key

डेटा प्रबंधन

clean-up

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

कमांड उपयोग

bash dignacli clean-up [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 के बीच का डेटा हटाने के लिए:

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

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

कमांड उपयोग

bash dignacli inspect [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: केवल उन टेबल्स का निरीक्षण करने के लिए फ़िल्टर करता है जिनके नाम में निर्दिष्ट सबस्ट्रिंग हो।
  • --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: सब्सक्राइब किए गए चैनलों पर अलर्ट नोटिफिकेशन भेजता है।

उदाहरण

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

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

कमांड उपयोग

bash dignacli tls-status

आर्गुमेंट्स

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

उदाहरण

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

bash dignacli tls-status ProjectA UserData 2024-07-01

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

list-projects

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

कमांड उपयोग

bash dignacli list-projects

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

list-ds

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

कमांड उपयोग

bash dignacli list-ds

आर्गुमेंट्स

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

उदाहरण

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

bash dignacli list-ds ProjectA

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