モデル一覧

データベース用 モデル

データベースのテーブルに対応するモデルです。 SQLModelを継承して定義されており、データベースのCRUD操作に使用されます。

基本各モデルは以下の形で定義されます。

• Base: 基本的なモデルクラス
• Main: テーブル定義用のクラス （DB操作時に使用）
• Create: 新規作成用のモデルクラス
• Read: 読み取り用のモデルクラス
• Update: 更新用のモデルクラス

この設計は、データの整合性と操作の明確化を目的としています。

src.models.task

新しいTaskモデルの定義

Task

Bases: TaskBase

新しいタスクモデル

タスクの情報をデータベースに保存するためのモデルクラス。SQLModelを使用してデータベースと連携します。

属性：

名前	タイプ	デスクリプション
id	UUID | None	タスクのID。デフォルトはNoneで、データベースに保存時に自動生成されます。
project_id	UUID | None	タスクが属するプロジェクトのID。プロジェクトに属さないタスクの場合はNone。
parent_id	UUID | None	親タスクのID。サブタスクの場合に使用。
title	str	タスクのタイトル。インデックスが設定されており、検索に使用されます。
description	str	タスクの詳細説明。デフォルトは空文字列。
status	TaskStatus	タスクのステータス。デフォルトはINBOX。
due_date	date | None	タスクの締め切り日。設定されていない場合はNone。

Source code in src/models/task.py

class Task(TaskBase, table=True):
    """新しいタスクモデル

    タスクの情報をデータベースに保存するためのモデルクラス。SQLModelを使用してデータベースと連携します。

    Attributes:
        id (uuid.UUID | None): タスクのID。デフォルトはNoneで、データベースに保存時に自動生成されます。
        project_id (uuid.UUID | None): タスクが属するプロジェクトのID。プロジェクトに属さないタスクの場合はNone。
        parent_id (uuid.UUID | None): 親タスクのID。サブタスクの場合に使用。
        title (str): タスクのタイトル。インデックスが設定されており、検索に使用されます。
        description (str): タスクの詳細説明。デフォルトは空文字列。
        status (TaskStatus): タスクのステータス。デフォルトはINBOX。
        due_date (date | None): タスクの締め切り日。設定されていない場合はNone。
    """

    id: uuid.UUID | None = Field(default_factory=uuid.uuid4, primary_key=True)

TaskBase

Bases: SQLModel

タスクの基本モデル

タスクの基本情報を定義するモデルクラス。SQLModelを使用してデータベースと連携します。

属性：

名前	タイプ	デスクリプション
project_id	UUID | None	タスクが属するプロジェクトのID。プロジェクトに属さないタスクの場合はNone。
parent_id	UUID | None	親タスクのID。サブタスクの場合に使用。
title	str	タスクのタイトル。インデックスが設定されており、検索に使用されます。
description	str	タスクの詳細説明。デフォルトは空文字列。
status	TaskStatus	タスクのステータス。デフォルトはINBOX。
due_date	date | None	タスクの締め切り日。設定されていない場合はNone。

Source code in src/models/task.py

class TaskBase(SQLModel):
    """タスクの基本モデル

    タスクの基本情報を定義するモデルクラス。SQLModelを使用してデータベースと連携します。

    Attributes:
        project_id (uuid.UUID | None): タスクが属するプロジェクトのID。プロジェクトに属さないタスクの場合はNone。
        parent_id (uuid.UUID | None): 親タスクのID。サブタスクの場合に使用。
        title (str): タスクのタイトル。インデックスが設定されており、検索に使用されます。
        description (str): タスクの詳細説明。デフォルトは空文字列。
        status (TaskStatus): タスクのステータス。デフォルトはINBOX。
        due_date (date | None): タスクの締め切り日。設定されていない場合はNone。
    """

    project_id: uuid.UUID | None = Field(default=None, foreign_key="project.id", index=True)
    parent_id: uuid.UUID | None = Field(default=None, foreign_key="task.id", index=True)
    title: str = Field(index=True)
    description: str = Field(default="")
    status: TaskStatus = Field(default=TaskStatus.INBOX, index=True)
    due_date: date | None = Field(default=None, index=True)

TaskCreate

Bases: TaskBase

新しいタスク作成用モデル

タスクを新規作成する際に使用するモデルクラス。SQLModelを使用してデータベースと連携します。

属性：

名前	タイプ	デスクリプション
project_id	UUID | None	タスクが属するプロジェクトのID。プロジェクトに属さないタスクの場合はNone。
parent_id	UUID | None	親タスクのID。サブタスクの場合に使用。
title	str	タスクのタイトル。インデックスが設定されており、検索に使用されます。
description	str	タスクの詳細説明。デフォルトは空文字列。
status	TaskStatus	タスクのステータス。デフォルトはINBOX。
due_date	date | None	タスクの締め切り日。設定されていない場合はNone。

