# FastAPIとPostgreSQLでデータの論理削除と復元APIを作成する方法

## 目次
1. はじめに
2. 論理削除の概念
3. 開発環境のセットアップ
4. ユーザーデータベースの設計
5. FastAPIプロジェクトの作成
    - 5-1. 必要なライブラリのインストール
    - 5-2. プロジェクトディレクトリ構成
6. CRUD操作の実装
    - 6-1. ユーザーモデルの定義
    - 6-2. データベース接続の設定
    - 6-3. 論理削除APIの実装
    - 6-4. データ復元APIの実装
7. APIテストの実施
8. まとめ

---

## 1. はじめに
データの論理削除は、データベースからレコードを物理的に削除する代わりに、フラグを立てて無効化する手法です。これにより、削除されたデータを容易に復元でき、監査や履歴管理に役立ちます。本記事では、FastAPIとPostgreSQLを使用して、データの論理削除と復元APIの作成方法を紹介します。

## 2. 論理削除の概念
論理削除とは、レコードを物理的にデータベースから削除せず、特定のフラグ（例えば`is_deleted`カラム）を利用して削除状態を管理する方法です。この手法は、削除済みデータの復元や削除ログの保持に有効です。

## 3. 開発環境のセットアップ
今回使用する技術スタックは以下の通りです:
- Python 3.8+
- FastAPI
- PostgreSQL
- SQLAlchemy

## 4. ユーザーデータベースの設計
データベースには`users`テーブルを作成します。このテーブルには以下のカラムを含めます:
- `id`: ユーザーを一意に識別するための主キー
- `name`: ユーザーの名前
- `email`: ユーザーのメールアドレス
- `is_deleted`: 論理削除のフラグ（初期値は`False`）
- `created_at`、`updated_at`: レコードの作成・更新時刻のタイムスタンプ

![img](/mosaic-code.jpg)

## 5. FastAPIプロジェクトの作成

### 5-1. 必要なライブラリのインストール
まず、プロジェクトで必要なパッケージをインストールします。

![img](/mosaic-code.jpg)

### 5-2. プロジェクトディレクトリ構成
以下のようなディレクトリ構成を採用します。

![img](/mosaic-code.jpg)

## 6. CRUD操作の実装

### 6-1. ユーザーモデルの定義
`models.py`ファイルを作成し、SQLAlchemyでユーザーモデルを定義します。

![img](/mosaic-code.jpg)

### 6-2. データベース接続の設定
`database.py`ファイルでデータベース接続を設定します。

![img](/mosaic-code.jpg)

### 6-3. 論理削除APIの実装
論理削除APIを`routers/users.py`で実装します。

![img](/mosaic-code.jpg)

### 6-4. データ復元APIの実装
データの復元機能を追加します。

![img](/mosaic-code.jpg)

## 7. APIテストの実施
上記のコードでAPIを実装した後は、FastAPIのドキュメンテーションUIを使用してAPIをテストすることができます。`main.py`を実行し、ブラウザで`http://127.0.0.1:8000/docs`にアクセスしてドキュメントを確認します。

![img](/mosaic-code.jpg)

## 8. まとめ
この記事では、FastAPIとPostgreSQLを使ったデータの論理削除と復元APIを構築する方法を紹介しました。論理削除は、データの追跡や復元が可能なため、データ管理の一環として非常に役立ちます。ぜひ、実際にこの技術を使って、アプリケーションのデータストレージを改善してみてください。 [cv:issue_marketplace_engineer]

# FastAPIとPostgreSQLでデータの論理削除と復元APIを作成する方法

## 目次
1. はじめに
2. 論理削除の概念
3. 開発環境のセットアップ
4. ユーザーデータベースの設計
5. FastAPIプロジェクトの作成
    - 5-1. 必要なライブラリのインストール
    - 5-2. プロジェクトディレクトリ構成
6. CRUD操作の実装
    - 6-1. ユーザーモデルの定義
    - 6-2. データベース接続の設定
    - 6-3. 論理削除APIの実装
    - 6-4. データ復元APIの実装
7. APIテストの実施
8. まとめ

---

## 1. はじめに
データの論理削除は、データベースからレコードを物理的に削除する代わりに、フラグを立てて無効化する手法です。これにより、削除されたデータを容易に復元でき、監査や履歴管理に役立ちます。本記事では、FastAPIとPostgreSQLを使用して、データの論理削除と復元APIの作成方法を紹介します。

