Flask-sqlalchemy
フラスコ– SQLAlchemy
Flask Webアプリケーションで生のSQLを使用してデータベースでCRUD操作を実行するのは退屈です。 代わりに、Pythonツールキットである SQLAlchemy は、アプリケーション開発者にSQLのフルパワーと柔軟性を提供する強力な* ORマッパー*です。 Flask-SQLAlchemyは、FlaskアプリケーションにSQLAlchemyのサポートを追加するFlask拡張機能です。
- ORM（オブジェクト関係マッピング）とは何ですか？*
ほとんどのプログラミング言語プラットフォームはオブジェクト指向です。 一方、RDBMSサーバーのデータはテーブルとして保存されます。 オブジェクト関係マッピングは、オブジェクトパラメータを基になるRDBMSテーブル構造にマッピングする手法です。 ORM APIは、生のSQLステートメントを記述することなくCRUD操作を実行するメソッドを提供します。
このセクションでは、Flask-SQLAlchemyのORMテクニックを研究し、小さなWebアプリケーションを構築します。
- ステップ1 *-Flask-SQLAlchemy拡張機能をインストールします。
pip install flask-sqlalchemy- ステップ2 *-このモジュールからSQLAlchemyクラスをインポートする必要があります。
from flask_sqlalchemy import SQLAlchemy- ステップ3 *-Flaskアプリケーションオブジェクトを作成し、使用するデータベースのURIを設定します。
app = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///students.sqlite3'ステップ4 *-次に、パラメータとしてアプリケーションオブジェクトを使用して、SQLAlchemyクラスのオブジェクトを作成します。 このオブジェクトには、ORM操作のヘルパー関数が含まれています。 また、ユーザー定義モデルの宣言に使用される親Modelクラスも提供します。 以下のスニペットでは、 *students モデルが作成されます。
db = SQLAlchemy(app)
class students(db.Model):
id = db.Column('student_id', db.Integer, primary_key = True)
name = db.Column(db.String(100))
city = db.Column(db.String(50))
addr = db.Column(db.String(200))
pin = db.Column(db.String(10))
def __init__(self, name, city, addr,pin):
self.name = name
self.city = city
self.addr = addr
self.pin = pinステップ5 *-URIに記載されているデータベースを作成/使用するには、 create_all（）*メソッドを実行します。
db.create_all()*SQLAlchemy* の *Session* オブジェクトは、 *ORM* オブジェクトのすべての永続化操作を管理します。次のセッションメソッドはCRUD操作を実行します-
- db.session.add （model object）-マッピングされたテーブルにレコードを挿入します
- db.session.delete （model object）-テーブルからレコードを削除します
- * model.query.all（）*-テーブルからすべてのレコードを取得します（SELECTクエリに対応）。
filter属性を使用して、取得したレコードセットにフィルターを適用できます。 たとえば、学生のテーブルで city = ’Hyderabad’ のレコードを取得するには、次のステートメントを使用します-
Students.query.filter_by(city = ’Hyderabad’).all()このように多くのバックグラウンドがあるので、今度は、学生データを追加するためのアプリケーションのビュー機能を提供します。
アプリケーションのエントリポイントは、 ’/’ URLにバインドされた* show_all（）*関数です。 学生のレコードセットテーブルは、パラメータとしてHTMLテンプレートに送信されます。 テンプレート内のサーバー側コードは、HTMLテーブル形式でレコードをレンダリングします。
@app.route('/')
def show_all():
return render_template('show_alll', students = students.query.all() )テンプレート*（ ‘show_alll’）*のHTMLスクリプトは次のとおりです-
<!DOCTYPE html>
<html lang = "en">
<head></head>
<body>
<h3>
<a href = "{{ url_for('show_all') }}">Comments - Flask
SQLAlchemy example</a>
</h3>
<hr/>
{%- for message in get_flashed_messages() %}
{{ message }}
{%- endfor %}
<h3>Students (<a href = "{{ url_for('new') }}">Add Student
</a>)</h3>
<table>
<thead>
<tr>
<th>Name</th>
<th>City</th>
<th>Address</th>
<th>Pin</th>
</tr>
</thead>
<tbody>
{% for student in students %}
<tr>
<td>{{ student.name }}</td>
<td>{{ student.city }}</td>
<td>{{ student.addr }}</td>
<td>{{ student.pin }}</td>
</tr>
{% endfor %}
</tbody>
</table>
</body>
</html>上記のページには、 ’/new’ URLマッピング* new（）関数へのハイパーリンクが含まれています。 クリックすると、学生情報フォームが開きます。 データは *POST メソッドで同じURLに投稿されます。
newl
<!DOCTYPE html>
<html>
<body>
<h3>Students - Flask SQLAlchemy example</h3>
<hr/>
{%- for category, message in get_flashed_messages(with_categories = true) %}
<div class = "alert alert-danger">
{{ message }}
</div>
{%- endfor %}
<form action = "{{ request.path }}" method = "post">
<label for = "name">Name</label><br>
<input type = "text" name = "name" placeholder = "Name"/><br>
<label for = "email">City</label><br>
<input type = "text" name = "city" placeholder = "city"/><br>
<label for = "addr">addr</label><br>
<textarea name = "addr" placeholder = "addr"></textarea><br>
<label for = "PIN">City</label><br>
<input type = "text" name = "pin" placeholder = "pin"/><br>
<input type = "submit" value = "Submit"/>
</form>
</body>
</html>httpメソッドがPOSTとして検出されると、フォームデータが学生テーブルに追加され、アプリケーションは追加されたデータを表示するホームページに戻ります。
@app.route('/new', methods = ['GET', 'POST'])
def new():
if request.method == 'POST':
if not request.form['name'] or not request.form['city'] or not request.form['addr']:
flash('Please enter all the fields', 'error')
else:
student = students(request.form['name'], request.form['city'],
request.form['addr'], request.form['pin'])
db.session.add(student)
db.session.commit()
flash('Record was successfully added')
return redirect(url_for('show_all'))
return render_template('newl')以下に示すのは、アプリケーション*（app.py）*の完全なコードです。
from flask import Flask, request, flash, url_for, redirect, render_template
from flask_sqlalchemy import SQLAlchemy
app = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///students.sqlite3'
app.config['SECRET_KEY'] = "random string"
db = SQLAlchemy(app)
class students(db.Model):
id = db.Column('student_id', db.Integer, primary_key = True)
name = db.Column(db.String(100))
city = db.Column(db.String(50))
addr = db.Column(db.String(200))
pin = db.Column(db.String(10))
def __init__(self, name, city, addr,pin):
self.name = name
self.city = city
self.addr = addr
self.pin = pin
@app.route('/')
def show_all():
return render_template('show_alll', students = students.query.all() )
@app.route('/new', methods = ['GET', 'POST'])
def new():
if request.method == 'POST':
if not request.form['name'] or not request.form['city'] or not request.form['addr']:
flash('Please enter all the fields', 'error')
else:
student = students(request.form['name'], request.form['city'],
request.form['addr'], request.form['pin'])
db.session.add(student)
db.session.commit()
flash('Record was successfully added')
return redirect(url_for('show_all'))
return render_template('newl')
if __name__ == '__main__':
db.create_all()
app.run(debug = True)Pythonシェルからスクリプトを実行し、ブラウザーに http：//localhost：5000/ と入力します。
- 「生徒を追加」*リンクをクリックして、*生徒情報*フォームを開きます。
フォームに記入して送信します。 送信されたデータとともにホームページが再表示されます。
次のように出力を確認できます。