Source code in src/models/task.py

class TaskCreate(TaskBase):
    """新しいタスク作成用モデル

    タスクを新規作成する際に使用するモデルクラス。SQLModelを使用してデータベースと連携します。

    Attributes:
        project_id (uuid.UUID | None): タスクが属するプロジェクトのID。プロジェクトに属さないタスクの場合はNone。
        parent_id (uuid.UUID | None): 親タスクのID。サブタスクの場合に使用。
        title (str): タスクのタイトル。インデックスが設定されており、検索に使用されます。
        description (str): タスクの詳細説明。デフォルトは空文字列。
        status (TaskStatus): タスクのステータス。デフォルトはINBOX。
        due_date (date | None): タスクの締め切り日。設定されていない場合はNone。
    """

TaskRead

Bases: TaskBase

新しいタスク読み取り用モデル

タスクの情報を読み取る際に使用するモデルクラス。SQLModelを使用してデータベースと連携します。

属性：

名前	タイプ	デスクリプション
id	UUID	タスクのID。
project_id	UUID | None	タスクが属するプロジェクトのID。プロジェクトに属さないタスクの場合はNone。
parent_id	UUID | None	親タスクのID。サブタスクの場合に使用。
title	str	タスクのタイトル。インデックスが設定されており、検索に使用されます。
description	str	タスクの詳細説明。デフォルトは空文字列。
status	TaskStatus	タスクのステータス。デフォルトはINBOX。
due_date	date | None	タスクの締め切り日。設定されていない場合はNone。

Source code in src/models/task.py

class TaskRead(TaskBase):
    """新しいタスク読み取り用モデル

    タスクの情報を読み取る際に使用するモデルクラス。SQLModelを使用してデータベースと連携します。

    Attributes:
        id (uuid.UUID): タスクのID。
        project_id (uuid.UUID | None): タスクが属するプロジェクトのID。プロジェクトに属さないタスクの場合はNone。
        parent_id (uuid.UUID | None): 親タスクのID。サブタスクの場合に使用。
        title (str): タスクのタイトル。インデックスが設定されており、検索に使用されます。
        description (str): タスクの詳細説明。デフォルトは空文字列。
        status (TaskStatus): タスクのステータス。デフォルトはINBOX。
        due_date (date | None): タスクの締め切り日。設定されていない場合はNone。
    """

    id: uuid.UUID

TaskStatus

Bases: str, Enum

タスクのステータス（GTDシステムに基づく）

Source code in src/models/task.py

class TaskStatus(str, Enum):
    """タスクのステータス（GTDシステムに基づく）"""

    INBOX = "inbox"
    NEXT_ACTION = "next_action"
    WAITING_FOR = "waiting_for"
    SOMEDAY_MAYBE = "someday_maybe"
    DELEGATED = "delegated"
    COMPLETED = "completed"
    CANCELLED = "cancelled"

TaskUpdate

Bases: SQLModel

新しいタスク更新用モデル

タスクの情報を更新する際に使用するモデルクラス。SQLModelを使用してデータベースと連携します。

属性：

名前	タイプ	デスクリプション
project_id	UUID | None	タスクが属するプロジェクトのID。Noneの場合は更新しない。
parent_id	UUID | None	親タスクのID。Noneの場合は更新しない。
title	str | None	タスクのタイトル。Noneの場合は更新しない。
description	str | None	タスクの詳細説明。Noneの場合は更新しない。
status	TaskStatus | None	タスクのステータス。Noneの場合は更新しない。
due_date	date | None	タスクの締め切り日。Noneの場合は更新しない。

Source code in src/models/task.py

class TaskUpdate(SQLModel):
    """新しいタスク更新用モデル

    タスクの情報を更新する際に使用するモデルクラス。SQLModelを使用してデータベースと連携します。

    Attributes:
        project_id (uuid.UUID | None): タスクが属するプロジェクトのID。Noneの場合は更新しない。
        parent_id (uuid.UUID | None): 親タスクのID。Noneの場合は更新しない。
        title (str | None): タスクのタイトル。Noneの場合は更新しない。
        description (str | None): タスクの詳細説明。Noneの場合は更新しない。
        status (TaskStatus | None): タスクのステータス。Noneの場合は更新しない。
        due_date (date | None): タスクの締め切り日。Noneの場合は更新しない。
    """

    project_id: uuid.UUID | None = None
    parent_id: uuid.UUID | None = None
    title: str | None = None
    description: str | None = None
    status: TaskStatus | None = None
    due_date: date | None = None

