پرش به محتویات

مرجع API برای AbarORM

این صفحه یک مرجع دقیق برای کلاس‌ها و متدهای موجود در کتابخانه AbarORM فراهم می‌کند. این مرجع برای توسعه‌دهندگانی است که نیاز به درک کاملی از نحوه استفاده از ویژگی‌های AbarORM دارند.

کلاس‌ها

1. SQLiteModel

کلاس SQLiteModel کلاس پایه‌ای برای تعریف مدل‌هایی است که با پایگاه داده SQLite ارتباط دارند.

متدها

  • class Meta:
  • توضیح: مدل را با پیکربندی پایگاه داده داده شده راه‌اندازی می‌کند.

  • پارامترها:

    • db_config: دیکشنری حاوی پیکربندی پایگاه داده.
    • **kwargs: آرگومان‌های اضافی.

  • save(self)

  • توضیح: نمونه فعلی را در پایگاه داده ذخیره می‌کند. اگر رکورد جدید باشد، وارد می‌شود؛ اگر موجود باشد، بروزرسانی می‌شود.

  • پارامترها: ندارد

  • delete(self)

  • توضیح: نمونه فعلی را از پایگاه داده حذف می‌کند.

  • پارامترها: ندارد

  • get(cls, id)

  • توضیح: یک رکورد را با استفاده از شناسه آن بازیابی می‌کند.

  • پارامترها:

    • id: شناسه رکورد برای بازیابی.

  • all(cls, order_by)

  • توضیح: تمام رکوردها را از جدول بازیابی کرده و آن‌ها را مرتب می‌کند.

  • پارامترها: ندارد

  • filter(cls, **kwargs)

  • توضیح: رکوردهایی که با معیارهای مشخص شده تطابق دارند را بازیابی می‌کند.
  • پارامترها:
    • **kwargs: معیارهای فیلتر برای رکوردها.

2. MySQLModel

کلاس MySQLModel مشابه SQLiteModel است، اما برای پایگاه داده‌های MySQL طراحی شده است. این کلاس همان متدها را دارد که SQLiteModel ارائه می‌دهد، اما با پایگاه داده MySQL ارتباط برقرار می‌کند.

متدها

متدهای MySQLModel و PostgreSQLModel مشابه متدهای SQLiteModel هستند و تفاوت‌ها عمدتاً در نحوه تعامل با پایگاه داده MySQL است.

3. PostgreSQLModel

کلاس PostgreSQLModel مشابه SQLiteModel است، اما برای پایگاه داده‌های PostgreSQL طراحی شده است. این کلاس همان متدها را دارد که SQLiteModel ارائه می‌دهد، اما با پایگاه داده PostgreSQL ارتباط برقرار می‌کند.

متدها

متدهای MySQLModel و PostgreSQLModel مشابه متدهای SQLiteModel هستند و تفاوت‌ها عمدتاً در نحوه تعامل با پایگاه داده PostgreSQL است.

فیلدها

1. CharField

  • توضیح: نمایانگر یک فیلد متنی با طول حداکثر مشخص است.
  • پارامترها:
  • max_length: حداکثر تعداد کاراکترهای مجاز.
  • unique: آیا فیلد باید مقادیر یکتایی داشته باشد.
  • null: آیا فیلد می‌تواند NULL باشد.
  • default: مقدار پیش‌فرض در صورت عدم ارائه مقدار.

2. DateTimeField

  • توضیح: نمایانگر یک مقدار تاریخ و زمان است.
  • پارامترها:
  • auto_now: به طور خودکار تاریخ و زمان جاری را در بروزرسانی‌ها تنظیم می‌کند.

3. ForeignKey

  • توضیح: نمایانگر یک رابطه بسیاری به یک بین مدل‌ها است.
  • پارامترها:
  • to: مدلی که این فیلد به آن اشاره دارد.
  • on_delete: رفتار زمانی که رکورد مرجع حذف می‌شود.

4. BooleanField

  • توضیح: نمایانگر یک مقدار بولی است.
  • پارامترها:
  • default: مقدار پیش‌فرض در صورت عدم ارائه مقدار.
  • null: آیا فیلد می‌تواند NULL باشد.

5. IntegerField

  • توضیح: نمایانگر یک مقدار صحیح است.
  • پارامترها:
  • default: مقدار پیش‌فرض در صورت عدم ارائه مقدار.
  • null: آیا فیلد می‌تواند NULL باشد.

6. FloatField

  • توضیح: نمایانگر یک عدد اعشاری است.
  • پارامترها:
  • default: مقدار پیش‌فرض در صورت عدم ارائه مقدار.
  • null: آیا فیلد می‌تواند NULL باشد.

7. EmailField

  • توضیح: نمایانگر یک آدرس ایمیل است.
  • پارامترها:
  • max_length: حداکثر تعداد کاراکترهای مجاز.
  • unique: آیا فیلد باید مقادیر یکتایی داشته باشد.

8. URLField

  • توضیح: نمایانگر یک URL است.
  • پارامترها:
  • max_length: حداکثر تعداد کاراکترهای مجاز.

9. TextField

  • توضیح: نمایانگر یک فیلد متنی بزرگ برای ذخیره متن‌های طولانی است.
  • پارامترها:
  • null: آیا فیلد می‌تواند NULL باشد.

10. DecimalField

  • توضیح: نمایانگر یک عدد اعشاری با دقت ثابت است.
  • پارامترها:
  • max_digits: حداکثر تعداد ارقام مجاز.
  • decimal_places: تعداد ارقام اعشاری ذخیره شده.
  • default: مقدار پیش‌فرض در صورت عدم ارائه مقدار.

متدهای کوئری

1. create(cls, **kwargs)

  • توضیح: یک رکورد جدید با داده‌های مشخص شده ایجاد می‌کند.
  • پارامترها:
  • **kwargs: داده‌ها برای رکورد جدید.

2. update(cls, id, **kwargs)

  • توضیح: یک رکورد موجود را با داده‌های جدید بروزرسانی می‌کند.
  • پارامترها:
  • id: شناسه رکورد برای بروزرسانی.
  • **kwargs: داده‌های جدید برای رکورد.

3. delete(cls, id)

  • توضیح: یک رکورد را با استفاده از شناسه آن حذف می‌کند.
  • پارامترها:
  • id: شناسه رکورد برای حذف.

خلاصه

این مرجع API یک مرور کلی از کلاس‌ها، متدها و فیلدهای اصلی موجود در AbarORM ارائه می‌دهد. برای مثال‌ها و موارد استفاده دقیق‌تر، به بخش استفاده پایه مراجعه کنید.

اگر سوالی دارید یا نیاز به کمک بیشتری دارید، لطفاً به مستندات مراجعه کرده یا از طریق مخزن GitHub با جامعه ارتباط برقرار کنید.

کدنویسی خوش بگذرد با AbarORM!