flask-sqlalchemyで外部キー制約の設定時にエラーが出る

Question

flaskを用いて家計簿のようなものを作成しようとしたのですが、外部キー制約の設定ができません。

プログラミング言語はpython,アプリケーションを作るためにflaskを使用し、データベース操作のために
pythonのormであるflask-sqlalchemyを使っています。

アプリケーションの概要ですが、まず、日用品や交際費などのようにジャンル別にカテゴリーを作成し、カテゴリーごとの予算を設定します。お金を使うごとに何にお金をどれくらい使ったかを記録し、それらの情報をウェブページ上に載せるというものです。なお一番下にpythonのコードすべてを載せています。
（HTMLは割愛）

データベースですが、Categoryというクラスにカテゴリーの情報を、Detailというクラスにお金を使用したときの情報を入れておきたいと考えています。また、これら二つのクラスをカテゴリ名を用いて一対多リレーションシップとしてデータベースを作成したいと考えています。

こちらがflask-sqlalchemyの公式ドキュメントのDeclearing Modelsのone to many relationshipを参考に作ったデータベースです。

class Category(db.Model):
    name = db.Column(db.String,db.ForeignKey('name'),primary_key=True)
    budget = db.Column(db.Integer,nullable=False)
    remaining_budget = db.Column(db.Integer,nullable=False)
    month = db.Column(db.Integer,nullable=False)

class Detail(db.Model):
    id = db.Column(db.Integer,primary_key=True)
    name = db.relationship('Category',backref='Detail',lazy=True)
    used_money = db.Column(db.Integer,nullable=False)
    purchased_item = db.Column(db.String,nullable=False)    
    date = db.Column(db.String,nullable=False)

こちらを実行すると出てきたエラー文がこちらです。
sqlalchemy.exc.NoForeignKeysError: Could not determine join condition between parent/child tables on relationship Detail.name - there are no foreign keys linking these tables. Ensure that referencing columns are associated with a ForeignKey or ForeignKeyConstraint, or specify a 'primaryjoin' expression.

エラー文を見るに、二つのテーブルをつなぐ外部キーがないとされているようですが、公式ドキュメント通りに外部キー制約を設定しているつもりなので、なぜこのようなことが起きているのかさっぱりわかりません。データベースについても勉強中なので根本的な間違いなのかもしれません。
なぜこのエラーが起きているのか、そしてその対応策を教えていただきたいです。

pythonのコード

from flask import Flask
from flask import render_template,redirect,request,session
from flask_sqlalchemy import SQLAlchemy
from flask_migrate import Migrate
import os
import datetime

app = Flask(__name__)
app.config['AQLALCHEMY_DARABASE_URI'] = 'sqlite:///database.db'
db = SQLAlchemy(app)
migrate = Migrate(app,db)
today = datetime.date.today()

class Category(db.Model):
    name = db.Column(db.String,db.ForeignKey('name'),primary_key=True)
    budget = db.Column(db.Integer,nullable=False)
    remaining_budget = db.Column(db.Integer,nullable=False)
    month = db.Column(db.Integer,nullable=False)

class Detail(db.Model):
    id = db.Column(db.Integer,primary_key=True)
    name = db.relationship('Category',backref='Detail',lazy=True)
    used_money = db.Column(db.Integer,nullable=False)
    purchased_item = db.Column(db.String,nullable=False)    
    date = db.Column(db.String,nullable=False)

@app.route('/')
def index():
    display_categorys = Category.query.filter_by(month = today.month).all()
    display_details = Category.query.filter_by(month = today.month).all()
    month = today.month
    day = today.day
    return render_template('index.html',categorys=display_categorys,details=display_details,this_month=month,day=day)


@app.route('/create_category' ,methods=['GET','POST'])
def create_category():
    if request.method == 'GET':
        return render_template('create_category.html')
    else:
        category_name = request.form.get('category_name')
        budget = request.form.get('budget')
        add_category = Category(category_name=category_name,budget=budget)
        db.session.add(add_category)
        db.session.commit()
        return redirect('/index')