src.models.project

Projectモデルの定義

Project

Bases: ProjectBase

プロジェクトモデル

プロジェクトの情報をデータベースに保存するためのモデルクラス。SQLModelを使用してデータベースと連携します。

属性：

名前	タイプ	デスクリプション
id	UUID | None	プロジェクトのID。デフォルトはNoneで、データベースに保存時に自動生成されます。
title	str	プロジェクト名。インデックスが設定されており、検索に使用されます。
description	str	プロジェクトの説明。デフォルトは空文字列。
status	ProjectStatus	プロジェクトのステータス。デフォルトはACTIVE。

Source code in src/models/project.py

class Project(ProjectBase, table=True):
    """プロジェクトモデル

    プロジェクトの情報をデータベースに保存するためのモデルクラス。SQLModelを使用してデータベースと連携します。

    Attributes:
        id (uuid.UUID | None): プロジェクトのID。デフォルトはNoneで、データベースに保存時に自動生成されます。
        title (str): プロジェクト名。インデックスが設定されており、検索に使用されます。
        description (str): プロジェクトの説明。デフォルトは空文字列。
        status (ProjectStatus): プロジェクトのステータス。デフォルトはACTIVE。
    """

    id: uuid.UUID | None = Field(default_factory=uuid.uuid4, primary_key=True)

ProjectBase

Bases: SQLModel

プロジェクトの基本モデル

プロジェクトの基本情報を定義するモデルクラス。SQLModelを使用してデータベースと連携します。

属性：

名前	タイプ	デスクリプション
title	str	プロジェクト名。インデックスが設定されており、検索に使用されます。
description	str	プロジェクトの説明。デフォルトは空文字列。
status	ProjectStatus	プロジェクトのステータス。デフォルトはACTIVE。

Source code in src/models/project.py

class ProjectBase(SQLModel):
    """プロジェクトの基本モデル

    プロジェクトの基本情報を定義するモデルクラス。SQLModelを使用してデータベースと連携します。

    Attributes:
        title (str): プロジェクト名。インデックスが設定されており、検索に使用されます。
        description (str): プロジェクトの説明。デフォルトは空文字列。
        status (ProjectStatus): プロジェクトのステータス。デフォルトはACTIVE。
    """

    title: str = Field(index=True)
    description: str = Field(default="")
    status: ProjectStatus = Field(default=ProjectStatus.ACTIVE, index=True)

ProjectCreate

Bases: ProjectBase

プロジェクト作成用モデル

プロジェクトを新規作成する際に使用するモデルクラス。SQLModelを使用してデータベースと連携します。

属性：

名前	タイプ	デスクリプション
title	str	プロジェクト名。インデックスが設定されており、検索に使用されます。
description	str	プロジェクトの説明。デフォルトは空文字列。
status	ProjectStatus	プロジェクトのステータス。デフォルトはACTIVE。

Source code in src/models/project.py

class ProjectCreate(ProjectBase):
    """プロジェクト作成用モデル

    プロジェクトを新規作成する際に使用するモデルクラス。SQLModelを使用してデータベースと連携します。

    Attributes:
        title (str): プロジェクト名。インデックスが設定されており、検索に使用されます。
        description (str): プロジェクトの説明。デフォルトは空文字列。
        status (ProjectStatus): プロジェクトのステータス。デフォルトはACTIVE。
    """

ProjectRead

Bases: ProjectBase

プロジェクト読み取り用モデル

プロジェクトの情報を読み取る際に使用するモデルクラス。SQLModelを使用してデータベースと連携します。

属性：

名前	タイプ	デスクリプション
id	UUID	プロジェクトのID。
title	str	プロジェクト名。インデックスが設定されており、検索に使用されます。
description	str	プロジェクトの説明。デフォルトは空文字列。
status	ProjectStatus	プロジェクトのステータス。デフォルトはACTIVE。

Source code in src/models/project.py

class ProjectRead(ProjectBase):
    """プロジェクト読み取り用モデル

    プロジェクトの情報を読み取る際に使用するモデルクラス。SQLModelを使用してデータベースと連携します。

    Attributes:
        id (uuid.UUID): プロジェクトのID。
        title (str): プロジェクト名。インデックスが設定されており、検索に使用されます。
        description (str): プロジェクトの説明。デフォルトは空文字列。
        status (ProjectStatus): プロジェクトのステータス。デフォルトはACTIVE。
    """

    id: uuid.UUID

ProjectStatus

Bases: str, Enum

