# FastAPIとPostgreSQLでUUID主キーを自動採番する方法

## 目次
1. はじめに
2. UUIDとは
3. FastAPIでUUIDを使用する準備
    3.1. 必要なパッケージのインストール
    3.2. PostgreSQLのテーブル作成
4. UUID主キーを使用するORMモデルの定義
    4.1. SQLAlchemyを用いたモデル作成
    4.2. Pydanticモデルの作成
5. FastAPIルーターの実装
    5.1. CRUD操作の実装
6. データベース接続の設定
7. 動作確認
8. まとめ

## 1. はじめに
UUID（Universally Unique Identifier）は、グローバルに一意の識別子を生成するための標準です。UUIDは、データベースにおける主キーとしてよく使用され、多くのプログラミング言語やデータベースがサポートしています。本記事では、FastAPIとPostgreSQLを使用して、UUIDを主キーとして自動採番する方法を紹介します。

## 2. UUIDとは
UUIDは128ビットの識別子で、一般には8-4-4-4-12の32文字の16進数形式で表されます。たとえば、`123e4567-e89b-12d3-a456-426614174000`のような形式です。UUIDは非常に多くのユニークな値を生成できるため、分散システムや複数のデータソース間での主キー衝突を回避するのに適しています。

## 3. FastAPIでUUIDを使用する準備

### 3.1 必要なパッケージのインストール
Pythonの環境を準備し、次の主要なパッケージをインストールします：

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

- `fastapi`: PythonのモダンなWebフレームワーク
- `uvicorn`: FastAPIの実行に使用するASGIサーバー
- `sqlalchemy`: データベースORM
- `psycopg2`: PostgreSQLデータベース接続用ドライバ
- `pydantic`: データバリデーションライブラリ

### 3.2 PostgreSQLのテーブル作成
次に、UUIDを主キーとして使用するテーブルを作成します。以下のSQLコマンドを使用して、PostgreSQLでテーブルを準備します。

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

`gen_random_uuid()`はPostgreSQLでUUIDを生成する関数です。これはPostgreSQL拡張モジュールを有効にしている必要があります。

## 4. UUID主キーを使用するORMモデルの定義

### 4.1 SQLAlchemyを用いたモデル作成
SQLAlchemyを使用して、UUIDを主キーとして持つモデルを定義します。

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

### 4.2 Pydanticモデルの作成
FastAPIでデータのバリデーションを行うため、Pydanticモデルを作成します。

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

`orm_mode = True`を設定することで、SQLAlchemyのオブジェクトを直接Pydanticモデルに変換することができます。

## 5. FastAPIルーターの実装

### 5.1 CRUD操作の実装
FastAPIで基本的なCRUD操作（Create, Read, Update, Delete）を実装します。

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

## 6. データベース接続の設定

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

`create_engine`でPostgreSQLに接続し、`sessionmaker`でデータベースセッションを管理します。

## 7. 動作確認
`uvicorn`を使用してFastAPIアプリケーションを起動します。

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

APIエンドポイントにアクセスして、CRUD操作が正しく動作しているかを確認します。

## 8. まとめ
FastAPIとPostgreSQLを使用して、UUIDを主キーとするデータベースを自動採番する方法を紹介しました。UUIDを使うことで、シンプルかつ安全に主キーを扱うことができます。特に分散システムや複数のデータソース間での唯一性を保証したい場合に有用です。FastAPIではこのUUIDの取り扱いも非常に簡単にできるので、プロジェクトに応じて柔軟に活用してください。 [cv:issue_marketplace_engineer]

# FastAPIとPostgreSQLでUUID主キーを自動採番する方法

## 目次
1. はじめに
2. UUIDとは
3. FastAPIでUUIDを使用する準備
    3.1. 必要なパッケージのインストール
    3.2. PostgreSQLのテーブル作成
4. UUID主キーを使用するORMモデルの定義
    4.1. SQLAlchemyを用いたモデル作成
    4.2. Pydanticモデルの作成
5. FastAPIルーターの実装
    5.1. CRUD操作の実装
6. データベース接続の設定
7. 動作確認
8. まとめ

## 1. はじめに
UUID（Universally Unique Identifier）は、グローバルに一意の識別子を生成するための標準です。UUIDは、データベースにおける主キーとしてよく使用され、多くのプログラミング言語やデータベースがサポートしています。本記事では、FastAPIとPostgreSQLを使用して、UUIDを主キーとして自動採番する方法を紹介します。

