@im-r/dbmldoc
v25.4.0
Published
DBML Based Database Schema Documentation CLI Tool
Readme
@im-r/dbmldoc
DBML 파일을 구문 분석하여, 보고서 및 안내서 용 기반 문서로 전환
참고 링크
설치
- node.js 설치
- 패키지 설치
npm i @im-r/dbdmldoc -g
실행
dbmldoc실행되는 경로에
*.dbml파일이 있어야 합니다.
HTML 양식
@imr/dbmldoc이 설치되는 위치의template안 HTML 파일을 사용- 문자열 구성은 꼭
utf-8을 사용해야 합니다.
양식 예:
<div data-repeat="table">
<table>
<tr data-repeat="field">
<td>{{변수명}}</td>
</tr>
</table>
</div>테이블 변수
| 변수명 | 값 | |------------------|----------------------| | tableOrder | 테이블 순번 | | tableName | 테이블 명 | | tableLogicalName | 테이블 물리 명(테이블 명의 괄호안) | | tableComment | 테이블 설명 |
열(Field, Column) 변수
| 변수명 | 값 | |-------------|------------------| | order | 열 순번 | | name | 열명 | | logicalName | 열 물리명(열명의 괄호안) | | type | 열 유형 | | size | 열 크기 | | comment | 열 설명 | | pk | PK 출력([PK]) | | not | NOT 출력(Nullable) |
dbdocs 활용
DBML 파일 클라우드에 등록하여 온라인 안내서 생성
설치
npm install -g dbdocs최초 설정
사용자 인증:
# Required GitHub Account
# Paste Copied Token
dbdocs login생성 및 갱신:
dbdocs build ./database.dbml비밀번호 설정:
dbdocs password --set p???? --project p????