Flask データベース操作

Flask では、データベース操作は Web アプリケーションを構築する上で重要な側面です。

Flask は、SQL を直接使用する方法や、SQLAlchemy などの ORM(オブジェクト関係マッピング)ツールを利用する方法など、データベースと対話する複数の方法を提供します。

以下に、SQLAlchemy を使用した基本操作と SQL ステートメントの直接実行を含む、Flask のデータベース操作の詳細な説明を示します。

  1. SQLAlchemy を使用する:モデルの定義、データベースの設定、基本的な CRUD 操作の実行。
  2. データベースの作成と管理:使用するdb.create_all()テーブルを作成します。
  3. CRUD 操作:レコードの追加、読み取り、更新、削除。
  4. クエリ操作:並べ替えやページネーションを含む、基本および複雑なクエリの実行。
  5. Flask-Migrate:Flask-Migrate を使用したデータベースマイグレーションの管理。
  6. 生の SQL の実行:生の SQL ステートメントを使用したデータベース操作。

1. SQLAlchemy を使用する

SQLAlchemy は、データベース操作を簡素化し、Python オブジェクトを介してデータベーステーブルと対話できる強力な ORM ライブラリです。

Flask-SQLAlchemy は、SQLAlchemy を統合するための Flask の拡張機能です。

Flask-SQLAlchemy をインストールする

pip install flask-sqlalchemy

SQLAlchemy を設定する

app.py ファイルのコード:

例

from flask import Flask
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///example.db'  # SQLite データベースを使用する
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
db = SQLAlchemy(app)

2. モデルを定義する

モデルはデータベーステーブルの Python クラスであり、各モデルクラスはデータベース内の 1 つのテーブルを表します。

例

