• Doc de SQLAlchemy 1.4 : https://docs.sqlalchemy.org/en/14/contents.html
• Doc de Flask-SQLAlchemy : https://flask-sqlalchemy.palletsprojects.com/en/3.0.x/

pip install flask-sqlalchemy

Ajouter les valeurs suivantes à l'objet config de l'application :

Format pour l'URL de connexion :

Ajouter à config.py les lignes suivantes :

config.py

DB_PATH                        = os.path.join(DATA_PATH, 'db.sqlite')
SQLALCHEMY_DATABASE_URI        = 'sqlite:///' + DB_PATH
SQLALCHEMY_TRACK_MODIFICATIONS = False

Source: https://stackoverflow.com/questions/53024891/modulenotfounderror-no-module-named-mysqldb

Installer le connecteur :

pip install pymysql

Format pour l'URL de connexion :

Ajouter à config.py les lignes suivantes :

config.py

DB_HOST                 = 'localhost'
DB_NAME                 = 'exemple'
DB_USER                 = 'toto'
DB_PASSWORD             = 'my-password-is-beautiful'
SQLALCHEMY_DATABASE_URI = "mysql+pymysql://%s:%s@%s/%s" % (DB_USER, DB_PASSWORD, DB_HOST, DB_NAME)
 
SQLALCHEMY_TRACK_MODIFICATIONS = False

Format pour l'URL de connexion :

…(à suivre)…

app/__init__.py

# Import des modules de Flask et de ses extensions
from flask            import Flask
from flask_sqlalchemy import SQLAlchemy
 
# Création de l'application et import de la configuration
app = Flask(__name__)
app.config.from_object('config')
 
# Création de la DB
db = SQLAlchemy(app)
 
# Import et enregistrement des composants de l'application
from app.controllers.admin import admin
from app.controllers.auth  import auth
from app.controllers.main  import main
app.register_blueprint(admin)
app.register_blueprint(auth)
app.register_blueprint(main)
 
# Import de modèles (si on en utilise dans le code qui suit)
from app.models.user import User
from app.models.role import Role
 
# ...

Un modèle est une classe Python qui représente les enregistrements d'une table.

app/models/role.py

from app import db
 
class Role(db.Model):
    __tablename__ = 'roles'
    id   = db.Column(db.Integer,    primary_key=True)
    name = db.Column(db.String(64), unique=True)
 
    def __repr__(self):
        return '<Role %r>' % self.name

app/models/user.py

from app import db
 
class User(db.Model):
    __tablename__ = 'users'
    id       = db.Column(db.Integer,     primary_key=True)
    username = db.Column(db.String(64),  unique=True, index=True)
    email    = db.Column(db.String(200), unique=True)
 
    def __repr__(self):
        return '<User %r>' % self.username
 
    def hello(self):
        print("Hello, my name is %s." % self.name)

Une clé primaire est obligatoire pour chaque table, elle est généralement appelée id.

One Role to Many Users :

class Role(db.Model):
    # ...
 
    # One role can have many users.
    users = db.relationship('User', backref='role')
 
class User(db.Model):
    # ...
 
    # Each user has a role
    role_id = db.Column(db.Integer, db.ForeignKey('roles.id'))

Modèle Role : backref ajoute un attribut role au modèle User.

Modèle User : roles.id identifie la colonne id de la table roles comme “clé étrangère” dans la relation.

Flask shell permet d'interagir avec l'application, et notamment de manipuler les modèles, modifier des données, etc.

$ flask shell
>>> from app import db
>>> from app.models import User
 
# création d'une instance
>>> u = User()
>>> u.name = 'Marc'
>>> u.email = 'marc@email.com'
 
# ajout dans la db
>>> db.session.add(u)
>>> db.session.commit()
 
# modification
>>> u.name = 'Marcounet'
>>> db.session.commit()

Après avoir créé/modifié les modèles, il faut appliquer les changements dans la base de données (ajout de tables, création de champs, etc.)

Ne rien faire manuellement, mais utiliser les Migrations.

Source: https://flask-sqlalchemy.palletsprojects.com/en/3.0.x/queries/

SELECT selon un ID :

user = User.query.get(5)

SELECT selon le contenu d'un champ :

user = User.query.filter_by(name = 'Marc').first()
user = User.query.filter_by(name = 'Marc').one()