プロジェクトのステータス

Source code in src/models/project.py

class ProjectStatus(str, Enum):
    """プロジェクトのステータス"""

    ACTIVE = "active"
    ON_HOLD = "on_hold"
    COMPLETED = "completed"
    CANCELLED = "cancelled"

ProjectUpdate

Bases: SQLModel

プロジェクト更新用モデル

プロジェクトの情報を更新する際に使用するモデルクラス。SQLModelを使用してデータベースと連携します。

属性：

名前	タイプ	デスクリプション
title	str | None	プロジェクト名。Noneの場合は更新しない。
description	str | None	プロジェクトの説明。Noneの場合は更新しない。
status	ProjectStatus | None	プロジェクトのステータス。Noneの場合は更新しない。

Source code in src/models/project.py

class ProjectUpdate(SQLModel):
    """プロジェクト更新用モデル

    プロジェクトの情報を更新する際に使用するモデルクラス。SQLModelを使用してデータベースと連携します。

    Attributes:
        title (str | None): プロジェクト名。Noneの場合は更新しない。
        description (str | None): プロジェクトの説明。Noneの場合は更新しない。
        status (ProjectStatus | None): プロジェクトのステータス。Noneの場合は更新しない。
    """

    title: str | None = None
    description: str | None = None
    status: ProjectStatus | None = None

src.models.tag

Tagモデルの定義

Tag

Bases: TagBase

タグモデル

タグの情報をデータベースに保存するためのモデルクラス。SQLModelを使用してデータベースと連携します。

属性：

名前	タイプ	デスクリプション
id	UUID | None	タグのID。デフォルトはNoneで、データベースに保存時に自動生成されます。
name	str	タグ名（例: @PC, #重要）。インデックスが設定されており、検索に使用されます。

Source code in src/models/tag.py

class Tag(TagBase, table=True):
    """タグモデル

    タグの情報をデータベースに保存するためのモデルクラス。SQLModelを使用してデータベースと連携します。

    Attributes:
        id (uuid.UUID | None): タグのID。デフォルトはNoneで、データベースに保存時に自動生成されます。
        name (str): タグ名（例: @PC, #重要）。インデックスが設定されており、検索に使用されます。
    """

    id: uuid.UUID | None = Field(default_factory=uuid.uuid4, primary_key=True)

TagBase

Bases: SQLModel

タグの基本モデル

タグの基本情報を定義するモデルクラス。SQLModelを使用してデータベースと連携します。

属性：

名前	タイプ	デスクリプション
name	str	タグ名（例: @PC, #重要）。インデックスが設定されており、検索に使用されます。

Source code in src/models/tag.py

class TagBase(SQLModel):
    """タグの基本モデル

    タグの基本情報を定義するモデルクラス。SQLModelを使用してデータベースと連携します。

    Attributes:
        name (str): タグ名（例: @PC, #重要）。インデックスが設定されており、検索に使用されます。
    """

    name: str = Field(index=True)

TagCreate

Bases: TagBase

タグ作成用モデル

タグを新規作成する際に使用するモデルクラス。SQLModelを使用してデータベースと連携します。

属性：

名前	タイプ	デスクリプション
name	str	タグ名（例: @PC, #重要）。インデックスが設定されており、検索に使用されます。

Source code in src/models/tag.py

class TagCreate(TagBase):
    """タグ作成用モデル

    タグを新規作成する際に使用するモデルクラス。SQLModelを使用してデータベースと連携します。

    Attributes:
        name (str): タグ名（例: @PC, #重要）。インデックスが設定されており、検索に使用されます。
    """

TagRead

Bases: TagBase

タグ読み取り用モデル

タグの情報を読み取る際に使用するモデルクラス。SQLModelを使用してデータベースと連携します。

属性：

名前	タイプ	デスクリプション
id	UUID	タグのID。
name	str	タグ名（例: @PC, #重要）。インデックスが設定されており、検索に使用されます。

Source code in src/models/tag.py

class TagRead(TagBase):
    """タグ読み取り用モデル

    タグの情報を読み取る際に使用するモデルクラス。SQLModelを使用してデータベースと連携します。

    Attributes:
        id (uuid.UUID): タグのID。
        name (str): タグ名（例: @PC, #重要）。インデックスが設定されており、検索に使用されます。
    """

    id: uuid.UUID

TagUpdate

Bases: SQLModel

タグ更新用モデル

タグの情報を更新する際に使用するモデルクラス。SQLModelを使用してデータベースと連携します。

属性：

名前	タイプ	デスクリプション
name	str | None	タグ名。Noneの場合は更新しない。

Source code in src/models/tag.py