## 2. UUIDとは
UUIDは128ビットの識別子で、一般には8-4-4-4-12の32文字の16進数形式で表されます。たとえば、`123e4567-e89b-12d3-a456-426614174000`のような形式です。UUIDは非常に多くのユニークな値を生成できるため、分散システムや複数のデータソース間での主キー衝突を回避するのに適しています。

## 3. FastAPIでUUIDを使用する準備

### 3.1 必要なパッケージのインストール
Pythonの環境を準備し、次の主要なパッケージをインストールします：

```bash
pip install fastapi uvicorn sqlalchemy psycopg2 pydantic
```

- `fastapi`: PythonのモダンなWebフレームワーク
- `uvicorn`: FastAPIの実行に使用するASGIサーバー
- `sqlalchemy`: データベースORM
- `psycopg2`: PostgreSQLデータベース接続用ドライバ
- `pydantic`: データバリデーションライブラリ

### 3.2 PostgreSQLのテーブル作成
次に、UUIDを主キーとして使用するテーブルを作成します。以下のSQLコマンドを使用して、PostgreSQLでテーブルを準備します。

```sql
CREATE TABLE items (
    id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
    name TEXT NOT NULL,
    description TEXT
);
```

`gen_random_uuid()`はPostgreSQLでUUIDを生成する関数です。これはPostgreSQL拡張モジュールを有効にしている必要があります。

## 4. UUID主キーを使用するORMモデルの定義

### 4.1 SQLAlchemyを用いたモデル作成
SQLAlchemyを使用して、UUIDを主キーとして持つモデルを定義します。

```python
from sqlalchemy import Column, String, Text
from sqlalchemy.dialects.postgresql import UUID
from sqlalchemy.ext.declarative import declarative_base
import uuid

Base = declarative_base()

class Item(Base):
    __tablename__ = 'items'
    id = Column(UUID(as_uuid=True), primary_key=True, default=uuid.uuid4, unique=True, nullable=False)
    name = Column(String, nullable=False)
    description = Column(Text)
```

### 4.2 Pydanticモデルの作成
FastAPIでデータのバリデーションを行うため、Pydanticモデルを作成します。

```python
from pydantic import BaseModel, Field
from typing import Optional

class ItemSchema(BaseModel):
    id: Optional[uuid.UUID] = Field(default_factory=uuid.uuid4)
    name: str
    description: Optional[str] = None

    class Config:
        orm_mode = True
```

`orm_mode = True`を設定することで、SQLAlchemyのオブジェクトを直接Pydanticモデルに変換することができます。

## 5. FastAPIルーターの実装

### 5.1 CRUD操作の実装
FastAPIで基本的なCRUD操作（Create, Read, Update, Delete）を実装します。

```python
from fastapi import FastAPI, HTTPException, Depends
from sqlalchemy.orm import Session
from sqlalchemy.future import select
from . import models, schemas
from .database import engine, SessionLocal

models.Base.metadata.create_all(bind=engine)

app = FastAPI()

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

@app.post("/items/", response_model=schemas.ItemSchema)
def create_item(item: schemas.ItemSchema, db: Session = Depends(get_db)):
    db_item = models.Item(name=item.name, description=item.description)
    db.add(db_item)
    db.commit()
    db.refresh(db_item)
    return db_item

@app.get("/items/{item_id}", response_model=schemas.ItemSchema)
def read_item(item_id: uuid.UUID, db: Session = Depends(get_db)):
    db_item = db.get(models.Item, item_id)
    if db_item is None:
        raise HTTPException(status_code=404, detail="Item not found")
    return db_item
```

## 6. データベース接続の設定

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

# 使用するデータベースのURLを指定
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()
```

`create_engine`でPostgreSQLに接続し、`sessionmaker`でデータベースセッションを管理します。

## 7. 動作確認
`uvicorn`を使用してFastAPIアプリケーションを起動します。

```bash
uvicorn main:app --reload
```

APIエンドポイントにアクセスして、CRUD操作が正しく動作しているかを確認します。

## 8. まとめ
FastAPIとPostgreSQLを使用して、UUIDを主キーとするデータベースを自動採番する方法を紹介しました。UUIDを使うことで、シンプルかつ安全に主キーを扱うことができます。特に分散システムや複数のデータソース間での唯一性を保証したい場合に有用です。FastAPIではこのUUIDの取り扱いも非常に簡単にできるので、プロジェクトに応じて柔軟に活用してください。 

FastAPIとPostgreSQLでUUID主キーを自動採番する方法

目次

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