スキーマを適用する

Pythonで学ぶMongoDB入門

Filip Schouwenaars

Machine Learning Researcher

柔軟から検証ありのスキーマへ

MongoDBは固定スキーマなしで保存可能
迅速なプロトタイピングやモデル進化に最適

mov.insert_one({
    "title": "knives out",
    "genre": ["comedy", "crime", "drama"],
    "year": 2019, # oops
    "rating": 7.9,
})


mov.find_one({
  "title": "knives out",
  "release_year": 2019
})

スキーマが固まったら検証を設定することが重要

pydanticでスキーマを強制する

データ検証ライブラリ
期待するフィールドと型を定義
各ドキュメントの設計図

from pydantic import BaseModel
from typing import Optional

class Movie(BaseModel):
    title: str
    genre: list[str]
    release_year: int
    rating: float
    won_oscar: Optional[bool] = None

型付きデータモデルで挿入する

# Before
new_movie = {
  "title": "knives out",
  "genre": ["comedy", "crime", "drama"],
  "year": 2019, # oops
  "rating": 7.9,
}

# No output

データ形式のチェックなし

# Now
new_movie = Movie(
  title = "knives out",
  genre = ["comedy", "crime", "drama"],
  year = 2019, # oops
  rating = 7.9,
)

pydantic.error_wrappers.ValidationError:
1 validation error for Movie
release_year: field required

タイプミスや欠落はコレクション投入前に検出

ミスを修正する

from pydantic import BaseModel
from typing import Optional

class Movie(BaseModel):
    title: str
    genre: list[str]
    release_year: int
    rating: float
    won_oscar: Optional[bool] = None

# 正しいフィールドと値
new_movie = Movie(
  title = "knives out",
  genre = ["comedy", "crime", "drama"],
  release_year = 2019,
  rating = 7.9,
)


mov.insert_one(dict(new_movie))

InsertOneResult(...)

MongoDBの組み込みスキーマ検証

client.film.create_collection(
  "movies_v2",
  validator={
    "$jsonSchema": {
      "required": ["title", "genre", "release_year", "rating"],
      "properties": {
        "title": { "bsonType": "string" },
        "genre": { 
          "bsonType": "array",
          "items": { "bsonType": "string" }
        },
        "release_year": { "bsonType": "int" },
        "rating": { "bsonType": "double" },
        "won_oscar": { "bsonType": "bool" }
      }
    }
  }
)

MongoDBの組み込みスキーマ検証を試す

client.film.movies_v2.insert_one({
  "title": "knives out",
  "genre": ["comedy", "crime", "drama"],
  "year": 2019, # oops
  "rating": 7.9,
})

pymongo.errors.WriteError: Document failed validation, [...]
'missingProperties': ['release_year'], 'errmsg': 'Document failed validation'}

データベース側でのスキーマ検証
MongoDBへアクセスするすべてのアプリで有効

まとめ

アプリ側の検証: pydantic.BaseModel
DB側の検証: MongoDBの組み込みスキーマ検証
ミスを防ぐ
構造を強制する

Let's practice!

Pythonで学ぶMongoDB入門