ORM Document / Docset

01/20

 

 

ORM Document

ORM 은 Object-Relational Mapping 의 약자로, 일반적으로 객체 지향 프로그래밍 언어와 관계형 데이터베이스 간의 데이터를 매핑하는 개발 기술이다. ORM document 는 그 관련된 문서.
그래서 ORM 문서의 유형은 사용 중인 특정 프로그래밍 언어, 프레임워크, ORM 도구에 따라 달라진다.

ORM 문서 유형

공식 문서
특정 ORM 프레임워크 개발자가 제공하는 자세한 가이드 및 API 참조 자료.
e.g. Node.js/TypeScript 용 Prisma, Java 용 Hibernate, Python 용 SQLAlchemy

스키마 정의 파일
데이터 모델과 그 관계가 정의된 파일. 이 모델은 DB의 테이블과 행을 객체 및 속성으로 추상화한다.
e.g. Prisma 의 schema.prisma

구성 파일
연결 설정(데이터베이스 유형, 호스트, 자격 증명) 및 ORM 의 기타 동작 옵션이 포함된 문서.

마이그레이션 스크립트
ORM 의 마이그레이션 도구에 의해 생성되거나 관리되는, 시간에 따른 DB 스키마 변경 사항을 추적하는 파일.

튜토리얼 및 가이드
사용자가 ORM 원칙과 도구를 효과적으로 적용하는 방법을 배울 수 있도록 커뮤니티나 프레임워크 개발자가 만든 문서나 서적.
e.g. Django 의 ORM Cookbook

ORM 의 목적

ORM 의 주요 목표는 개발자가 원시 SQL 쿼리를 작성할 필요성을 줄이고, 프로그래밍 언어의 기본 구문과 객체를 사용하여 DB와 상호 작용할 수 있도록 함으로써 생산성과 유지 관리 효율성을 높이는 것. 이런 문서들은 이 과정을 안내하는데 도움을 준다.

 

---

 

Docset

Docset 은 API 참조, 튜토리얼, 가이드 등과 같은 전체 문서 모음을 뜻한다.

오프라인 사용
Dash 또는 Zeal 과 같은 API 문서 브라우저에서 사용할 수 있도록 전체 문서 세트를 다운로드 할 수 있다. 이를 통해 인터넷 연결 없이도 빠르게 문서를 검색하고 엑세스할 수 있다.

파일 구조
Docset 은 기본적으로 HTML 문서가 포함된 폴더와 파일을 색인화하는 SQLite DB 파일로 구성된다.

생성 도구
doc2dash 나 Dashing 과 같은 도구를 사용해 기존 HTML 문서를 Dash 호환 docset 으로 변환할 수 있다.