انتقل إلى المحتوى

مرجع digna CLI 2024.09

2024-08-24

أساسيات CLI

help

توفر الخاصية --help معلومات حول الأوامر المتاحة وكيفية استخدامها. هناك طريقتان رئيسيتان لاستخدام هذا الخيار:

  1. عرض المساعدة العامة:

    استخدم –help مباشرة بعد الكلمة الأساسية dignacl
    bash dignacli --help

  2. الحصول على المساعدة لأمر محدد:

    للحصول على معلومات تفصيلية حول أمر معين، أضف --help إلى ذلك الأمر. على سبيل المثال، للحصول على مساعدة حول الأمر add-user، شغّل: bash dignacli add-user --help

    ### المخرجات:

    • وصف الأمر: يقدّم وصفًا مفصلاً لما يفعله الأمر.
    • التركيب: يعرض الصيغة الدقيقة، بما في ذلك الوسائط المطلوبة والاختيارية.
    • الخيارات: يسرد أي خيارات خاصة بالأمر، مع شرحها.
    • أمثلة: يقدّم أمثلة حول كيفية تنفيذ الأمر بشكل فعّال.

check-repo-connection

أمر check-repo-connection هو أداة ضمن أداة سطر الأوامر digna مصممة لاختبار إمكانية الاتصال والوصول إلى مستودع digna المحدد. يضمن هذا الأمر أن واجهة CLI قادرة على التفاعل مع المستودع.

استخدام الأمر

bash dignacli check-repo-connection

عند التنفيذ الناجح، يعرض الأمر تأكيدًا للاتصال، إلى جانب تفاصيل عن المستودع: إصدار المستودع، المضيف، قاعدة البيانات والمخطط (Schema).

إذا لم ينجح اتصال المستودع، فراجع ملف config.toml للتأكد من إعدادات التكوين الصحيحة.

version

للتحقق من النسخة المثبتة من dignacli، استخدم الخيار --version.

استخدام الأمر

bash dignacli --version

مثال على المخرجات

bash dignacli version 2024.09

خيارات السجل (logging)

بشكل افتراضي، تم تصميم مخرجات سطر الأوامر لأوامر digna لتكون مقتضبة. توفر معظم الأوامر إمكانية عرض معلومات إضافية باستخدام الخيارات التالية:

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

"verbose" و "debug" تحددان مستوى التفصيل، بينما يتيح خيار "logfile" إعادة توجيه المخرجات ليتم تسجيلها في ملف بدلاً من نافذة الطرفية.

إدارة المستخدمين

add-user

أمر add-user في واجهة سطر الأوامر digna يُستخدم لإضافة مستخدم جديد إلى نظام digna.

استخدام الأمر

bash 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:

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

أمر delete-user في واجهة سطر الأوامر digna يُستخدم لإزالة مستخدم موجود من نظام digna.

استخدام الأمر

bash dignacli delete-user USER_NAME

الوسائط

  • USER_NAME: اسم المستخدم للمستخدم المراد حذفه (مطلوب). هذا هو الوسيط الوحيد المطلوب للأمر.

مثال

bash dignacli delete-user jdoe

سيؤدي تنفيذ هذا الأمر إلى إزالة المستخدم jdoe من نظام digna، وإلغاء وصوله وحذف البيانات والأذونات المرتبطة به من المستودع.

modify-user

أمر modify-user في واجهة سطر الأوامر digna يُستخدم لتحديث بيانات مستخدم موجود في نظام digna.

استخدام الأمر

bash dignacli modify-user [options]

الوسائط

  • USER_NAME: اسم المستخدم الذي سيتم تعديله (مطلوب).
  • USER_FULL_NAME: الاسم الكامل الجديد للمستخدم (مطلوب).

الخيارات

  • --is_superuser, -su: يجعله مستخدمًا ذا صلاحيات مشرف (superuser)، مما يمنحه امتيازات مرتفعة. هذا العلم لا يتطلب قيمة.
  • --valid_until, -vu: يحدد تاريخ انتهاء صلاحية الحساب بصيغة YYYY-MM-DD HH:MI:SS. إذا لم يُقدَّم، يبقى الحساب صالحًا إلى أجل غير مسمّى.

مثال

لتعديل الاسم الكامل للمستخدم jdoe إلى "Johnathan Doe" وتعيينه كمشرف: bash dignacli modify-user jdoe "Johnathan Doe" --is_superuser

modify-user-pwd

أمر modify-user-pwd في واجهة سطر الأوامر digna يُستخدم لتغيير كلمة مرور مستخدم موجود في نظام digna.

استخدام الأمر

bash dignacli modify-user-pwd

الوسائط

  • USER_NAME: اسم المستخدم الذي ستُغيّر كلمة مروره (مطلوب).
  • USER_PWD: كلمة المرور الجديدة للمستخدم (مطلوب).

مثال

لتغيير كلمة مرور المستخدم jdoe إلى newpassword123: bash dignacli modify-user-pwd jdoe newpassword123

list-users

أمر list-users في واجهة سطر الأوامر digna يعرض قائمة بجميع المستخدمين المسجلين في نظام digna.

استخدام الأمر

bash dignacli list-users

عند تنفيذ هذا الأمر في واجهة digna، سيتصل بالمستودع ويعرض جميع المستخدمين، مبينًا معرفهم، واسم المستخدم، والاسم الكامل، وحالة المشرف (superuser)، وطوابع انتهاء الصلاحية.

إدارة المستودع (Repository)

upgrade-repo

