diff --git a/.gitignore b/.gitignore deleted file mode 100644 index eb896ba..0000000 --- a/.gitignore +++ /dev/null @@ -1,3 +0,0 @@ -.venv -site -/site \ No newline at end of file diff --git a/404.html b/404.html new file mode 100644 index 0000000..f521d03 --- /dev/null +++ b/404.html @@ -0,0 +1,1293 @@ + + + +
+ + + + + + + + + + + + + + + + +AbarORM یک کتابخانه سبک و آسان برای استفاده از نگاشت شیء-رابطهای (ORM) است که برای پایگاهدادههای SQLite و PostgreSQL در پایتون طراحی شده است. این کتابخانه یک رابط ساده و شهودی برای مدیریت مدلهای پایگاهداده و تعاملات فراهم میکند و کار را برای توسعهدهندگان آسانتر میکند تا بدون نیاز به نوشتن پرسشهای SQL خام، با پایگاهدادهها کار کنند.
+اگر با Django ORM آشنا هستید، رویکرد AbarORM در مدلسازی پایگاهداده و تعاملات بسیار آشنا خواهد بود. AbarORM بسیاری از اصول و الگوهای مشابهی که در Django ORM وجود دارد را دنبال میکند، مانند:
+CharField
، DateTimeField
، ForeignKey
) استفاده میکند که باعث میشود کاربران Django به راحتی به AbarORM منتقل شوند.AbarORM هدف دارد تا پیچیدگیهای مربوط به تعاملات پایگاهداده را کاهش دهد. با انتزاع جزئیات پرسشهای SQL و مدیریت پایگاهداده، این امکان را فراهم میآورد که توسعهدهندگان بیشتر بر روی نوشتن منطق برنامه تمرکز کنند تا مواجهه با جزئیات پایگاهداده.
+در حالی که AbarORM سبک است، اما به اندازه کافی انعطافپذیر است تا نیازهای مختلفی را پوشش دهد. چه در حال کار بر روی یک پروژه شخصی کوچک باشید یا یک برنامه پیچیدهتر، AbarORM میتواند به نیازهای شما سازگار شود.
+این کتابخانه اصول پایتونیک را دنبال میکند و ادغام بینقصی با ساختارهای داده پایتون و ویژگیهای شیءگرا ارائه میدهد. این رویکرد اطمینان حاصل میکند که کار کردن با پایگاهداده شما طبیعی و شهودی باشد.
+برای شروع کار با AbarORM، مراحل زیر را دنبال کنید:
+Installation:
+کتابخانه را از طریق pip نصب کنید:
+ +برای پشتیبانی از MySQL، شما همچنین نیاز به نصب mysql-connector-python
دارید: (ضروری)
psycopg2-binary
را نصب کنید: (ضروری)
+
+تنظیم: اتصال پایگاهداده خود را پیکربندی کرده و مدلهای خود را با ارثبری از SQLiteModel
، MySQLModel
یا PostgreSQLModel
بسته به نوع پایگاهداده خود تعریف کنید.
تعریف مدلها: کلاسهای پایتون ایجاد کنید که نمایانگر جداول پایگاهداده شما باشند. از انواع فیلدهای داخلی برای تعریف ویژگیهای هر مدل استفاده کنید.
+انجام عملیات: از متدهای ارائهشده توسط AbarORM برای انجام عملیات CRUD، مدیریت روابط و پرسش دادهها استفاده کنید.
+برای دستورالعملها و مثالهای دقیقتر، به بخش استفاده پایه مستندات مراجعه کنید.
+پیکربندی هر پایگاهداده متفاوت است، اما سادهترین پیکربندی موجود برای sqlite است که میتوان آن را فقط با نام پایگاهداده متصل کرد.
+مدلها به طور خودکار توسط AbarORM مدیریت میشوند، یعنی هرگونه تغییر در مدلهای شما مانند افزودن فیلدهای جدید به طور خودکار به پایگاهداده اعمال میشود بدون نیاز به مراحل مهاجرت دستی. این ویژگی توسعه را تسهیل کرده و بار اضافی مرتبط با تغییرات طرح را کاهش میدهد.
+ + + + + + + + + + + + + + + + +AbarORM is a lightweight and easy-to-use Object-Relational Mapping (ORM) library designed for SQLite and PostgreSQL databases in Python. It provides a simple and intuitive interface for managing database models and interactions, making it easier for developers to work with databases without needing to write raw SQL queries.
+If you're familiar with Django ORM, you'll find AbarORM's approach to database modeling and interactions quite familiar. AbarORM follows many of the same principles and patterns found in Django ORM, such as:
+CharField
, DateTimeField
, ForeignKey
), making it easy for Django users to adapt to AbarORM.AbarORM aims to reduce the complexity associated with database interactions. By abstracting away the details of SQL queries and database management, it allows developers to focus more on writing application logic rather than dealing with database intricacies.
+While it is lightweight, AbarORM is flexible enough to handle various use cases. Whether you're working on a small personal project or a more complex application, AbarORM can adapt to your needs.
+The library follows Pythonic principles, offering a seamless integration with Python's data structures and object-oriented features. This approach ensures that working with your database feels natural and intuitive.
+To get started with AbarORM, follow these steps:
+Installation: +To get started with AbarORM, follow these steps:
+Install the library via pip: +
+For MySQL support, you also need to installmysql-connector-python
: (Required)
+
+For PostgreSQL support, install psycopg2-binary
: (Required)
+
+Setup: Configure your database connection and define your models by inheriting from SQLiteModel
, MySQLModel
or PostgreSQLModel
depending on your database type.
Define Models: Create Python classes that represent your database tables. Use built-in field types to define the attributes of each model.
+Perform Operations: Use the methods provided by AbarORM to perform CRUD operations, manage relationships, and query your data.
+For detailed instructions and examples, refer to the Basic Usage section of the documentation.
+The configuration of each database is different, but the simplest available configuration is for sqlite, which can be connected to it simply with a database name.
+Models are automatically managed by AbarORM, which means that any changes to your models, such as adding new fields, are automatically applied to the database without the need for manual migration steps. This feature streamlines development by reducing the overhead associated with schema changes.
+ + + + + + + + + + + + + + + + +این صفحه یک مرجع دقیق برای کلاسها و متدهای موجود در کتابخانه AbarORM فراهم میکند. این مرجع برای توسعهدهندگانی است که نیاز به درک کاملی از نحوه استفاده از ویژگیهای AbarORM دارند.
+SQLiteModel
¶کلاس SQLiteModel
کلاس پایهای برای تعریف مدلهایی است که با پایگاه داده SQLite ارتباط دارند.
class Meta:
پارامترها:
+db_config
: دیکشنری حاوی پیکربندی پایگاه داده.**kwargs
: آرگومانهای اضافی.save(self)
پارامترها: ندارد
+delete(self)
پارامترها: ندارد
+get(cls, id)
پارامترها:
+id
: شناسه رکورد برای بازیابی.all(cls, order_by)
پارامترها: ندارد
+filter(cls, **kwargs)
**kwargs
: معیارهای فیلتر برای رکوردها.MySQLModel
¶کلاس MySQLModel
مشابه SQLiteModel
است، اما برای پایگاه دادههای MySQL طراحی شده است. این کلاس همان متدها را دارد که SQLiteModel
ارائه میدهد، اما با پایگاه داده MySQL ارتباط برقرار میکند.
متدهای MySQLModel
و PostgreSQLModel
مشابه متدهای SQLiteModel
هستند و تفاوتها عمدتاً در نحوه تعامل با پایگاه داده MySQL است.
PostgreSQLModel
¶کلاس PostgreSQLModel
مشابه SQLiteModel
است، اما برای پایگاه دادههای PostgreSQL طراحی شده است. این کلاس همان متدها را دارد که SQLiteModel
ارائه میدهد، اما با پایگاه داده PostgreSQL ارتباط برقرار میکند.
متدهای MySQLModel
و PostgreSQLModel
مشابه متدهای SQLiteModel
هستند و تفاوتها عمدتاً در نحوه تعامل با پایگاه داده PostgreSQL است.
CharField
¶max_length
: حداکثر تعداد کاراکترهای مجاز.unique
: آیا فیلد باید مقادیر یکتایی داشته باشد.null
: آیا فیلد میتواند NULL
باشد.default
: مقدار پیشفرض در صورت عدم ارائه مقدار.DateTimeField
¶auto_now
: به طور خودکار تاریخ و زمان جاری را در بروزرسانیها تنظیم میکند.ForeignKey
¶to
: مدلی که این فیلد به آن اشاره دارد.on_delete
: رفتار زمانی که رکورد مرجع حذف میشود.BooleanField
¶default
: مقدار پیشفرض در صورت عدم ارائه مقدار.null
: آیا فیلد میتواند NULL
باشد.IntegerField
¶default
: مقدار پیشفرض در صورت عدم ارائه مقدار.null
: آیا فیلد میتواند NULL
باشد.FloatField
¶default
: مقدار پیشفرض در صورت عدم ارائه مقدار.null
: آیا فیلد میتواند NULL
باشد.EmailField
¶max_length
: حداکثر تعداد کاراکترهای مجاز.unique
: آیا فیلد باید مقادیر یکتایی داشته باشد.URLField
¶max_length
: حداکثر تعداد کاراکترهای مجاز.TextField
¶null
: آیا فیلد میتواند NULL
باشد.DecimalField
¶max_digits
: حداکثر تعداد ارقام مجاز.decimal_places
: تعداد ارقام اعشاری ذخیره شده.default
: مقدار پیشفرض در صورت عدم ارائه مقدار.create(cls, **kwargs)
¶**kwargs
: دادهها برای رکورد جدید.update(cls, id, **kwargs)
¶id
: شناسه رکورد برای بروزرسانی.**kwargs
: دادههای جدید برای رکورد.delete(cls, id)
¶id
: شناسه رکورد برای حذف.این مرجع API یک مرور کلی از کلاسها، متدها و فیلدهای اصلی موجود در AbarORM ارائه میدهد. برای مثالها و موارد استفاده دقیقتر، به بخش استفاده پایه مراجعه کنید.
+اگر سوالی دارید یا نیاز به کمک بیشتری دارید، لطفاً به مستندات مراجعه کرده یا از طریق مخزن GitHub با جامعه ارتباط برقرار کنید.
+کدنویسی خوش بگذرد با AbarORM!
+ + + + + + + + + + + + + + + + +This page provides a detailed reference for the classes and methods available in the AbarORM library. The API reference is intended for developers who need a comprehensive understanding of how to use AbarORM's features.
+SQLiteModel
¶The SQLiteModel
class is the base class for defining models that interact with an SQLite database.
class Meta:
Parameters:
+db_config
: Dictionary containing the database configuration.**kwargs
: Additional keyword arguments.save(self)
Parameters: None
+delete(self)
Parameters: None
+get(cls, id)
Parameters:
+id
: The ID of the record to retrieve.all(cls, order_by)
Parameters: None
+filter(cls, **kwargs)
**kwargs
: Criteria for filtering records.MySQLModel
¶The MySQLModel
class is similar to SQLiteModel
but designed for MySQL databases. It provides the same methods as SQLiteModel
but interacts with MySQL instead.
The methods for MySQLModel
and PostgreSQLModel
are identical to those for SQLiteModel
, with differences primarily in how they interact with the MySQL database.
PostgreSQLModel
¶The PostgreSQLModel
class is similar to SQLiteModel
but designed for Postgresql databases. It provides the same methods as SQLiteModel
but interacts with Postgresql instead.
The methods for MySQLModel
and PostgreSQLModel
are identical to those for SQLiteModel
, with differences primarily in how they interact with the MySQL database.
CharField
¶max_length
: Maximum number of characters allowed.unique
: Whether the field must contain unique values.null
: Whether the field can be NULL
.default
: Default value if none is provided.DateTimeField
¶auto_now
: Automatically set to the current date and time on updates.ForeignKey
¶to
: The model this field points to.on_delete
: Behavior when the referenced record is deleted.BooleanField
¶default
: Default value if none is provided.null
: Whether the field can be NULL
.IntegerField
¶default
: Default value if none is provided.null
: Whether the field can be NULL
.FloatField
¶default
: Default value if none is provided.null
: Whether the field can be NULL
.EmailField
¶max_length
: Maximum number of characters allowed.unique
: Whether the field must contain unique values.URLField
¶max_length
: Maximum number of characters allowed.TextField
¶null
: Whether the field can be NULL
.DecimalField
¶max_digits
: Maximum number of digits allowed.decimal_places
: Number of decimal places to store.default
: Default value if none is provided.create(cls, **kwargs)
¶**kwargs
: Data for the new record.update(cls, id, **kwargs)
¶id
: ID of the record to update.**kwargs
: New data for the record.delete(cls, id)
¶id
: ID of the record to delete.This API reference provides an overview of the core classes, methods, and fields available in AbarORM. For more detailed examples and use cases, refer to the Basic Usage section.
+If you have any questions or need further assistance, please check the Documentation or reach out to the community via our GitHub repository.
+Happy coding with AbarORM!
+ + + + + + + + + + + + + + + + +