산출물로 내야 하는 테이블 정의서를 DDL에서 자동으로 만들고, 반대로 설계 문서의 표에서 CREATE TABLE 문을 만듭니다. 스키마가 바뀔 때마다 문서를 손으로 고치는 반복을 줄입니다.
CREATE TABLE users (
id BIGINT PRIMARY KEY,
name VARCHAR(50) NOT NULL,
created_at TIMESTAMP DEFAULT now()
);
COMMENT ON COLUMN users.name IS '이름';
→ 정의서(마크다운)
| 컬럼 | 타입 | NULL | 기본값 | 설명 |
|---|---|---|---|---|
| id | BIGINT | N (PK) | | |
| name | VARCHAR(50) | N | | 이름 |
| created_at | TIMESTAMP | Y | now() | |
PK·FK·UNIQUE 같은 제약과 컬럼 코멘트를 보존하며, 출력은 마크다운 표와 엑셀에 바로 붙는 TSV 두 가지입니다. DB 방언 차이는 주로 코멘트 문법에 있어(오라클·PostgreSQL의 COMMENT ON, MySQL의 인라인 COMMENT) 방언 선택은 그 부분에만 적용됩니다. 반대 방향(정의서→DDL)은 표 형식을 자동 감지합니다.