RDB에서 테이블 정의를 시각화하는 도구

링크:
https://github.com/maru44/scheman
Scheman는 RDB에서 테이블 정의를 시각화하는 도구입니다.

이것의 주요 목적은 엔지니어와 비 엔지니어 간의 작업 협업을 가속화하는 것입니다.

이것을 사용하여 하나의 명령과 몇 가지 설정으로 테이블 스키마 및 ERD의 도면을 생성할 수 있습니다.
Notion , File 또는 둘 다에서 출력 대상을 선택할 수 있습니다.

용법

사용법을 보여드리겠습니다.

설치

설치

go install github.com/maru44/[email protected]

설치하지 않으려면 다음을 사용할 수 있습니다.

go run github.com/maru44/[email protected] ...

scheman가 설치된 것을 전제로 진행하겠습니다.

설정 구성

데이터베이스 설정을 만들고scheman.toml(.yaml) 씁니다.

[psql]
  dbname  = "scheman"
  host    = "localhost"
  port    = 5432
  user    = "root"
  pass    = "password"
  sslmode = "disable"
  schema  = "public"

명령

몇 가지 예를 보여 드리겠습니다.

개념

먼저 notion 에서 테이블 스키마와 ERD를 작성하는 명령을 보여 드리겠습니다.

go install github.com/volatiletech/sqlboiler/v4/drivers/[email protected] \
  && scheman psql --services notion --erd-outputs notion \
    --notion-token ${NOTION_TOKEN} --notion-page-id ${PSQL_NOTION_PAGE_ID}

플래그services는 스키마 정의의 출력 대상을 나타냅니다.
플래그erd-outputs는 ERD의 출력 대상을 나타냅니다.

명령이 성공하면 table-index의 값이 다음 그림과 같이 출력된다.
다음부터 notion에 있는 스키마 정의와 ERD를 덮어쓰고 싶다면 커맨드 라인에서 출력되는 값을 notion-page-index 설정해 주세요.


Free Entry 속성은 자유롭게 쓸 수 있는 속성입니다. 이 값은 다음에 scheman 명령어를 실행해도 상속된다.

출력은 이 사진과 같을 것입니다.
이 사진들은 매우 거칠어서 죄송합니다.

스키마 정의
https://user-images.githubusercontent.com/46714011/155822065-f0f9f785-b2b1-4abd-b98b-052496dff169.png

ERD
https://user-images.githubusercontent.com/46714011/155862202-77e81b99-681a-44fb-bf1c-669dae7f1f5a.png

파일

go install github.com/volatiletech/sqlboiler/v4/drivers/[email protected] \
  && scheman psql --def-file ./def.csv --erd-file ./erd.md

플래그def-file는 스키마 정의의 출력 대상 파일을 나타냅니다.
플래그erd-file는 ERD의 출력 대상 파일을 나타냅니다.

출력은 다음과 같을 것입니다.

스키마 정의
https://github.com/maru44/scheman/blob/master/testdata/postgres/def.csv

ERD
https://github.com/maru44/scheman/blob/master/testdata/postgres/erd.md

옵션

구성

파일 작성 구성

기본값은 scheman입니다.

이것을 sqlboiler.toml 설정하면 sqlboiler.toml를 사용할 수 있습니다

서비스

스키마 정의

의 출력 대상을 나타냅니다.

기본값은 [ ]입니다.

옵션은 아직 개념일 뿐입니다

erd-출력

은 ERD

의 출력 대상을 나타냅니다.

기본값은 [ ]입니다.

옵션은 아직 개념일 뿐입니다

보기 비활성화

참이면 scheman 보기 무시

기본값은 false입니다

.

속성 무시

속성이 무시하는

기본값은 [ ]입니다.

옵션은 Data Type , PK , Auto Generate , Unique , Null , Default , Comment (7) Free Entry Enum

감사

sqlboiler를 사용하여 연결된 데이터베이스를 구문 분석합니다.
https://github.com/volatiletech/sqlboiler
go-notion를 개념 클라이언트로 사용.
https://github.com/dstotijn/go-notion