@app.route('/create_detail' ,methods=['GET','POST'])
def create_detail():
    if request.method == 'GET':
        return render_template('create_detail.html')
    else:
        purchased_item = request.form.get('purchased_item')
        used_money = request.form.get('used_money')
        add_detail = Detail(purchased_item=purchased_item,used_money=used_money)
        db.session.add(add_detail)
        db.session.commit()

Answer 1

公式ドキュメントの One-to-Many Relationships っていうのはこのリンクのものですかね？

公式とasasika_Rさんのコードを見比べると

# asasika_Rさん
class Category(db.Model):
    name = db.Column(db.String,db.ForeignKey('name'),primary_key=True)
#                                             ^^^^
# 公式
class Address(db.Model):
    person_id = db.Column(db.Integer, db.ForeignKey('person.id'), nullable=False)
#                                                    ^^^^^^^^^

だいたい似ていますが、公式ソースのAddressクラスのdb.ForeignKeyにはperson.idとありますが、asasika_Rさんの方は単にnameになっています。
試していませんが、category.nameにしたらいけるんじゃないかと推測できます。

# asasika_Rさん
class Detail(db.Model):
    name = db.relationship('Category',backref='Detail',lazy=True)
#                                              ^^^^^^
# 公式
class Person(db.Model):
    addresses = db.relationship('Address', backref='person', lazy=True)
#                                                   ^^^^^^

また、どちらのClass名も先頭大文字ですが、公式のコードのbackrefとForeignKeyに指定するのは小文字です。

公式のClass指定そのままDBを作成してみると、小文字テーブルが作成されたので、テーブル名は小文字で指定する必要がありそうです。

最初の文字列はなんとなくクラス名と同じで、後のはテーブル名を入れる必要があるように感じます。

という感じの修正をしてみてはいかがでしょうか？

ちなみにクラスの小文字をテーブル名にするというのは以下に記載がありました。
Declaring Models

Some parts that are required in SQLAlchemy are optional in Flask-SQLAlchemy. For instance the table name is automatically set for you unless overridden. It’s derived from the class name converted to lowercase and with “CamelCase” converted to “camel_case”. To override the table name, set the __tablename__ class attribute.

↓ブラウザ翻訳
SQLAlchemyで必要な一部のパーツは、 Flask-SQLAlchemy。 たとえば、テーブル名は自動的に設定されます オーバーライドされない限り、あなたのために。 変換されたクラス名から派生します 小文字に変換し、「CamelCase」を「camel_case」に変換します。 オーバーライドするには テーブル名を設定し、 __tablename__クラス属性。 

Comments

[asasika_R]

とても丁寧な回答ありがとうございます。
公式ドキュメント通りしていると思っていましたが、まだまだ詰めが甘かったようです。
category.nameにして小文字にするところを小文字にしてみましたが、変わりませんでした。
そこでもう一度公式ドキュメントを見直し、Foreignkeyの後をdetail.idに変更してみるとうまくいきました。
うまくいったのはいいのですが、なぜDetailクラスのIDのカラムにするとうまくいくのでしょうか、わかりません。detail.nameにしてもうまくいかなかったので、外部キーの制約先は主キーにしないといけない前提条件などがあるのでしょうか。もし知っていらっしゃるならば教えていただきたいです。

[FiroProchainezo]

公式との違いにだけ集中して対象カラムを気にしてませんでした。
すみません。

以下のサイトに中段あたりに記述がありますが、
https://www.dbonline.jp/postgresql/table/index11.html

> FOREIGN KEY 制約によって参照されるカラム( refcolumn )には UNIQUE 制約または PRIMARY KEY 制約が設定されている必要があります。

とのことです。

個人的にはPK以外をFKにしたことはないので気にしたことがありませんでした・・・。

[asasika_R]

返信が遅くなって申し訳ないです。FOREIGN KEYによって参照されるカラムに同じものがあれば、参照できないからなんですね。悩んでいたことが理解できました。ありがとうございましたい。