PythonのSQLAlchemyで、１件のレコードを取得する関数に、one()とfirst()関数の２つがある。
この２つの関数の違いが気になったので、まとめます。
関数の説明と、その使い分け方についても、解説したいと思います。
スポンサーリンク
one()とfirst()の違い
クエリの検索レコード数によって、以下の通り挙動が変わります。
また、one_or_none() という関数もあったので、これも表にまとめました。
| 検索結果 | one()関数 | one_or_none() | first()関数 |
|---|---|---|---|
| 0件 | NoResultFoundエラー発生 |
None | None |
| 1件 | １件を返す | １件を返す | １件を返す |
| 2件以上 | NoResultFoundエラー発生 |
NoResultFoundエラー発生 |
先頭１件を返す |
一目瞭然ですが、one()関数は、検索結果が１件以外の時、one_or_none()関数は、結果が2件以上ある時、sqlalchemy.orm.exc.NoResultFoundエラーが発生します。
どう使い分けるか？
違いは分かりました。
では、どう使い分けるのだろうか？
明確な決まりはありませんが、およそ以下のような使い分けになると思います。
- one() / one_or_none()
必ず1件、データが取れる仕様であれば、one()を使うべきです。
こういった所の場合、下手にfirst()を使ってしまうと、仕様と異なるデータが取れたにも関わらず、後続処理が動いてしまい、データがぶっ壊れるなど、最悪の自体に陥ってしまう場合があるからです。
いっそのこと、エラーでアプリを異常終了させた方がマシなので、勇気を持って one()を使いましょう。
結果が1件又は0件になる時は、one_or_none() を使いましょう。
- first()
one() の時とは逆に、仕様上 0件または、2件以上データが取れる可能性がある所は、first()を使いましょう。
first()を使う時は、以下の2点はしっかり確認しましょう。
- 0件の時、Noneが返るが、Noneの時の処理が正しく行えているか？
- 2件以上取れる時、ソート条件を指定して、処理すべき先頭1件を取得しているか？
スポンサーリンク
関連記事
■ MacにPython3をインストールする! (サクッとインストールしたい人向け)
Mac環境に、Python3を簡単にインストールする方法を紹介しています。
■ Python3入門! 基礎をおさらい (変数/演算子/条件分岐/繰り返し)
１つの記事に、基本文法をまとめて書いているので、時間が空いて忘れてしまった場合でも、一気に復習出来るようになっています。よければ見てください。
■ Flaskでソースの変更を検知して、Webアプリを自動リロードする[Python Tips]
Flaskの開発で、ソースを更新したら、自動的にWebアプリをリロードする方法です。
■ Flaskで REST API開発する! 直ぐに実行できるサンプルコードで解説 【Python Tips】
Pythonの軽量Webフレームワークである、FlaskでREST APIを作るまでの流れを、紹介します。
■ Flask-RESTful を使って、REST APIを作る【Python Tips】
Flaskと、Flask-RESTfulを使って、REST APIを作ります。
Flask-RESTfulを使うと、オブジェクト思考な感じで、REST APIが作れます。
■ Pythonで小数点の四捨五入/切り捨て/切り上げを行う
Pythonのdecimalモジュールを使って、小数点の丸めを行う方法です。
■ pipコマンドまとめ! 忘れても思い出せばいい! 【Python TIPS】
よく使うpipコマンドをまとめました。
■ Pythonで正規表現を使って数値/英字チェックを実装する (コピペ用)
数値/半角英字などのチェック処理を、Pythonの正規表現を使って実装します。
コピペで簡単に使えるようになっています。
0 件のコメント:
コメントを投稿