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

digna CLI Reference 2024.11

2024-11-03

توثّق هذه الصفحة المجموعة الكاملة من الأوامر المتاحة في واجهة الأوامر digna للإصدار 2024.11، بما في ذلك أمثلة للاستخدام والخيارات.

أساسيات واجهة الأوامر

استخدام خيار help

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

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

    استخدم –help مباشرة بعد الكلمة المفتاحية dignacl

    dignacli --help

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

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

    dignacli add-user --help

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

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

استخدام أمر check-repo-connection

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

طريقة الاستخدام

dignacli check-repo-connection

عند التنفيذ الناجح، يعرض الأمر تأكيدًا للاتصال، مع تفاصيل حول المستودع: نسخة المستودع، المضيف، قاعدة البيانات والمخطط (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 في واجهة الأوامر digna يُستخدم لإضافة مستخدم جديد إلى نظام digna.

طريقة الاستخدام

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:

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 في واجهة الأوامر digna يُستخدم لإزالة مستخدم موجود من نظام digna.

طريقة الاستخدام

dignacli delete-user USER_NAME

الوسائط

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

مثال

dignacli delete-user jdoe

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

استخدام أمر modify-user

أمر modify-user في واجهة الأوامر 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” وجعله مشرفًا: 

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

استخدام أمر modify-user-pwd

أمر modify-user-pwd في واجهة الأوامر 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 في واجهة الأوامر digna يعرض قائمة بجميع المستخدمين المسجَّلين في نظام digna.

طريقة الاستخدام

dignacli list-users

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

إدارة المستودع

استخدام أمر upgrade-repo

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

طريقة الاستخدام

dignacli upgrade-repo [options]

الخيارات

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

مثال

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

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

dignacli upgrade-repo --simulation-mode

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

استخدام أمر encrypt

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

طريقة الاستخدام

dignacli encrypt <PASSWORD>

الوسائط

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

مثال

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

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

استخدام أمر generate-key

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

طريقة الاستخدام

dignacli generate-key

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

استخدام أمر clean-up

أمر clean-up في واجهة الأوامر digna يُستخدم لإزالة ملفات التعريف (profiles) والتنبؤات وبيانات نظام إشارات المرور (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: يقيّد عملية التنظيف لجدول معين داخل المشروع.
  • --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

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

طريقة الاستخدام

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 في واجهة الأوامر digna يُستخدم لاستعلام حالة نظام إشارات المرور (Traffic Light System - TLS) لجدول محدد داخل مشروع في تاريخ معيّن. يقدّم نظام إشارات المرور رؤى حول صحة وجودة البيانات، مشيرًا إلى أي مشكلات أو تنبيهات قد تحتاج إلى الانتباه.

طريقة الاستخدام

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 في واجهة الأوامر digna يُستخدم لعرض قائمة بجميع المشاريع المتاحة داخل نظام digna.

طريقة الاستخدام

dignacli list-projects

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

استخدام أمر list-ds

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

طريقة الاستخدام

dignacli list-ds <PROJECT_NAME>

الوسائط

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

مثال

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

dignacli list-ds ProjectA

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