[DBDocs]제작한 ERD를 문서화 해보자

필자가 전에 포스트한 DBDiagram에 대한 글이 있다. DBDiagram를 제작한 회사에서 제작한 서비스로 보였고, 문서화를 내가 제작한 쿼리(dbml파일)을  자동으로 해준다는 게 흥미로워서 사용을 해보고 기록을 남기게 되었다.

 

 

아래는 필자가 현재 올린 서비스 ERD에 대해서 자동으로 문서화를 해주고 페이지로 제작된 화면이다.

 

위의 DBDocs 링크와 튜토리얼 링크를 같이 첨부한다.

작성자의 DBDocs 링크 , DBDocs 링크

---

설치 방법

dbdocs의 경우에는 npm또는 yarn을 통해 설치를 한 이후에 설치가 가능하다.

그렇기 때문에 node부터 설치를 진행해야 한다.

 

필자는 개발환경이 현재  Macbook Air M1을 사용중이다.

 

아래의 명령어 두줄이면 설치는 끝난다.

// 1. Node 설치
brew install node

// 2. DBDocs설치 (두개 중 아무거나..)
npm install -g dbdocs
sudo npm install -g dbdocs

---

명령어 종류

위의 리스트가 dbdocs에서 사용하는 명령어 종류다.

 

주로 사용하는 명령어는 build, ls, remove, token 을 주로 사용했기에 해당 명령어만 기록하도록 하겠다.

 

Password의 경우 설정이 가능하나, 그렇게 되면 생성되는 DBDocs의 페이지를 접속 할 때 마다 패스워드를 입력해야 하는 불편함이 있다 보니, 필자의 경우 공개되도 상관이 없는 ERD뿐이라 따로 설정을 하지 않아서 사용할 일이 없었다.

 

token : 인증을 할 수 있는 토큰을 생성한다. 

token의 항목은 다음과 같다.

dbdocs token --help
generate or revoke your authentication token

USAGE
  $ dbdocs token

OPTIONS
  -g, --generate  generate authentication token
  -r, --revoke    revoke authentication token

CI를 진행하게 될 경우 진행했었으며, 생성시 아래의 블록처럼 사용을 진행하면 된다.

dbdocs token -g
✔ Verify your identity
✔ Your access token is: eyJhbGciOi...
  › Warning: Please save this token. You cannot see it again.

 

배포 자동화에 대해서는 추후 기록을 다시 남기도록 하겟다.

---

build : 프로젝트의 생성 또는 업데이트를 할때 사용되며, 말그대로 빌드를 진행 한다.

 

빌드를 진행하기 위해서는 dbml파일이 필요하다. 필자의 경우 필자가 생성한 DBDiagram의 Sample을 이용하도록 하겠다.

 

혹시라도 Sample DBML파일이 필요한 경우 아래의 Repository에서 가져가면 좋을 듯 하다.

https://github.com/donsonioc2010/dbdocs

GitHub - donsonioc2010/dbdocs

 

아래와 같이 빌드를 진행하게 되면 링크를 같이준다. 링크를 접속할 경우 내가 생성한 프로젝트의 링크가 아래처럼 출력이 된다.

// build의 추가 옵션들
dbdocs build --help
build docs

USAGE
  $ dbdocs build [FILEPATH]

ARGUMENTS
  FILEPATH  dbml file path

OPTIONS
  -p, --password=password  password for project
  --project=project        project name
  
  
 //빌드 방법
  dbdocs build ./Desktop/Study/database/dbdocs/dbdocs_sample.dbml
✔ Parsing file content
⚠ Password is not set for 'DBDocsSample'
✔ Done. Visit: https://dbdocs.io/donsonioc2010/DBDocsSample

ℹ Thanks for using dbdocs! We'd love to hear your feedback: https://form.jotform.com/200962053361448

---

ls : 현재 생성된 프로젝트 List를 표현한다.

 

ls의 경우에는 추가적인 옵션은 없다. ls만 입력하면 되며 출력은 아래처럼 이루어진다.

dbdocs ls
donsonioc2010
 Name                Password    Url                                           Last updated
 ─────────────────── ─────────── ───────────────────────────────────────────── ─────────────────────────
 NooBLoL             No          https://dbdocs.io/donsonioc2010/NooBLoL       2022. 9. 16. 오후 1:42:35
 DBDocsSample        No          https://dbdocs.io/donsonioc2010/DBDocsSample  2022. 9. 16. 오후 4:13:33

---

remove : 생성한 프로젝트를 삭제한다.

사용법은 dbdocs remove [ProjectName]이다

//Remove의 옵션은 따로 없다.
dbdocs remove --help
remove docs

USAGE
  $ dbdocs remove [PROJECT_NAME]

ARGUMENTS
  PROJECT_NAME  name of
  
  
//삭제 예시
dbdocs remove DBDocsSample
✔ Removed successfully

 

위와 같이 삭제 여부를 알려주며, 삭제가 된 경우 아래의 사진처럼 해당 프로젝트는 삭제가 된다.

---

혹시 샘플로 생성한 페이지를 확인 해보기 원하면 아래 링크를 참고하면 좋을 듯 하다.

샘플 DBDocs의 링크

 

 

DBDocs에 대한 기록들이 많이 존재하지는 않다보니 직접 글을 남기게 되었다.

 

다음에는 해당 dbdocs를 Git의 Action을 사용해서 자동화로 관리하는 방법에 대해서 포스트를 기록할 예정이다.