따라 하기

기존 DB 를 ERD 로 문서화하기

따라 하면 이미 있는 DB 의 테이블을 ERD 로 가져와(Reverse Engineering), 읽기 좋은 그림과 설명이 붙은 문서로 만들게 됩니다. 예는 데모 상점 DB 의 주문 관련 테이블(customer, orders, order_item, product, payment)입니다. 테이블 수에 따라 다르지만 20분쯤 걸립니다.

사용할 수 있는 곳웹데스크톱로그인 없이로그인로컬 프로젝트계정 프로젝트

갤러리 게시는 로그인한 계정 프로젝트에서만 지원합니다. 나머지 단계는 어디서나 같습니다.

준비

  • 문서화할 DB 의 커넥션을 만들어 둡니다(커넥션 만들기와 수정). 단계는 DB 를 읽기만 하므로 조회 권한이면 충분합니다. 운영 DB 라면 먼저 운영 DB 를 안전하게 연결하기 를 읽으세요.
  • ERD 에 가져온 테이블은 DB 의 테이블과 같은 것입니다. ERD 에서 무엇을 변경하면 DB 반영을 기다리는 변경이 되는지는 ERD 와 실제 DB 에서 설명합니다.

업무 단위로 ERD 만들기

스키마 전체를 ERD 하나에 담지 말고, 함께 읽는 테이블끼리 업무 단위로 ERD 를 나누세요. 테이블이 수백 개인 그림은 아무도 읽지 않고, 나중에 다시 맞출 때도 범위가 작을수록 쉽습니다. 같은 테이블을 여러 ERD 에 넣어도 됩니다.

  1. 탐색기에서 문서화할 스키마를 우클릭하고 탐색기 우클릭새 ERD... 메뉴를 선택합니다. 결과: 우클릭한 커넥션과 스키마가 선택된 ERD 생성 창이 열립니다.
  2. ERD 제목 칸(1)에 주문 관리 처럼 업무 이름을 적습니다.
  3. 여러 스키마의 테이블을 한 그림에 담아야 하면 Schema 칸(3)에서 전체 (모든 스키마 허용) 항목을 선택합니다. 결과: ERD 는 스키마 하나에 묶이지 않아, 여러 스키마의 테이블을 놓을 수 있습니다.
  4. 확인 버튼(4)을 클릭합니다. 결과: 빈 ERD 탭이 열립니다. 스키마 하나에 묶인 ERD 에는 묶인 스키마의 테이블만 놓을 수 있습니다.

테이블 선택해 가져오기

  1. 탐색기에서 스키마의 Tables 묶음을 펼칩니다. 테이블이 많으면 테이블 필터... 칸(3)에 이름의 일부를 적어 거릅니다.
  2. 테이블 노드(8)를 클릭하고, Ctrl(macOS 는 Cmd)을 누른 채 함께 가져올 테이블을 더 클릭합니다. Shift 를 누른 채 클릭하면 범위로 선택합니다.
  3. 선택한 테이블 가운데 하나를 드래그해 ERD 캔버스에 놓습니다. 결과: NeoSQL 이 DB 에서 테이블의 컬럼, 키, 인덱스, 외래 키, 주석을 읽어 ERD 에 놓습니다. 여러 테이블은 세로로 늘어서고, 함께 가져온 테이블 사이의 외래 키는 관계선으로 그려집니다. DB 는 변경되지 않습니다.
  • 이미 ERD 에 있는 테이블은 건너뜁니다. 빠뜨린 테이블은 같은 방법으로 언제든 더 가져옵니다.
  • 드래그하기 대신 테이블을 우클릭하고 탐색기 우클릭현재 ERD에 추가 메뉴를 선택하면, 앞에 열린 ERD 탭의 화면 가운데에 놓고 ERD 를 바로 저장합니다.
  • 선택하기와 필터의 자세한 규칙은 객체 탐색기 에서 설명합니다.

자동으로 배치하고 묶기

  1. 캔버스 도구 모음의 자동 정렬 버튼을 클릭합니다. 결과: 테이블이 관계를 따라 다시 배치됩니다. 배치는 ERD 에 저장되는 정보이고 DB 와 상관없습니다.
  2. 사람이 읽는 순서에 맞게 몇 개를 드래그해 옮깁니다. 주문 흐름이라면 customer → orders → order_item 이 한 줄로 읽히게 둡니다.
  3. 업무 안에서 다시 나뉘는 부분이 있으면 그룹 추가 버튼으로 사각형을 그려 그룹으로 묶습니다(예: 결제). 결과: 캔버스에 그룹이 생깁니다. 그룹도 배치처럼 ERD 에만 있고 DB 는 변경되지 않습니다.
  4. 전체 보기 버튼으로 전체가 한 화면에 들어오는지 봅니다.

자동 정렬은 손으로 옮긴 배치도 다시 계산합니다. 그래서 가져오기를 마친 뒤 한 번 하고, 그 다음에 손으로 다듬는 순서가 좋습니다. 도구마다의 설명은 ERD 캔버스 에 있습니다.

설명 붙이기

문서로 읽히게 하려면 이름만으로 알 수 없는 뜻을 적어야 합니다. 적는 곳은 세 가지이고, DB 를 변경하는지가 다릅니다.

