따라 하면 조직의 이름 규칙을 사전에 담아 커넥션에 지정하고, ERD 에서 컬럼의 논리명(예: 주문일시)만 적어 표준 물리명(ord_dtm)과 타입이 함께 정해지게 만듭니다. 이미 DB 에 있는 컬럼은 사전과 대조해 어긋난 곳을 찾고, 수정할지 직접 정합니다. 30분쯤 걸립니다.
사전을 지정할 수 있는 자산은 프로젝트에 따라 다릅니다. 로그인하지 않은 데스크톱의 로컬 프로젝트, 또는 로그인한 계정 프로젝트에서 따라 하세요. 로그인한 채 로컬 프로젝트에서 하면 관리 화면에서 만든 사전이 계정 자산이 되어 지정 목록에 나오지 않습니다 (데이터 사전 의 '로컬 프로젝트에서 지정할 수 있는 것').
준비
- 데모 상점 DB 의 커넥션과, 커넥션의 ERD 가 하나 있어야 합니다(기존 DB 를 ERD 로 문서화하기).
- 단어가 이름을, 도메인이 타입을 정한다는 것과 조합형 사전이 논리명을 읽는 방식을 먼저 읽어 두세요(데이터 사전).
- 예에서 사용하는 도메인과 단어입니다. 자기 조직의 표준이 있으면 그것으로 변경해 따라 하세요.
| 도메인 | 타입 |
|---|---|
| 금액 | DECIMAL(15,2) |
| 일시 | DATETIME |
| 여부 | CHAR(1) |
| 번호 | VARCHAR(20) |
| 단어 | 약어 | 도메인 | 관계 |
|---|---|---|---|
| 주문 | ORD | ||
| 고객 | CUST | ||
| 일시 | DTM | 일시 | 동의어 일자 |
| 번호 | NO | 번호 | |
| 금액 | AMT | 금액 | |
| 사용 | USE | ||
| 여부 | YN | 여부 | |
| 시작 | STRT | 반대어 종료 | |
| 종료 | END |
도메인 팩 만들기
- 앱 메뉴의 항목에서 항목을 클릭합니다. 결과: 데이터 사전 관리 화면이 열립니다.
- 신규 버튼을 클릭하고, 종류 칸에서 도메인 항목을 선택합니다. 이름 칸에
데모 도메인을 적고 저장 버튼을 클릭합니다. 결과: 타입 규칙을 담을 도메인 팩이 만들어집니다. 로그인하지 않았으면 기기의 자산, 로그인했으면 내 계정의 자산입니다. - 도메인 탭의 추가 버튼으로 위 표의 도메인 네 개를 더하고, 팩의 저장 버튼을 클릭합니다. 결과: 도메인 네 개가 팩에 저장됩니다.
도메인의 칸과 DBMS 마다 다른 타입은 도메인 에서 설명합니다. NeoSQL 이 제공하는 공식 팩을 그대로 사용할 거라면 단계를 건너뛰고, 다음 단계에서 사전의 도메인 팩으로 공식 팩을 선택하세요.
사전 만들고 단어 넣기
- 신규 버튼을 클릭하고 종류(1)에서 사전 항목을 선택합니다.
- 사전 방식(2)에서 조합형 항목을 선택하고, 이름을
데모 사전으로 적어 저장합니다. 결과:데모 사전이 조합형 사전으로 만들어집니다. 사전 방식은 나중에 변경할 수 없습니다. - 사전의 도메인 팩 칸에서 도메인 팩 선택 버튼을 클릭하고
데모 도메인을 선택합니다. 결과: 사전이 사용할 도메인 팩이데모 도메인으로 정해집니다. - 단어 탭의 추가 버튼으로 위 표의 단어를 더합니다. 단어마다 단어 칸, 약어 칸, 도메인 칸을 기입하고, 일시에는 동의어
일자를, 시작에는 반대어종료를 정합니다. 결과: 반대어는 양쪽 단어에 함께 적힙니다. - 사전의 저장 버튼을 클릭합니다. 결과: 논리명을 단어로 읽어 약어를 잇는 규칙과, 단어마다 어느 도메인을 사용할지가 사전 하나에 담겨 저장됩니다.
단어의 칸과 동의어, 반대어, 유의어의 차이는 단어 에서 설명합니다.
커넥션에 지정하기
- 프로젝트의 탐색기에서
shop-db커넥션을 우클릭하고 메뉴를 선택합니다. 결과: 커넥션 창이 데이터 사전 탭으로 열립니다. - 사전 선택 버튼(5)을 클릭하고
데모 사전을 선택합니다. 계정 자산이면 버전도 선택합니다. 결과: 창에데모 사전카드가 들어옵니다. - 도메인 칸(2)에 사전이 정한
데모 도메인이 함께 들어온 것을 확인합니다. - 창의 저장 버튼을 클릭합니다. 결과: 커넥션의 ERD 와 테이블 탭에서 논리명을 사전으로 읽게 됩니다. 커넥션은 지정한 시점의 사전을 보므로, 나중에 사전을 수정해도 커넥션이 저절로 변경되지 않습니다(커넥션에 지정).
지정은 프로젝트가 아니라 커넥션 단위입니다. 같은 프로젝트의 다른 커넥션에는 다른 사전을 지정하거나 지정하지 않을 수 있습니다.
논리명으로 새 컬럼 만들기
shop-db의 ERD 를 열고 정보 패널의 논리 모드 버튼을 클릭합니다. 결과: 컬럼 그리드에 Logical Name 칸이 보이고, 도메인 팩을 지정한 커넥션이므로 Domain 칸도 보입니다.- 새 테이블 추가 버튼으로 새 테이블을 놓고, 테이블 머리의 논리명 입력칸에
고객주문을 적습니다. 결과: 테이블 이름이cust_ord로 변경됩니다. 사전이 논리명을 단어로 끊어 약어를_로 잇고, 대소문자는 커넥션 DBMS 의 규칙을 따릅니다. - 그리드의 + 버튼으로 컬럼을 더하고 Logical Name 칸(1)에
주문일시를 적습니다. 결과: 물리명(2)이ord_dtm이 되고, 도메인(3)에 일시가 들어가며, 타입(4)이 도메인의 타입으로 자동 기입됩니다. - 같은 방법으로
주문번호,고객번호,주문금액,사용여부를 더합니다. 결과: 끝 단어의 도메인 후보가 하나면 바로 지정되고, 여럿이면 도메인 칸에 회색 추천으로 남습니다. 추천은 칸의 확인 표시를 클릭하면 지정됩니다. 주문일자처럼 동의어로 적어 보세요. 결과: 논리명이 표준 단어주문일시로 변경되고 물리명은ord_dtm이 됩니다.
- 새 테이블의 컬럼은 아직 DB 에 없으므로 이름과 타입이 바로 변경됩니다. 다 만든 뒤 DB 반영 으로 실제 테이블을 만듭니다.
- 도메인이 정한 값(타입, 길이, NULL 허용 등)을 컬럼에서 직접 수정하면 컬럼의 도메인 지정이 해제됩니다.
- 자동 증가 컬럼을 테이블에 하나만 허용하는 DBMS 에서 다른 컬럼이 이미 자동 증가이면, 도메인의 자동 증가만 제외하고 나머지 값을 적용합니다.
- 같은 이름의 컬럼이 이미 있으면 물리명을 변경하지 않고 물리명을 ord_dtm로 바꾸지 못했습니다. 같은 이름의 컬럼이 이미 있습니다 알림이 표시됩니다.
논리명 칸의 표시 읽기
사전으로 읽은 결과는 논리명 칸에 표시로 남습니다. 표시는 저장하지 않고 볼 때마다 사전으로 다시 계산하므로, 사전을 수정하면 표시도 따라 변경됩니다.
| 표시 | 뜻 |
|---|---|
| 물결 밑줄 | 글자가 사전에 없습니다. 물리명에서 빠졌습니다 |
| 점선 밑줄 | 동의어나 금지어를 표준 단어로 변경해 읽었습니다 |
| 기울임 글씨 | 사전이 만들 물리명과 지금 컬럼 이름이 다릅니다 |
표시가 있는 칸에 마우스를 올리면 칸 끝에 아이콘이 나타납니다. 클릭하면 검토 필요 메뉴가 열려, 걸린 단어를 미등록, 불일치, 유의어, 반대어 열의 표로 보여 주고 수정할 항목을 내놓습니다.
기존 컬럼을 사전과 대조하기
이미 DB 에 있는 컬럼은 논리명을 적어도 이름과 타입이 변경되지 않습니다. 문서화하려고 논리명을 붙였을 뿐인데 DB 반영을 기다리는 변경이 쌓이거나 길이가 줄어 데이터가 잘리지 않게 하기 위해서입니다. 대신 어긋난 곳이 표시되고, 수정할지는 컬럼마다 직접 정합니다.
- ERD 에 있는
orders를 선택하고,ordered_at컬럼의 Logical Name 칸에주문일시를 적습니다. 논리 모드에서는 컬럼 이름 열이 기본으로 숨어 있으니, 이름을 함께 보려면 정보 패널에서 컬럼 이름 열을 활성화합니다. 결과: 컬럼 이름은ordered_at그대로이고, 논리명이 기울임 글씨(1)로 변경됩니다. - 칸 끝의 아이콘을 클릭합니다. 결과: 메뉴가 열리고, 메뉴의 표(2)에서 주문과 일시가 불일치 열에 걸려 있습니다. 사전의 약어(
ord,dtm)와 지금 이름의ordered,at이 다르기 때문입니다. - 이름을 표준으로 변경하려면 물리명을 ord_dtm로 변경 항목(3)을 클릭합니다. 문서화만 할 거라면 클릭하지 않습니다. 결과: 컬럼 이름이 변경되고, DB 에 있는 컬럼이므로 이름 변경이 DB 반영을 기다리는 변경이 됩니다. 도메인은 추천까지만 갑니다. 이름을 변경하겠다는 대답이 타입까지 변경해도 좋다는 대답은 아니기 때문입니다. 타입을 맞추려면 도메인 칸에서 직접 선택합니다.
메뉴로 수정하기
검토 필요 메뉴에는 칸에 걸린 일만 나옵니다.
| 항목 | 나오는 때 | 하는 일 |
|---|---|---|
| 단어 등록 항목 | 사전에 없는 글자가 있을 때. 글자마다 한 줄 | 바로 약어와 도메인을 적어 커넥션의 사전에 넣고, 클릭한 컬럼의 물리명을 다시 만듭니다. 다른 컬럼의 이름은 변경되지 않습니다 |
| 표준단어로 표준화 항목 | 논리명에 동의어나 금지어가 남아 있을 때 | 논리명을 표준 단어로 변경합니다. 물리명은 변경하지 않습니다 |
| 물리명을 ord_dtm로 변경 항목 | 사전이 만들 물리명과 지금 이름이 다를 때 | 컬럼 이름을 사전대로 변경합니다 |
| 반대어 '종료' 컬럼 추가 항목 | 반대어가 있는 단어를 사용했고, 짝이 될 컬럼이 아직 없을 때 | 바로 아래에 짝 컬럼(예: 시작일시 옆에 종료일시)을 더합니다 |
| 상세 정보 항목 | 사전의 단어를 읽었을 때 | 읽은 단어의 상세(약어, 도메인, 관련어)를 봅니다 |
- 새 테이블에
배송일시를 적어 봅니다. 결과: 배송이 사전에 없어 물결 밑줄이 붙고, 물리명은dtm만 남습니다. - 칸 끝의 아이콘(1)을 클릭하고 단어 등록 항목(2)을 클릭합니다. 결과: 단어 추가 창이 열립니다.
- 창에 약어
DLV를 적고 추가 버튼을 클릭합니다. 결과: 물리명이dlv_dtm으로 변경됩니다. 등록한 단어는 커넥션에서만 수정한 내용으로 저장되고, 원본 사전은 그대로입니다. 원본에도 넣으려면 관리 화면에서 사전을 수정하거나, 데이터 사전 패널의 복제로 새 자산을 만듭니다(커넥션에 지정).
Reverse Engineering 으로 가져온 테이블처럼 사전을 지정하기 전에 적은 논리명에는 자동 표준화가 걸리지 않습니다. 그런 칸은 점선 밑줄로 보이니 표준단어로 표준화 항목으로 맞춥니다.
테이블 이름도 같은 방식입니다
테이블 머리의 논리명 입력칸도 같은 사전으로 읽습니다. 새 테이블은 논리명을 적으면 이름이 바로 변경되고, DB 에 있는 테이블은 이름이 사전과 다르면 논리명 옆에 다시 만들기 아이콘이 보입니다. 아이콘을 클릭하면 테이블 이름이 변경됩니다. 테이블 논리명은 DB 의 테이블 주석을 변경하지 않습니다.
다음에 할 일
- DB 반영: 새로 만든 테이블과 이름을 변경한 컬럼을 DDL 로 확인하고 실행합니다.
- 커넥션에 지정: 지정한 사전을 커넥션에서만 수정해 사용하고, 수정한 상태를 새 자산으로 복제합니다.
- 게시, 버전과 백업: 계정 자산을 게시해 팀과 같은 표준을 사용합니다.
- 기존 DB 를 ERD 로 문서화하기: 논리명을 붙여 문서로 공유합니다.