Imporre uno schema

Introduzione a MongoDB in Python

Filip Schouwenaars

Machine Learning Researcher

Da flessibile a schema convalidato

MongoDB ti permette di archiviare dati senza uno schema fisso
Ottimo per prototipazione rapida e modelli dati in evoluzione

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
})

Quando lo schema è definito, è importante configurare la convalida

Imponi uno schema con pydantic

Libreria per la convalida dei dati
Definisci campi attesi e relativi tipi
Un blueprint per ogni documento

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

Inserire con modelli di dati tipizzati

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

# Nessun output

Nessun controllo sul formato dei dati

# Ora
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

Refusi e campi mancanti vengono intercettati prima di finire nella collection!

Correggere l'errore

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

# Set corretto di campi e valori
new_movie = Movie(
  title = "knives out",
  genre = ["comedy", "crime", "drama"],
  release_year = 2019,
  rating = 7.9,
)


mov.insert_one(dict(new_movie))

InsertOneResult(...)

Convalida schema integrata in 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" }
      }
    }
  }
)

Test della convalida schema integrata di 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'}

Convalida dello schema a livello di database
Funziona in tutte le applicazioni che accedono a MongoDB

Riepilogo

Convalida lato applicazione: pydantic.BaseModel
Convalida lato database: convalida schema integrata di MongoDB
Evita errori
Impone struttura

Esercitiamoci!

Introduzione a MongoDB in Python