DB 명세서 Export
Ainecto는 다이어그램에서 전문적인 데이터베이스 명세서를 생성합니다. HTML, Excel, PDF 세 가지 출력 포맷을 지원하며 각각 다른 대상과 workflow에 맞춰져 있습니다.
Export 방법
- header toolbar에서 Export 메뉴를 엽니다.
- Specification을 선택합니다.
- HTML, Excel, PDF 중 포맷을 고릅니다.
Export는 현재 다이어그램의 모든 엔티티를 포함합니다. 테이블, 컬럼, 인덱스, 관계, enum이 문서화됩니다.
HTML 명세서
HTML export는 별도 의존성 없이 브라우저에서 열 수 있는 standalone document를 만듭니다.
| 섹션 | 내용 |
|---|---|
| Diagram summary | 다이어그램 이름, 테이블 수, 관계 수 |
| Tables | 테이블별 컬럼명, 타입, nullable, default, primary key, note |
| Indexes | 인덱스명, 컬럼, unique flag, 타입 |
| Relationships | from table → to table, 컬럼, 관계 타입, ON DELETE / ON UPDATE |
| Enums | enum 이름, 값, 노트 |
문서 안에는 내부 anchor link가 있어 테이블과 관련 엔티티 사이를 빠르게 이동할 수 있습니다.
Excel 명세서
Excel export는 여섯 개 sheet로 구성된 workbook을 생성합니다.
| Sheet | 내용 |
|---|---|
| Summary | 다이어그램 metadata, 이름, 설명, 전체 개수 |
| Tables | 테이블명, schema, alias, note, 컬럼 수 |
| Columns | 테이블, 컬럼명, 타입, nullable, default, PK, note |
| Relationships | from table.column → to table.column, 타입, ON DELETE, ON UPDATE |
| Indexes | 테이블, 인덱스명, 컬럼, unique, 타입 |
| Enums | enum 이름, 값, value note |
스타일은 자동 적용됩니다.
- Header row — 파란 배경과 흰 글자
- Alternating rows — 읽기 쉬운 striped row
- Primary keys — bold highlight
- 컬럼 폭은 내용에 맞춰 자동 조정
이 파일은 이메일, Confluence, 문서 관리 시스템으로 바로 공유할 수 있습니다.
PDF 명세서
PDF workflow는 HTML 명세서를 새 브라우저 창으로 열고, 브라우저의 print 기능으로 PDF 저장을 수행합니다.
- Specification → PDF를 선택합니다.
- 렌더링된 HTML 문서가 새 창으로 열립니다.
Ctrl+P또는 macOS의Cmd+P를 누릅니다.- destination을 Save as PDF로 선택합니다.
- orientation, margin 등 페이지 설정을 조정합니다.
- Save를 클릭합니다.
이 방식은 서버 측 PDF engine 없이도 page layout과 margin을 직접 제어할 수 있습니다.
사용 사례
| 상황 | 추천 포맷 |
|---|---|
| 비개발 이해관계자 공유 | HTML — self-contained, 어디서나 열림 |
| 프로젝트 문서나 wiki 첨부 | Excel — filter, sort, 주석이 쉬움 |
| 공식 산출물이나 audit 포함 | PDF — 고정 레이아웃, 인쇄 준비 |
| 빠른 내부 리뷰 | HTML — 가장 빠르게 생성하고 탐색 |
| Data dictionary 유지 | Excel — 편집 가능, 기존 spreadsheet와 통합 |
팁
- 노트를 최신 상태로 유지하세요. 명세서는 테이블/컬럼 note를 포함하므로 좋은 note가 좋은 문서를 만듭니다.
- Schema name을 사용하세요. 스키마별로 테이블을 조직하면 export에서도 그 구조가 드러납니다.
- 변경 후 다시 export하세요. 명세서는 특정 시점의 snapshot입니다. 스키마가 바뀌면 다시 생성해야 합니다.