적는 곳적는 방법DB
논리명테이블 머리의 논리명 입력칸, 컬럼 그리드의 Logical Name 칸변경되지 않습니다. 프로젝트에만 저장됩니다
메모도구 모음의 메모 추가 버튼으로 캔버스에 놓습니다변경되지 않습니다. 이 ERD 에만 있습니다
주석컬럼 그리드의 Remarks 칸, 테이블 상세 패널 의 테이블 코멘트DB 의 COMMENT 입니다. 수정하면 반영을 기다리는 변경이 되고, 변경사항 DB 반영... 버튼으로 반영해야 DB 에 들어갑니다
  1. 정보 패널의 논리 모드 버튼(1)을 클릭합니다. 결과: 컬럼 그리드에 Logical Name 칸이 보입니다.
  2. 테이블을 클릭해 선택하고 테이블과 컬럼의 논리명을 적습니다(예: orders 는 주문, ordered_at 은 주문일시). 결과: 논리명은 DB 를 변경하지 않고 프로젝트에만 저장됩니다.
  3. 표준이 아닌 약어나 업무 규칙처럼 그림을 보는 사람이 알아야 할 것은 메모로 남깁니다. 결과: 메모는 이 ERD 에만 있고 DB 를 변경하지 않습니다.
  4. DB 를 함께 사용하는 사람에게도 보여야 하는 설명이면 주석으로 적고, 나중에 DB 에 반영합니다. DB 를 변경할 수 없는 상황이면 주석은 수정하지 마세요. 결과: 수정한 주석은 DB 반영을 기다리는 변경으로 파란색으로 표시됩니다.
  • DB 에 이미 주석이 있으면 가져올 때 함께 옵니다. 선택하지 않은 테이블은 이름 아래에 테이블 주석이 한 줄로 보입니다.
  • 데이터 사전을 지정한 커넥션에서는 논리명을 적어도 이미 DB 에 있는 컬럼의 이름과 타입이 변경되지 않습니다. 문서화가 변경 대기로 번지지 않게 하기 위해서입니다(데이터 사전으로 표준 이름 사용하기).
  • 물리 모드에서도 논리명을 함께 보이려면 테이블 반대 모드 이름 노출 항목(2)을 활성화합니다. 그리드에 보일 항목은 컬럼 항목 목록(3)에서 선택합니다.

저장하기

  1. 정보 패널의 저장 버튼을 클릭하거나 Ctrl+S(macOS 는 Cmd+S)를 누릅니다. 결과: 배치, 그룹, 메모, 표시 모드, 논리명이 프로젝트에 저장됩니다. 계정 프로젝트라면 같은 계정으로 다른 기기에서도 열립니다.

이미지로 내보내고 공유하기

  1. 도구 모음의 이미지 내보내기... 버튼을 클릭합니다. 결과: ERD 이미지 내보내기 창이 열립니다.
  2. 범위 항목(1)에서 전체 (모든 노드) 항목을 선택합니다.
  3. 포맷 항목(2)에서 문서에 넣을 것이면 SVG, 메신저에 붙일 것이면 PNG 를 선택합니다.
  4. 내보내기 버튼(4)을 클릭해 파일로 다운로드하거나, PNG 이면 클립보드로 복사 버튼(3)으로 복사합니다. 결과: 지금의 표시 모드와 컬럼 항목 설정대로 그린 이미지가 만들어집니다. 논리 모드로 내보내면 업무 담당자용, 물리 모드로 내보내면 개발자용 그림이 됩니다. 로그인하지 않았으면 워터마크가 붙습니다(이미지 내보내기).

이미지 말고 다른 방법으로 공유할 수도 있습니다.

방법사용할 수 있는 곳설명
갤러리 게시와 임베드로그인한 계정 프로젝트의 개인 ERD지금 모습의 사본을 누구나 볼 수 있게 업로드하고, 블로그나 위키에 읽기 전용 뷰어로 넣습니다. 공개 전에 테이블 이름과 주석에 민감한 정보가 없는지 확인하세요(갤러리 게시와 임베드)
팀 ERD로그인한 계정 프로젝트같은 프로젝트의 팀원이 함께 보고 수정합니다(팀과 함께 설계하기)

DB 가 변경되었을 때 다시 맞추기

ERD 는 가져온 순간의 DB 를 담고 있습니다. 다른 도구나 다른 사람이 DB 를 변경하면 ERD 가 저절로 따라가지 않으니, 문서를 다시 볼 때 맞춥니다.

  1. 탐색기에서 스키마의 새로고침 버튼을 클릭합니다. 결과: 테이블 목록을 DB 에서 다시 읽습니다.
  2. ERD 의 테이블을 다시 읽으려면 탐색기에서 선택한 테이블들을 우클릭해 탐색기 우클릭새로고침 메뉴를 선택하거나, ERD 에서 테이블을 선택하고 노드 도구 모음의 새로고침 버튼을 클릭합니다. 결과: ERD 의 테이블이 DB 의 지금 구조로 변경됩니다. 논리명, 메모, 배치는 DB 에 없는 정보라 그대로 보존됩니다.
  3. 아직 DB 에 반영하지 않은 변경(예: 수정한 주석)이 있는 테이블이면 어떻게 할지 묻습니다. DB 의 상태로 맞추려면 교체 버튼을, 반영하지 않은 변경을 남기려면 병합 버튼을 클릭합니다.
  4. 새로 생긴 테이블은 탐색기에서 드래그해 넣고, DB 에서 없어진 테이블은 정보 패널의 ERD에서 제거 버튼으로 ERD 에서 제외합니다. 결과: 제외한 테이블은 ERD 의 그림에서만 빠지고 DB 는 변경되지 않습니다.
  5. 자동 정렬 버튼이나 손으로 배치를 다듬고 저장합니다.
  • 교체 버튼은 반영하지 않은 변경을 모두 버립니다. 수정한 주석을 남기려면 먼저 DB 에 반영하거나 병합 버튼을 선택하세요.
  • 두 DB(예: 개발과 운영)의 구조 차이를 보려면 스키마 비교 를 사용합니다.

다음에 할 일