🔥TIL#7. QuerySet 의 정/역참조와 ManyToManyField

1. QuerySet의 정/역참조

정참조 : 자신이 참조하는 table을 접근하는 것.
역참조 : 자신을 참조하는 table을 접근하는 것.

[정참조]
이 시리즈의 이전 포스트에서 select_related()를 통해 정참조의 기능을 볼 수 있었다.
처음에 django의 QuerySet 기능을 접하면서 테이블을 객체화해주는 용도로만 인식했었다. 때문에 "join" 처리가 필요한 경우 무조건 select_related()를 이용해야 하는 것으로 생각했으나 착각이었다. foreignKey로 지정한 속성은 id 관련 값만 있는 것이 아니라 이 속성이 relation 하고 있는 객체였다.
hourplace site의 모델링 중 place와 user 의 관계를 예로 들어보자.

class User(models.Model):
	name = models.CharField
    	email = models.CharField    	

class Place(models.Model):
	address = models.CharField
    	floor = models.IntegerField
    	user = models.ForeignKeyField(User, on_delete=models.CASCADE)
                      		
p = Place.objects.get(id=1)
print(p.user.name)
print(p.user.email)

위는 user_id 로 related 중인 user의 정보를 정참조로 접근하는 예제이다. select_related() 없이 바로 relation 중인 객체 정보를 볼 수 있다. 그러면 select_related()는 왜 지원하는 걸까? 오히려 위 예제처럼 사용하는게 편리한데 말이다.
이는 Hit(Database에 query를 요청하는 횟수)를 최소화하여 성능적인 측면에서의 이점을 얻을 수 있도록 하기 위함으로 SQL로 치면 join 을 이용해 한번의 Hit로 관계데이터를 가져오는 기능과 같다.

[역참조]
SQL문법 중 join 기능을 알고 있었기에 자연스럽게 정참조 기법에 익숙하게 받아들였다. 하지만 역참조라는 개념은 이해하기 쉽지 않았다. 이에 대해 공부하던 도중 역참조가 필요할 상황을 접하면서 조금 이해가 갔다. 아래는 그 상황이다.

User는 여러 Place를 소유할 수 있으므로 Place는 user table을 참조한다. 
Place마다 정참조 방식으로 Place의 소유주인 user의 정보(name, email 등)를 얻을 수 있다.

그런데 만약 User data를 기준으로 이 User가 소유한 Place 정보를 얻으려면 어떻게 해야할까?
Place table을 user_id를 기준으로 filtering하는 방법이 있겠지만 이 결과는 오직 Place 
에 대한 Queryset만이 나온다. 

나는 User data와 Place data를 모두 보유한 Queryset을 얻고 싶다.

User가 Place를 참조하고 있다면 정참조 방식 접근이 가능하나 지금은 반대 상황이다. 이 겨우를 위해 역참조 기법을 사용해야 한다. 이를 위해 prefetch_related() 를 알아보자.

user = Users.objects.prefetch_related('place_set').get(id=1)

print(user.name)
print(user.place_set.address)

위 코드에서 prefetch_related()를 call하면서 인자로 역참조 대상인 class이름 + '_set'을 넣고 있다. '_set'은 역참조를 의미하는 예약키로 이를 넣어주지 않으면 역참조가 불가하다.

Prefetch_related() 역시 적은 Hit수로 참조관계인 Table들의 데이터를 한번에 가져올 수 있도록 지원하는 함수로 주로 역참조 상황에서 많이 사용한다.
(그렇다고 꼭 역참조시에만 쓰는건 아니다. QuerySet의 'query'라는 속성을 통해 실제 sql query문을 확인, 보다 성능이 좋은 방식을 선택할 줄 알아야 한다).

위에서 select_related() 없이도 정참조가 가능하다고 했었다. 물론 역참조의 경우도 가능하다.

user = Users.objects.get(id=1)

print(user.name)
print(user.place_set.address)

prefetch_related()를 사용하지 않는다는 점만 빼면 똑같다. 다만 이 경우도 성능을 위해 prefetch_related를 사용한다는 것만이 차이일 뿐이다.

2. ManyToManyField

Database 설계시 N:N 관계의 Table들은 중간Table을 만들어 N:N을 회피해야 한다고 배웠다. 그래서 django에서 models 작업시 중간table용 class 를 정의, 양쪽 id를 FK로 하는 속성을 갖도록 모델링 했었다. 이런 중간 table을 매번 만들어야 할까? 이번에 알게된 ManyToManyField는 이를 자동화 해주는 기능이다. 아래 코드를 보자.

from django.db import models

class Publication(models.Model):
    title = models.CharField(max_length=30)

    class Meta:
        db_table='publications'

class Article(models.Model):
    headline = models.CharField(max_length=100)
    publications = models.ManyToManyField(Publication)

    class Meta:
        ordering ='articles'

Article과 Publication의 중간table로 articles_publications를 만드는 코드이다.
그리고 Article.publications를 통해 중간테이블을 이용한다. 값을 넣을 때는 두 테이블에 값이 먼저 생성되어 있어야 하므로 보통 아래와 같은 절차로 진행된다.

p1 = Publication.objects.create(title="hello")
p2 = Publication.objects.create(title="hello2")
a1 = Article.objects.create(headline="헤드라인")
     또는 Article(headline="헤드라인").save()
    
a1.publications.add(p1)
a1.publications.add(p2)
또는
a1.publications.add(p1, p2)

a1은 Article객체로 Create나 Save를 하기 전까진 Table에 추가되지 않으며 이 상황에서 a1에 publications를 추가하면 error가 발생한다.

위 과정을 거쳐 중간테이블이 채워졌다. 여기서 질문.... title이 'hello'인 Publication을 갖는 Article을 찾으려면 어떻게 해야 할까?

Article.objects.filter('publication__title' = 'hello')

'__'는 queryset에서 사용하는 예약어이다. 속성을 접근하는 용도는 물론 각종연산(gt, lt, gte, lte...)을 적용할때 사용해야 하므로 익혀두자

---

만약 생성해야 할 중간 table이 FK 외에 추가 정보를 가져야 한다면 models에서 중간table을 정의하고 ManyToManyField() argument 중 'through' 에 중간table class 이름을 넣으면 된다.
다음은 두 table(User, Place)을 relate 하는 'ratings' 라는 table을 ManyToManyField로 지정하는 code 이다.

class User(models.Model):
	name = models.CharField()
    	email = models.CharField()    	
        user_place = models.ManyToManyField(Place, through=Rating)
       
class Place(models.Model):
	address = models.CharField()
  
class Rating(models.Model):
	user = models.ForeignKeyField(User, on_delete=models.CASCADE)
    	place = models.ForeignKeyField('place.Place', on_delete=models.CASCADE)
        starpoint = models.FloatField()
        comments = models.Text()
        ...