class User(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    username = db.Column(db.String(80), unique=True, nullable=False)
    email = db.Column(db.String(120), unique=True, nullable=False)

    def __repr__(self):
        return f'<User {self.username}>'

db.Model:すべてのモデルクラスは db.Model から継承する必要があります。

db.Column:モデルのフィールドを定義し、フィールドの型、主キーかどうか、一意かどうか、空にできるかどうかなどの属性を指定します。

3. データベースの作成と管理

データベースとテーブルの作成

モデルを定義した後、SQLAlchemy が提供するメソッドを使用してデータベースとテーブルを作成できます。

with app.app_context():
    db.create_all()

db.create_all():現在のコンテキストで定義されたすべてのモデルに対応するテーブルを作成します。

4. 基本的な CRUD 操作

レコードの作成

例

@app.route('/add_user')
def add_user():
    new_user = User(username='john_doe', email='john@example.com')
    db.session.add(new_user)
    db.session.commit()
    return 'User added!'

db.session.add(new_user):新しいユーザーオブジェクトをセッションに追加します。

db.session.commit():トランザクションをコミットし、変更をデータベースに保存します。

レコードの読み取り

例

@app.route('/get_users')
def get_users():
    users = User.query.all()  # すべてのユーザーを取得する
    return '<br>'.join([f'{user.username} ({user.email})' for user in users])

User.query.all():すべてのユーザーレコードをクエリします。

レコードの更新

例

@app.route('/update_user/<int:user_id>')
def update_user(user_id):
    user = User.query.get(user_id)
    if user:
        user.username = 'new_username'
        db.session.commit()
        return 'User updated!'
    return 'User not found!'

User.query.get(user_id):主キーを使用して単一のユーザーレコードをクエリします。

フィールド値を更新し、トランザクションをコミットします。

レコードの削除

例

@app.route('/delete_user/<int:user_id>')
def delete_user(user_id):
    user = User.query.get(user_id)
    if user:
        db.session.delete(user)
        db.session.commit()
        return 'User deleted!'
    return 'User not found!'

db.session.delete(user):ユーザーレコードを削除し、トランザクションをコミットします。

5. クエリ操作

SQLAlchemy は豊富なクエリ機能を提供しており、クエリオブジェクトを使用してさまざまなクエリ操作を実行できます。

基本的なクエリ

users = User.query.filter_by(username='john_doe').all()

filter_by():フィールド値に基づいてレコードをフィルタリングします。

複雑なクエリ

from sqlalchemy import or_

users = User.query.filter(or_(User.username == 'john_doe', User.email == 'john@example.com')).all()

or_():複雑なクエリ条件を実行するために使用します。

並べ替えとページネーション

users = User.query.order_by(User.username).paginate(page=1, per_page=10)

order_by():指定されたフィールドで並べ替えます。

paginate():ページネーションクエリ。

6. Flask-Migrate を使用したマイグレーション

Flask-Migrate は、Alembic をベースにしたデータベースマイグレーション用の拡張機能で、データベースのバージョン管理を支援します。

Flask-Migrate をインストールする

pip install flask-migrate

Flask-Migrate を設定する

app.py ファイルのコード:

from flask_migrate import Migrate

migrate = Migrate(app, db)

マイグレーションの初期化

flask db init

マイグレーションスクリプトの作成

flask db migrate -m "Initial migration."

マイグレーションの適用

flask db upgrade
  • flask db init:マイグレーション環境を初期化します。
  • flask db migrate -m "message":マイグレーションスクリプトを作成します。
  • flask db upgrade:マイグレーションをデータベースに適用します。

7. 生の SQL の実行

SQLAlchemy は ORM 機能を提供しますが、生の SQL ステートメントを実行することもできます。

例

@app.route('/raw_sql')
def raw_sql():
    result = db.session.execute('SELECT * FROM user')
    return '<br>'.join([str(row) for row in result])

db.session.execute():生の SQL クエリを実行します。

Flask で MySQL データベースに接続して操作する

Flask で MySQL データベースに接続して操作するには、通常 SQLAlchemy を使用するか、MySQL の Python ドライバーを直接使用します。以下に、Flask-SQLAlchemy を使用する方法と、MySQL の Python ドライバーを直接使用して操作する方法を含む詳細な手順を示します。

1. Flask-SQLAlchemy を使用して MySQL に接続する

Flask-SQLAlchemy は、SQLAlchemy の設定と操作を簡素化する Flask の拡張機能です。MySQL に接続するには、Flask-SQLAlchemy と MySQL ドライバーをインストールする必要があります。

必要なライブラリをインストールします:

pip install flask-sqlalchemy mysqlclient
  • flask-sqlalchemy:Flask の SQLAlchemy 拡張機能。
  • mysqlclient:MySQL データベースの Python ドライバー。

Flask-SQLAlchemy を設定する

app.py ファイルのコード:

例

from flask import Flask
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'] = 'mysql://username:password@localhost/dbname'
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
db = SQLAlchemy(app)

code>SQLALCHEMY_DATABASE_URI:データベース接続 URI を設定します。形式はmysql://username:password@localhost/dbname。

  • username:MySQL ユーザー名。
  • password:MySQL パスワード。
  • localhost:MySQL ホストアドレス(ローカルの場合は通常localhost)。
  • dbname:データベース名。

モデルの定義と基本操作の実行

app.py ファイルのコード:

例

class User(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    username = db.Column(db.String(80), unique=True, nullable=False)
    email = db.Column(db.String(120), unique=True, nullable=False)

    def __repr__(self):
        return f'<User {self.username}>'

@app.route('/')
def index():
    users = User.query.all()
    return '<br>'.join([f'{user.username} ({user.email})' for user in users])

if __name__ == '__main__':
    with app.app_context():
        db.create_all()  # データベーステーブルを作成する
    app.run(debug=True)

MySQL の Python ドライバーを直接使用する

SQLAlchemy を使用せずに MySQL の Python ドライバーを直接使用する場合は、mysql-connector-python または PyMySQL ライブラリを使用できます。

mysql-connector-python をインストールします:

pip install mysql-connector-python

PyMySQL をインストールします(PyMySQL を使用する場合):

pip install PyMySQL

mysql-connector-python を使用して MySQL に接続する

app.py ファイルのコード:

例

from flask import Flask, request, jsonify
import mysql.connector

app = Flask(__name__)

def get_db_connection():
    connection = mysql.connector.connect(
        host='localhost',
        user='username',
        password='password',
        database='dbname'
    )
    return connection

@app.route('/add_user', methods=['POST'])
def add_user():
    data = request.json
    name = data['name']
    email = data['email']

    connection = get_db_connection()
    cursor = connection.cursor()
    cursor.execute('INSERT INTO user (username, email) VALUES (%s, %s)', (name, email))
    connection.commit()
    cursor.close()
    connection.close()

    return 'User added!'

@app.route('/get_users')
def get_users():
    connection = get_db_connection()
    cursor = connection.cursor(dictionary=True)
    cursor.execute('SELECT * FROM user')
    users = cursor.fetchall()
    cursor.close()
    connection.close()

    return jsonify(users)

if __name__ == '__main__':
    app.run(debug=True)

PyMySQL を使用して MySQL に接続する場合、app.py ファイルのコード:

例

from flask import Flask, request, jsonify
import pymysql

app = Flask(__name__)

def get_db_connection():
    connection = pymysql.connect(
        host='localhost',
        user='username',
        password='password',
        database='dbname',
        cursorclass=pymysql.cursors.DictCursor
    )
    return connection

@app.route('/add_user', methods=['POST'])
def add_user():
    data = request.json
    name = data['name']
    email = data['email']

    connection = get_db_connection()
    with connection.cursor() as cursor:
        cursor.execute('INSERT INTO user (username, email) VALUES (%s, %s)', (name, email))
        connection.commit()

    connection.close()
    return 'User added!'

@app.route('/get_users')
def get_users():
    connection = get_db_connection()
    with connection.cursor() as cursor:
        cursor.execute('SELECT * FROM user')
        users = cursor.fetchall()

    connection.close()
    return jsonify(users)

if __name__ == '__main__':
    app.run(debug=True)
その他の拡張機能