refactor: use uuids instead of integer ids

fastapi/full-stack-fastapi-template#1259

Author: gpspake

backend/app/alembic/versions/3e7ae2bab77f_create_release_model.py

@@ -5,10 +5,12 @@
 Create Date: 2024-07-25 02:46:50.518100
 
 """
+import uuid
+
 from alembic import op
 import sqlalchemy as sa
 import sqlmodel.sql.sqltypes
-
+from sqlalchemy.dialects import postgresql
 
 # revision identifiers, used by Alembic.
 revision = '3e7ae2bab77f'
@@ -20,7 +22,10 @@
 def upgrade():
     op.create_table(
         "release",
-        sa.Column('id', sa.Integer(), nullable=False),
+        sa.Column('id', postgresql.UUID(as_uuid=True), nullable=False, default=sa.text('uuid_generate_v4()')),
+        # sa.Column('id', sa.String(36), primary_key=True, default=str(uuid.uuid4()), unique=True, nullable=False),
+        # sa.Column('id', postgresql.UUID(as_uuid=True), default=uuid.uuid4, nullable=False),
+        # sa.Column('id', sa.Integer(), nullable=False),
         sa.Column('discogs_url', sqlmodel.sql.sqltypes.AutoString()),
         sa.Column('discogs_title', sqlmodel.sql.sqltypes.AutoString()),
         sa.Column('title', sqlmodel.sql.sqltypes.AutoString()),

backend/app/api/routes/releases.py

@@ -1,3 +1,4 @@
+import uuid
 from typing import Any
 
 from fastapi import APIRouter, HTTPException
@@ -42,7 +43,7 @@ def read_releases(
 
 
 @router.get("/{id}", response_model=ReleasePublic)
-def read_release(session: SessionDep, current_user: CurrentUser, id: int) -> Any:
+def read_release(session: SessionDep, current_user: CurrentUser, id: uuid.UUID) -> Any:
     """
     Get release by ID.
     """
@@ -61,7 +62,7 @@ def create_release(
     """
     Create new release.
     """
-    release = Release.model_validate(release_in, update={"owner_id": current_user.id})
+    release = Release.model_validate(release_in)
     session.add(release)
     session.commit()
     session.refresh(release)
@@ -70,7 +71,7 @@ def create_release(
 
 @router.put("/{id}", response_model=ReleasePublic)
 def update_release(
-    *, session: SessionDep, current_user: CurrentUser, id: int, release_in: ReleaseUpdate
+    *, session: SessionDep, current_user: CurrentUser, id: uuid.UUID, release_in: ReleaseUpdate
 ) -> Any:
     """
     Update an release.
@@ -89,7 +90,7 @@ def update_release(
 
 
 @router.delete("/{id}")
-def delete_release(session: SessionDep, current_user: CurrentUser, id: int) -> Message:
+def delete_release(session: SessionDep, current_user: CurrentUser, id: uuid.UUID) -> Message:
     """
     Delete an release.
     """

backend/app/models/release.py

@@ -1,11 +1,12 @@
+import uuid
 from datetime import date
 
 from sqlmodel import Field, SQLModel
 
 
 # Shared properties
 class ReleaseBase(SQLModel):
-    title: str = Field(min_length=1, max_length=255)
+    title: str | None = Field(default=None, min_length=1, max_length=255)
 
 
 # Properties to receive on item creation
@@ -38,8 +39,7 @@ class ReleaseUpdate(ReleaseBase):
 
 # Database model, database table inferred from class name
 class Release(ReleaseBase, table=True):
-    id: int | None = Field(default=None, primary_key=True)
-
+    id: uuid.UUID = Field(default_factory=uuid.uuid4, primary_key=True)
     discogs_url: str | None = Field(default=None, max_length=255)
     discogs_title: str | None = Field(default=None, max_length=255)
     title: str | None = Field(default=None, max_length=255)
@@ -54,7 +54,7 @@ class Release(ReleaseBase, table=True):
 
 # Properties to return via API, id is always required
 class ReleasePublic(ReleaseBase):
-    id: int
+    id: uuid.UUID
     discogs_url: str | None
     discogs_title: str | None
     title: str | None
@@ -69,4 +69,4 @@ class ReleasePublic(ReleaseBase):
 
 class ReleasesPublic(SQLModel):
     data: list[ReleasePublic]
-    count: int
+    count: int