📄 데이터 모델 도출 과정

*Git의 개념과 용어를 모르는 일반인 유저를 위해, Docsa에서는 일반적인 Git의 개념과 대응되는 용어를 다음과 같이 재정의합니다.
(기록: commit, 버전: branch, 병합하기: merge)

📌 설계 중점사항

문서 버전 관리 시스템의 핵심 요구사항은 다음과 같다:

• 문서 단위의 버전 관리와 브랜치 기능
• 새 브랜치 생성 및 브랜치 병합하기 기능
• 작성 중인 내용의 저장 및 복원
• 버전 간 비교 및 커밋 히스토리 시각화

Docsa 기획 아이디어의 주요 특이점은 다음과 같다:

• 기록마다 전체 본문이 통으로 저장되는 wiki가 아닌 Git의 구조
• 기록은 블록id의 리스트를 가짐
• DB에 저장되는 최소 단위는 block (이는 Editor.js (공식문서)에서 내려주는 고유한 id를 가진 문단)

이에 대한 DB 설계의 주안점은 다음과 같다:

• 사용자-문서-브랜치-기록과 저장-기록의 내용이 되는 블록 이란 복잡한 연관관계 표현
• 주요 엔티티는 모두 정형화된 메타데이터를 가짐 (FK와 생성/수정일자)
• 트랜잭션 처리 및 관계 제약이 명확해야할 것

➡ 이를 구현하는 최적의 설계를 위해 다음과 같은 ERD 설계 과정을 거쳤다.

🔸 설계 초기 단계의 RDB 단일 데이터베이스 ERD

💡 기존 스키마의 한계와 MongoDB 도입 시 기대효과

• 비정형 테이터에 대한 적합성

  • Save 의 본문과 Block의 본문은 JSON 형식
  • 이를 String으로 파싱하는 비용 존재
  • 프론트에서 내려주는 데이터의 구조가 기대하던 정규식과 달라질 경우의 위험성

• 블록의 연결 구조 설계 단순화

  • 이 RDB 구조에선 block의 순서를 표현하기 위한 연결리스트로써 commits_block_sequence 중간테이블을 사용하고 있음
  • MongoDB를 사용한다면 block의 순서를 리스트로 간단하게 표현 가능

📌 최종 결정된 DB Schema

• 회색 데이터는 RDB의 엔티티이며, 청록색 데이터는 MongoDB의 도튜먼트이다.

• 위와 같은 한계점으로 인해, 블록 및 콘텐츠 관련 데이터를 MongoDB에 분리 저장하는 방향으로 모델을 수정하였다.

• 이외의 엔티티는 복잡한 연관관계의 정합성을 보존할 수 있으며 메타데이터를 저장한다는 특성을 고려하여 RDB에 유지하고, 필요한 MonboDB의 ObjectId를 키로 저장한다.

✅ 주요 엔티티 및 도큐먼트 설명

✔ RDB 엔티티

✔ MongoDB 도큐먼트

• Block: 개별 블록의 데이터

{
  "_id": ObjectId('688acb39738f3ba3c0de543b'), // (MongoDB) CommitBlockSequence의 리스트 원소에 저장됨
  "content": {
    "id": "LTijV4knDj", // editor.js가 생성한 에디터상 문단의 고유 id
    "type": "paragraph",
    "data": {
      "text": "테스트코드를 습관화 하자"
    }
  }
}

• CommitBlockSequence: 커밋 시점의 블록 ID 리스트

{
  "_id": ObjectId('688acb39738f3ba3c0de543e'), // (RDB) Commit 엔티티의 commitMongoId 필드에 저장됨
  "blockOrders": [ // MongoDB에 저장된 블록의 ObjectId를 순서대로 가진 리스트 
    "688acb39738f3ba3c0de543a",
    "688acb39738f3ba3c0de543b",
    "688acb39738f3ba3c0de543c",
    "688acb39738f3ba3c0de543d"
  ]
}

• SaveContent: Save가 가지는 본문, Save의 경우엔 기록과 다르게 JSON 본문 전체를 DB에 저장

{
  "_id": ObjectId('688ac832738f3ba3c0de5415'), // (RDB) Save 엔티티의 saveMongoId 필드에 저장됨
  "content": [
    {
      "id": "M4QIuFj82K", // editor.js가 생성한 에디터상 문단의 고유 id
      "type": "paragraph",
      "data": {
        "text": "오늘 할 일"
      }
    },
    {
      "id": "ew2k5QghnN",
      "type": "paragraph",
      "data": {
        "text": "잘 먹고 잘 자기"
      }
    },
    {
      "id": "IqTwSiP2Lq",
      "type": "paragraph",
      "data": {
        "text": "즐겁게 공부하기"
      }
    }
  ]
}

❗ MongoDB 도입 후 이종 DB에서 생기는 문제와 해결

💬 생각해볼 수 있는 개선사항