【Flask】Chapter5-6｜relationshipの使い方とリレーション構築の基本

# 基本構文
変数 = Column(型, ForeignKey('参照先テーブル.カラム'))
# Columnクラスを使ってテーブルの列を定義。オプションとしてForeignKeyを設定。

# 使用例
変数 = Column(Intege, ForeignKey('authors.id')) # authorsテーブルのidカラムを外部キーとした列を生成

# 子テーブルのクラス内で使用する構文
親データ = relationship('親クラス名', back_populates='子に対応する属性名')
author = relationship("Author", back_populates="books") # 使用例：Authorクラスのbooks列と紐づける

# 親テーブルのクラス内で使用する構文
子データ = relationship('子クラス名', back_populates='親に対応する属性名')

from pathlib import Path # pathlibライブラリのPathクラスをインポート
from sqlalchemy import create_engine, Column, Integer, String, ForeignKey
from sqlalchemy.orm import declarative_base, sessionmaker, relationship

# ====================================
# データベースのパス（保存場所）を設定
# ====================================
base_dir = Path(__file__).parent    # このスクリプトファイルがあるフォルダのパスを取得して、変数base_dirに代入
database = base_dir / 'data.sqlite' # base_dir内のdata.sqliteというファイルへのパスを作成し、変数databaseに代入
## データベースエンジンを作成
db_engine = create_engine(f'sqlite:///{database}', echo=True) # create_engine関数を使って、DB接続用のエンジンを作成
Base = declarative_base() # SQLAlchemyに対応した新しい“親クラス”を生成し、変数Baseに代入

# ====================================
# モデル（テーブルを作成するクラス）
# ====================================
## 書籍テーブル
class Book(Base):  # Baseクラスを継承したBookクラスの定義
    # テーブル名
    __tablename__ = 'books'
    # Columnクラスを使ってテーブルの列を３つ定義
    id = Column(Integer, primary_key=True, autoincrement=True)	# 書籍ID（主キー, 連番）
    name = Column(String, nullable=False)						# 書籍名（入力必須）
    author_id = Column(Integer, ForeignKey('authors.id'))		# 著者ID（外部キー：authors.idを参照）
        # author_id列にはauthorsテーブルのidカラムにある値しか入らない
        # このForeignKeyにより、こちらがリレーションの「子」側となる
    # リレーション（1対多リレーションの子側）
    author = relationship("Author", back_populates="books")		# リレーション
        # relationship()関数を使って、Authorクラスのbooks属性とauthorを関連付ける
    # 表示用関数
    def __str__(self):
        return f"書籍ID：{self.id}, 書籍名：{self.name}"

## 著者テーブル
class Author(Base):  # Baseクラスを継承したAuthorクラスの定義
    # テーブル名
    __tablename__ = 'authors'
    # Columnクラスを使ってテーブルの列を２つ定義
    id = Column(Integer, primary_key=True, autoincrement=True)	# 著者ID（主キー）
    name = Column(String, nullable=False, unique=True)			# 著者名（ユニーク・必須）
    # リレーション（1対多リレーションの親側）
    books = relationship("Book", back_populates="author")		# リレーション
        # relationship()関数を使って、Bookクラスのauthor属性とbooks属性を関連付ける
        # 外部キーが相手側にあるため、こちらがリレーションの「親」側になる
    # 表示用関数
    def __str__(self):
        return f"著者ID：{self.id}, 著者名：{self.name}"

# ====================================
# テーブル操作
# ====================================
print('テーブルを削除してから作成')
Base.metadata.drop_all(db_engine)   # データベースの削除（初期化）
Base.metadata.create_all(db_engine) # データベースの作成or接続 ＆ テーブルの作成

## セッションの生成
session_maker = sessionmaker(bind=db_engine) # sessionmakerクラスからセッションファクトリを作成し、変数session_makerに代入
session = session_maker()					 # session_makerをインスタンス生成し、変数sessionに代入

# 書籍のインスタンス作成
book01 = Book(name='ノルウェイの森') # Bookクラス（モデル）をインスタンス生成し、book01に代入
book02 = Book(name='1Q84')
book03 = Book(name='容疑者Xの献身')
book04 = Book(name='ナミヤ雑貨店の奇蹟')

# 著者のインスタンス作成
author01 = Author(name='村上春樹') # Authorクラス（モデル）をインスタンス生成し、author01に代入
author02 = Author(name='東野圭吾')

# 著者に書籍を紐づける
author01.books.append(book01)  # author01のbooksリストにappendメソッドを使用
    # これによりauthor01のbooksリストにbook01を追加、両者のリレーションが構築される
author01.books.append(book02)  # 同上
author02.books.append(book03)  # 同上
author02.books.append(book04)  # 同上

# セッションで「著者」を登録
session.add_all([author01, author02])  # 著者ごとセッションに追加（書籍も自動的に追加される）
session.commit()

print('データの参照：実行')
print('■：Bookの参照')
target_book = session.query(Book).filter_by(id=1).first()
    # Bookテーブルの、id=1のレコードの、最初の1件を取得
print(target_book)
print('■：Bookに紐づいたAuthorの参照')
print(target_book.author)

print('■' * 20)

print('■：Authorの参照')
target_author = session.query(Author).filter_by(id=1).first()
    # Authorテーブルの、id=1のレコードの、最初の1件を取得
print('■：Authorに紐づいたBookの参照')
for book in target_author.books:
    print(book)

■：Bookの参照
書籍ID：1, 書籍名：ノルウェイの森
■：Bookに紐づいたAuthorの参照
著者ID：1, 著者名：村上春樹
■：Bookに紐づいたPriceの参照
価格ID：1, 金額：1200円