class TagUpdate(SQLModel):
    """タグ更新用モデル

    タグの情報を更新する際に使用するモデルクラス。SQLModelを使用してデータベースと連携します。

    Attributes:
        name (str | None): タグ名。Noneの場合は更新しない。
    """

    name: str | None = None

src.models.task_tag

TaskTagモデルの定義（多対多の関連テーブル）

TaskTag

Bases: TaskTagBase

タスクとタグの関連モデル

タスクとタグの多対多関係をデータベースに保存するためのモデルクラス。SQLModelを使用してデータベースと連携します。

属性：

名前	タイプ	デスクリプション
task_id	UUID	タスクのID。複合主キーの一部。
tag_id	UUID	タグのID。複合主キーの一部。

Source code in src/models/task_tag.py

class TaskTag(TaskTagBase, table=True):
    """タスクとタグの関連モデル

    タスクとタグの多対多関係をデータベースに保存するためのモデルクラス。SQLModelを使用してデータベースと連携します。

    Attributes:
        task_id (uuid.UUID): タスクのID。複合主キーの一部。
        tag_id (uuid.UUID): タグのID。複合主キーの一部。
    """

TaskTagBase

Bases: SQLModel

タスクとタグの関連の基本モデル

タスクとタグの多対多関係を定義するモデルクラス。SQLModelを使用してデータベースと連携します。

属性：

名前	タイプ	デスクリプション
task_id	UUID	タスクのID。
tag_id	UUID	タグのID。

Source code in src/models/task_tag.py

class TaskTagBase(SQLModel):
    """タスクとタグの関連の基本モデル

    タスクとタグの多対多関係を定義するモデルクラス。SQLModelを使用してデータベースと連携します。

    Attributes:
        task_id (uuid.UUID): タスクのID。
        tag_id (uuid.UUID): タグのID。
    """

    task_id: uuid.UUID = Field(foreign_key="task.id", primary_key=True)
    tag_id: uuid.UUID = Field(foreign_key="tag.id", primary_key=True)

TaskTagCreate

Bases: TaskTagBase

タスクとタグの関連作成用モデル

タスクとタグの関連を新規作成する際に使用するモデルクラス。SQLModelを使用してデータベースと連携します。

属性：

名前	タイプ	デスクリプション
task_id	UUID	タスクのID。
tag_id	UUID	タグのID。

Source code in src/models/task_tag.py

class TaskTagCreate(TaskTagBase):
    """タスクとタグの関連作成用モデル

    タスクとタグの関連を新規作成する際に使用するモデルクラス。SQLModelを使用してデータベースと連携します。

    Attributes:
        task_id (uuid.UUID): タスクのID。
        tag_id (uuid.UUID): タグのID。
    """

TaskTagRead

Bases: TaskTagBase

タスクとタグの関連読み取り用モデル

タスクとタグの関連情報を読み取る際に使用するモデルクラス。SQLModelを使用してデータベースと連携します。

属性：

名前	タイプ	デスクリプション
task_id	UUID	タスクのID。
tag_id	UUID	タグのID。

Source code in src/models/task_tag.py

class TaskTagRead(TaskTagBase):
    """タスクとタグの関連読み取り用モデル

    タスクとタグの関連情報を読み取る際に使用するモデルクラス。SQLModelを使用してデータベースと連携します。

    Attributes:
        task_id (uuid.UUID): タスクのID。
        tag_id (uuid.UUID): タグのID。
    """

src.models.memo

Memoモデルの定義

Memo

Bases: MemoBase

メモモデル

Source code in src/models/memo.py

class Memo(MemoBase, table=True):
    """メモモデル"""

    id: uuid.UUID = Field(default_factory=uuid.uuid4, primary_key=True)

MemoBase

Bases: SQLModel

メモの基本モデル

Source code in src/models/memo.py

class MemoBase(SQLModel):
    """メモの基本モデル"""

    content: str = Field(default="", description="マークダウン形式のメモ内容")
    task_id: uuid.UUID = Field(foreign_key="task.id", index=True)

MemoCreate

Bases: MemoBase

メモ作成用モデル

Source code in src/models/memo.py

class MemoCreate(MemoBase):
    """メモ作成用モデル"""

MemoRead

Bases: MemoBase

メモ読み取り用モデル

Source code in src/models/memo.py

class MemoRead(MemoBase):
    """メモ読み取り用モデル"""

    id: uuid.UUID

MemoUpdate

Bases: SQLModel

メモ更新用モデル

Source code in src/models/memo.py

class MemoUpdate(SQLModel):
    """メモ更新用モデル"""

    content: str | None = None