테이블명세서 양식 - teibeulmyeongseseo yangsig

Question

백엔드 개발하면 DB도 같이 염두해야하는 경우가 잦다.

목차 Show

단지 개발뿐만이 아니라, 회원가입 이나 게시판 같은거는 DB도 함께 봐야하는 경우가 생긴다.

그럴 경우에 DB를 굳이 들어가지 않아도 명세서만 보면 파악할 수 있다.

나 혼자 개발하는게 아니라면, DB설계하는 분은 꼭 DB명세서를 작성해야한다고 생각한다.

파일 96개 모두 엑셀

이렇게 쌓여가는 자료들을 보면 뿌듯한데, 물론 이 폴더에는 쓰는것도 있고, 쓰지 않고 기획,기능변경으로 무산된것들도 많다.

DB 테이블 상세서 원본.xls

0.01MB

내가 사용하는 DB 테이블 상세서 원본이다.

( 다른 블로그에서 구한거 같은데 혹시 출처아시는분은 댓글로 부탁드립니다ㅠ

찾으려고 하니까 블로그 못찾겠어요ㅠㅠ 알려주시면 추가할게요 )

아래는 내가 실제로 작성한 원본이고, 현재 사용은 안한다.

설명은 적어주는게 좋은데, 안적으면 이름만 봐서는 정확히 무슨 용도를 위해 만들어진 것인지를 모른다.

그대로 배껴쓰지는 말고, 예시로만 사용해줬으면 한다.

08.25 QNA테이블 구상.xls

0.01MB

그리고 위의 저 파일을 보고 적으면 아래처럼 된다.

CREATE TABLE mb_serviceqna (
	id int(11) comment '테이블 내부 정리 번호' auto_increment,
	category varchar(20) comment '카테고리',
	title text comment '제목',
	date datetime comment '작성 날짜',
	content text comment '내용',
	
	PRIMARY KEY (id)
);

사람마다 코딩방법이 다른 것처럼 sql문 작성방법도 미묘하게 차이가 있다고 생각한다.

나 같은 경우엔 인덱스명, 자료명 , 코멘트, AI, not null 의 순서로 적는다.

간혹 코멘트를 가장 뒤에 적으시는 분들도 있는데, 그건 본인의 자유라고 생각한다.

[DOC] 테이블 정의서(DB설계서)

2014. 3. 18. 23:56ㆍ소소한 일상

DB설계시 설계 가장 기본이 되는 설계서 양식이다.

기본에 충실히...

테이블정의서.doc

'소소한 일상' 카테고리의 다른 글

[XLS] 고등학교 코드 (0)	2014.04.17
SKT 도대체 어쩌자는 거지??(통신장애) (1)	2014.03.20
이미지맵 제작(Imagemapic) (0)	2014.03.18
기계식키보드 LEOPOLD FC200R Tenkeyless (0)	2014.03.17
[PPT] 스티브 잡스 PPT 양식 (5)	2014.03.14

TAG

Database, DB설계, DB설계 양식, 데이터베이스, 디비 설계서, 양식, 테이블 정의서, 테이블 정의서 양식

Summry

본 문서에서는 mysql workbench에서 쿼리를 이용하여 이용하여 테이블 명세서 만드는 방법을 정리한다.

send me email if you have any questions.

테이블명세서란 각 테이블의 사용목적, 이름, 작성자, 비고사항 등의 테이블에 대한 기록 뿐만 아니라 테이블에 포함된 각 컬럼의 이름, 데이터 타입 및 제약조건을 기록한 문서양식을 말한다.
일반적으로 엑셀에 정리를 하는데 테이블의 이름, 설명, 칼럼 등을 직접 타이핑하기에는 시간도 오래 걸리고 오타 등 실수가 있을 수 있다. 하지만 아래에서 설명할 쿼리를 이용해 테이블의 정보를 추출하면 복사·붙여넣기를 사용해 쉽게 정리할 수 있다.

query form

SELECT
   t1.table_name, t1.table_comment, column_name, data_type, column_type, column_key, is_nullable, column_default, extra, column_comment
FROM
   (SELECT
       table_name, table_comment
    FROM
       information_schema.TABLES WHERE table_schema='스키마명') t1,
   (SELECT
       table_name, column_name, data_type, column_type, column_key, is_nullable, column_default, extra, column_comment, ordinal_position
    FROM
       information_schema.COLUMNS WHERE table_schema='스키마명') t2
WHERE
    t1.table_name = t2.table_name
ORDER BY
    t1.table_name, ordinal_position;