## 2. 論理削除の概念
論理削除とは、レコードを物理的にデータベースから削除せず、特定のフラグ（例えば`is_deleted`カラム）を利用して削除状態を管理する方法です。この手法は、削除済みデータの復元や削除ログの保持に有効です。

## 3. 開発環境のセットアップ
今回使用する技術スタックは以下の通りです:
- Python 3.8+
- FastAPI
- PostgreSQL
- SQLAlchemy

## 4. ユーザーデータベースの設計
データベースには`users`テーブルを作成します。このテーブルには以下のカラムを含めます:
- `id`: ユーザーを一意に識別するための主キー
- `name`: ユーザーの名前
- `email`: ユーザーのメールアドレス
- `is_deleted`: 論理削除のフラグ（初期値は`False`）
- `created_at`、`updated_at`: レコードの作成・更新時刻のタイムスタンプ

```sql
CREATE TABLE users (
    id SERIAL PRIMARY KEY,
    name VARCHAR(100),
    email VARCHAR(100) UNIQUE NOT NULL,
    is_deleted BOOLEAN DEFAULT FALSE,
    created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
    updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);
```

## 5. FastAPIプロジェクトの作成

### 5-1. 必要なライブラリのインストール
まず、プロジェクトで必要なパッケージをインストールします。

```bash
pip install fastapi[all] sqlalchemy psycopg2
```

### 5-2. プロジェクトディレクトリ構成
以下のようなディレクトリ構成を採用します。

```
project/
│
├── main.py
├── models.py
├── database.py
└── routers/
    └── users.py
```

## 6. CRUD操作の実装

### 6-1. ユーザーモデルの定義
`models.py`ファイルを作成し、SQLAlchemyでユーザーモデルを定義します。

```python
from sqlalchemy import Column, Integer, String, Boolean, DateTime
from sqlalchemy.sql import func
from database import Base

class User(Base):
    __tablename__ = 'users'

    id = Column(Integer, primary_key=True, index=True)
    name = Column(String(100))
    email = Column(String(100), unique=True, index=True, nullable=False)
    is_deleted = Column(Boolean, default=False)
    created_at = Column(DateTime(timezone=True), server_default=func.now())
    updated_at = Column(DateTime(timezone=True), onupdate=func.now())
```

### 6-2. データベース接続の設定
`database.py`ファイルでデータベース接続を設定します。

```python
from sqlalchemy import create_engine
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker

SQLALCHEMY_DATABASE_URL = "postgresql://user:password@localhost/dbname"

engine = create_engine(SQLALCHEMY_DATABASE_URL)
SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)

Base = declarative_base()
```

### 6-3. 論理削除APIの実装
論理削除APIを`routers/users.py`で実装します。

```python
from fastapi import APIRouter, Depends, HTTPException
from sqlalchemy.orm import Session
from models import User
from database import SessionLocal

router = APIRouter()

def get_db():
    db = SessionLocal()
    try:
        yield db
    finally:
        db.close()

@router.put("/users/{user_id}/delete", response_model=User)
def delete_user(user_id: int, db: Session = Depends(get_db)):
    user = db.query(User).filter(User.id == user_id, User.is_deleted == False).first()
    if user is None:
        raise HTTPException(status_code=404, detail="User not found")

    user.is_deleted = True
    db.commit()
    db.refresh(user)
    return user
```

### 6-4. データ復元APIの実装
データの復元機能を追加します。

```python
@router.put("/users/{user_id}/restore", response_model=User)
def restore_user(user_id: int, db: Session = Depends(get_db)):
    user = db.query(User).filter(User.id == user_id, User.is_deleted == True).first()
    if user is None:
        raise HTTPException(status_code=404, detail="User not found")

    user.is_deleted = False
    db.commit()
    db.refresh(user)
    return user
```

## 7. APIテストの実施
上記のコードでAPIを実装した後は、FastAPIのドキュメンテーションUIを使用してAPIをテストすることができます。`main.py`を実行し、ブラウザで`http://127.0.0.1:8000/docs`にアクセスしてドキュメントを確認します。

```python
from fastapi import FastAPI
from routers import users

app = FastAPI()
app.include_router(users.router)
```

## 8. まとめ
この記事では、FastAPIとPostgreSQLを使ったデータの論理削除と復元APIを構築する方法を紹介しました。論理削除は、データの追跡や復元が可能なため、データ管理の一環として非常に役立ちます。ぜひ、実際にこの技術を使って、アプリケーションのデータストレージを改善してみてください。 

FastAPIとPostgreSQLでデータの論理削除と復元APIを作成する方法

目次

続きを読むには単価診断を受けてください（30秒）