أمر upgrade-repo في واجهة سطر الأوامر digna يُستخدم لترقية أو تهيئة مستودع digna. هذا الأمر ضروري لتطبيق التحديثات أو إعداد بنية المستودع لأول مرة.

استخدام الأمر

bash dignacli upgrade-repo [options]

الخيارات

  • --simulation-mode, -s: عند التفعيل، يشغّل هذا الخيار الأمر في وضع المحاكاة (simulation mode)، والذي يعرض عبارات SQL التي سيتم تنفيذها لكنه لا ينفذها فعليًا. هذا مفيد لمعاينة التغييرات دون إجراء أي تعديلات على المستودع.

مثال

لترقية مستودع digna، يمكنك تشغيل الأمر بدون أي خيارات:

bash dignacli upgrade-repo

لتشغيل الترقية في وضع المحاكاة (لمشاهدة عبارات SQL دون تطبيقها):

bash dignacli upgrade-repo --simulation-mode

هذا الأمر حيوي لصيانة نظام digna، وضمان أن مخطط قاعدة البيانات ومكونات المستودع الأخرى محدثة مع أحدث إصدار من البرنامج.

encrypt

أمر encrypt في واجهة سطر الأوامر digna يُستخدم لتشفير كلمة مرور.

استخدام الأمر

bash dignacli encrypt

الوسائط

  • PASSWORD: كلمة المرور التي يجب تشفيرها (مطلوب).

مثال

لتشفير كلمة مرور، يجب تزويد كلمة المرور كوسيط.
على سبيل المثال، لتشفير كلمة المرور mypassword123، ستستخدم: bash dignacli encrypt mypassword123

سيُخرِج هذا الأمر النسخة المشفّرة من كلمة المرور المقدمة، والتي يمكن استخدامها في سياقات آمنة. إذا لم يتم تقديم وسيط كلمة المرور، سيعرض CLI خطأ يشير إلى الوسيط المفقود.

generate-key

أمر generate-key يُستخدم لتوليد مفتاح Fernet، وهو ضروري لتأمين كلمات المرور المخزنة في مستودع digna.

استخدام الأمر

bash dignacli generate-key

إدارة البيانات

clean-up

أمر clean-up في واجهة سطر الأوامر digna يُستخدم لإزالة الملفات التعريفية (profiles)، والتنبؤات، وبيانات نظام الإشارة الضوئية (traffic light system) لمصدر بيانات واحد أو أكثر داخل مشروع محدد. هذا الأمر أساسي لإدارة دورة حياة البيانات، ويساعد في الحفاظ على بيئة بيانات منظمة وفعّالة من خلال مسح البيانات القديمة أو غير الضرورية.

استخدام الأمر

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

أمر inspect في واجهة سطر الأوامر digna يُستخدم لإنشاء الملفات التعريفية (profiles)، والتنبؤات، وبيانات نظام الإشارة الضوئية (traffic light system) لمصدر بيانات واحد أو أكثر داخل مشروع محدد. يساعد هذا الأمر في تحليل ومراقبة البيانات خلال فترة زمنية محددة.

استخدام الأمر

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

أمر tls-status في واجهة سطر الأوامر digna يُستخدم للاستعلام عن حالة نظام الإشارة الضوئية (TLS) لجدول محدد داخل مشروع في تاريخ معين. يوفّر نظام الإشارة الضوئية رؤية حول صحة وجودة البيانات، مشيرًا إلى أي مشكلات أو تنبيهات قد تتطلب الانتباه.

استخدام الأمر

bash dignacli tls-status

الوسائط

  • PROJECT_NAME: اسم المشروع الذي يتم الاستعلام عن حالة TLS له (مطلوب).
  • TABLE_NAME: الجدول المحدد داخل المشروع الذي تُطلب حالة TLS له (مطلوب).
  • DATE: التاريخ الذي يتم الاستعلام عن حالة TLS لأجله، عادةً بصيغة %Y-%m-%d (مطلوب).

مثال

للتحقق من حالة TLS لجدول باسم UserData في المشروع ProjectA بتاريخ 1 يوليو 2024:

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

يساعد هذا الأمر المستخدمين على مراقبة وصيانة جودة البيانات من خلال تقديم تقرير حالة واضح وقابل للتنفيذ بناءً على معايير محددة مسبقًا.

list-projects

أمر list-projects في واجهة سطر الأوامر digna يُستخدم لعرض قائمة بجميع المشاريع المتاحة داخل نظام digna.

استخدام الأمر

bash dignacli list-projects

هذا الأمر مفيد بشكل خاص للمسؤولين والمستخدمين الذين يديرون مشاريع متعددة، حيث يوفر نظرة سريعة على المشاريع المتاحة في مستودع digna.

list-ds

أمر list-ds في واجهة سطر الأوامر digna يُستخدم لعرض قائمة بجميع مصادر البيانات المتاحة داخل مشروع محدد. هذا الأمر مفيد لفهم الأصول البيانية المتاحة للتحليل والإدارة في نظام digna.

استخدام الأمر

bash dignacli list-ds

الوسائط

  • PROJECT_NAME: اسم المشروع الذي تُدرج مصادر البيانات الخاصة به (مطلوب).

مثال

لسرد جميع مصادر البيانات في المشروع المسمّى ProjectA:

bash dignacli list-ds ProjectA

يوفر هذا الأمر للمستخدمين نظرة عامة على مصادر البيانات المتاحة في المشروع، مما يساعدهم على التنقل وإدارة مشهد البيانات بشكل أكثر فاعلية.