質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

87.93%

Django REST frameworkでトランザクションしたい

解決済

回答 1

投稿 編集

  • 評価
  • クリップ 0
  • VIEW 3,548

score 15

 開発環境

  • Django==2.0.3
  • djangorestframework==3.7.7

 背景

Django REST frameworkを用いてAPIサーバを立て、それを叩くことでデータベースの更新を行いたい。

 質問したいこと

Django REST frameworkを使用していくつかのAPIを作成しました。Djangoを使用した場合、modelと1対1の関係でテーブルを作成することになると思います。Django REST frameworkを使用してAPIを作成した場合も同様に、APIとmodelが1対1の関係になり、1つのAPIで、1つのテーブルの更新しか出来ないと思います。

今回、APIを叩くと、任意のビジネスロジックが走る、もしくは任意の複数のテーブルの更新を行えるようにしたいです。理由として、例えば、マスタデータの更新と、それに関するログの更新を行いたいなどの場合には、複数のテーブルをまたいだ更新が必要だからです。

RDBMSのトランザクションを用いて複数のテーブルを同時に更新したい場合、どのような実装をするのが望ましいのでしょうか?

API設計や、Djangoなどに知見のある方がいらっしゃいましたら、よろしくお願いいたします。

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 1

checkベストアンサー

+1

1つのAPIで、1つのテーブルの更新しか出来ないと思います。

Django や restframework の generic viewのサンプルを見てそう思われたのだと思いますが
決して1つのviewやapiで1つのモデルしか更新できないわけでないです。

例えば Hoge モデルを作成するAPIをrestframeworkで作ったとして、同時に PiyoLog モデルも作成したければ、peform_create メソッド を override することで実現できます。

class CreateHogeAPIView(generics.CreateAPIView):
    serializer_class = HogeSerializer 

    def perform_create(self, request):
        serializer.save(user=request.user) # Hogeモデルが作成される

        # 別のモデルを同時に作成する
        PiyoLog.objects.create(user=request.user)

公式のドキュメントが参考になると思います。

http://www.django-rest-framework.org/api-guide/generic-views/#createapiview

これとは別にトランザクションについては、Djangoのドキュメントが参考になると思います。

https://docs.djangoproject.com/ja/2.0/topics/db/transactions/#django-s-default-transaction-behavior

追記 

ItemStockのstockが更新されたとき、ItemStockLogのbefore_stockafter_stockの値の更新も行いたいと考えています。

コメントをもらったので追記します。上記内容を実現したいのであれば、signalを利用して、

  • モデルが更新される前のstockデータをどこかに保存しておく -> pre_save
  • モデルが更新されたら、更新後のstockと一緒に ItemStockLogを作成する -> post_save

みたいなことをするのが一番よさそうに思えました。 signalに関しては、公式のドキュメントが参考になります。

https://docs.djangoproject.com/ja/2.0/ref/signals/

投稿

編集

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2018/03/26 17:36 編集

    回答ありがとうございます。
    `perform_creat` メソッドをオーバーライドすることで、処理に何かしらのロジックを付け加えられることはわかりました。
    現在、下記のような構成になっており、ItemStockを作成すると同時に、ItemStockLogも更新を行いたいです。

    ```views.py
    class ItemStockViewSet(viewsets.ModelViewSet):
    queryset = ItemStock.objects.all()
    serializer_class = ItemStockSerializer

    class ItemStockLogViewSet(viewsets.ModelViewSet):
    queryset = ItemStockLog.objects.all()
    serializer_class = ItemStockLogSerializer
    ```

    ItemStockのstockが更新されたとき、ItemStockLogの`before_stock`と`after_stock`の値の更新も行いたいと考えています。
    ```models.py
    class ItemStock(models.Model):
    stock = models.IntegerField()
    item = models.ForeignKey(Item, related_name='item_stocks', on_delete=models.CASCADE, unique=True)
    created_at = models.DateTimeField(auto_now_add=True)
    updated_at = models.DateTimeField(auto_now=True)

    class ItemStockLog(models.Model):
    item = models.ForeignKey(Item, on_delete=models.CASCADE)
    before_stock = models.IntegerField()
    after_stock = models.IntegerField()
    created_at = models.DateTimeField(auto_now_add=True)
    updated_at = models.DateTimeField(auto_now=True)
    ```

    Djangoについての理解が足りていなく、申し訳ありません。

    キャンセル

  • 2018/03/27 01:16

    やりたいことはなんとなく理解しました。 Django の signalの機能を使えば、保存する前と保存した後に、任意の関数を挟むことができるので、それを活用するのが良さそうに思いました。上記回答に追記してあります。

    キャンセル

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 87.93%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

同じタグがついた質問を見る