در صورتی که فایل پایگاه داده تاکنون ساخته نشده آن را در آدرس db_path می‌سازد. نمونه db_path که به پوشه databases و پایگاه first.sqlite3 اشاره می‌کند (پوشه databases از قبل باید وجود داشته باشد):

db_path = r'databases/first.sqlite3''

قرار است مسیر تعریف ‍table و نام ‌آن را دریافت کند و جدول را در پایگاه داده بسازد. نحوه تعریف جدول در پایگاه داده به صورت زیر است.

# path : tables/users.py

from sqlalchemy import Integer, Column, String
from sqlalchemy.ext.declarative import declarative_base

Base = declarative_base()


class User(Base):
    __tablename__ = 'user'
    name = Column(String, primary_key=True)
    family = Column(String, primary_key=True)
    likes = Column(Integer)

    order_fields = ['name', 'family']

    def to_json(self):
        return {
            'name': self.name,
            'family': self.family,
            'likes': self.likes
        }

در این صورت تابع را به صورت ‍‍create_table('tables.user', 'User') صدا می‌زنیم. در صورت موجود بودن جدول در پایگاه داده، باید استثنای TableExistsException را raise کنید.

مقدار جدید را می‌گیرد و در جدول مربوطه ذخیره می‌کند. نحوه صدا زدن این تابع به صورت

add_value('tables.user', 'User', name='mahdi', family='shokri', likes=3)

است. در صورت موجود بودن مقدار از قبل در جدول باید استثنای ValueExistException و در صورت هرگونه مشکل دیگر باید استثنای AddValueException را raise‍ کنیم.

مقادیر جدید را می‌گیرد و در جدول مربوطه ذخیره می‌کند. نحوه صدا زدن این تابع به صورت

add_values('tables.user', 'User', [{'name': 'mahdi', 'likes': 3, 'family': 'shokri' }])

است. به ازای هر مورد در آرایه آن را به جدول اضافه می‌کند. توجه کنید که یا همه موارد اضافه شوند یا در صورت هرگونه مشکل برای هرکدام از موارد آرایه، باید استثنا AddValuesException را raise کنیم و پایگاه داده را به حالت قبل از این دستور، rollback کنیم.

مقداری را می‌گیرد و بر اساس آرگومان‌ها موارد را فیلتر و حذف می‌کند. مثلا

add_value('tables.user', 'User', name='mahdi')

تمام افرادی که نامشان mahdi است را حذف می‌کند. در صورت نبودن سطری برای حذف شدن در جدول یا هرگونه مشکل دیگر باید استثنای RemoveValueException را raise کند.

آرایه‌ای از فیلتر‌ها می‌گیرد و به ازای هر کدام از فیلتر‌ها، موارد مربوط به آن فیلتر را که در جدول مطابقت دارند حذف می‌کند.

add_value('tables.user', 'User', [{'name': 'mahdi'}, {family': 'mohammadi'}])

به ازای هر کدام از موارد در آرایه حداقل باید یک سطر برای حذف‌شدن وجود داشته باشد در غیر این صورت استثنای RemoveValuesException بازگردانده شود.

مقادیر فیلتر را دریافت می‌کند و نتیجه‌ای را به صورت ‍‍json باز می‌گرداند. مثلا اگر تابع

get_values('tables.user', 'User', name='mahdi')

را صدا بزنیم تمام سطر‌های جدول که name در آن‌ها mahdi باشد را برمی‌گرداند. توجه کنید که ترتیب موارد در خروجی json باید بر اساس order_fields در تعریف جدول (در اینجا User) باشد.

[
  {
     'name': 'mahdi',
     'family': 'shokri',
     'likes': 4
  },
  {
     'name': 'mahdi',
     'family': 'sorkhi',
     'likes': 2
  }
]

توجه: هر جدولی که برای تست به شما کد شما داده شود، حتما دارای تابع to_json() است و نیازی نیست شما آن را تبدیل به json کنید.