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

digna CLI Reference 2024.12

2024-12-09

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

2024-12-09

أساسيات CLI

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

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

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

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

    dignacli --help

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

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

    dignacli add-user --help

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

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

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

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

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

dignacli check-repo-connection

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

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

استخدام أمر ‘version’

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

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

dignacli --version

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

dignacli version 2024.12

استخدام خيارات التسجيل (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

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

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

استخدام أمر 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
يخرج هذا الأمر النسخة المشفّرة من كلمة المرور المقدّمة، والتي يمكن استخدامها في سياقات آمنة. إذا لم يُقدّم وسيط كلمة المرور، سيعرض CLI خطأ يشير إلى الوسيط المفقود.

استخدام أمر 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: يمنع إعادة حساب حالات التنبيه.
  • --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

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

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

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

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