MySQL Convention - Heart-Lee/server GitHub Wiki

기본 이름 규칙

• 모든 이름은 snake_case를 사용한다.
• 되도록 약자를 쓰지 않고 바로 의미를 알 수 있는 영단어를 사용한다.(Java Convention 비슷)
• 의미 없는 prefix, suffix를 사용하지 않는다.

테이블

• 테이블명은 단수로 사용한다.

• 우리는 Native가 아니라서 불규칙 동사형에서 실수를 하고는 한다.

• 특별한 케이스가 아니면 1:1 관계는 되도록 만들지 않는다.

프라이머리키

• id: 기본값. 되도록 bigint(unsigned) auto increment 를 사용한다.

• code: 임의의 값을 사용하는 경우 code를 사용한다.

• uuid: uuid의 경우 허용

외래키

• 최소한의 데이터 무결성 및 참조 인덱스를 위해 외래키를 필수로 사용한다.

• CASCADE 조건을 생각하여 추가한다.

• 기본적으로 참조되는 컬럼명은 table_id 와 같은 형식을 사용한다.

• 행위중심의 참조키를 사용하거나, 단일테이블에 대한 다중 참조의 경우 다음과 같이 by, for 와 같은 전치사를 사용할 수도 있다.

  • written_by, recorded_for

• 부모/자식간의 관계를 나타내는 parent_id를 사용할 수 있다.

Polymorph

• ref 를 기본 morph 명으로 사용한다.

  • ref_type, ref_id

• 다중 참조인 경우 중간에 구체적인 참조 타입을 붙인다.

  • ref_model_type, ref_model_id

시간/날짜 컬럼

• timestamp 형식을 timezone과 함께 사용한다. 날짜만 있는 경우는 date 혹은 char(10) 을 사용한다.

• 프로그램에 의해 자동으로 기록되거나 과거의 시각 같은 경우 "과거분사_at" 이름 패턴을 사용한다.

  • created_at, updated_at, deleted_at

• 사용자가 입력하는 시간은 ‘_on’, ‘_to’ 이름 패턴을 사용한다.

  • send_on, registered_on, start_on, end_on

  • due_to

• 되도록이면 모든 테이블에 다음과 같은 record 생성, 수정 시각 컬럼을 생성한다.

  • created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP

  • updated_at TIMESTAMP ON UPDATE CURRENT_TIMESTAMP

다큐먼트/비정형(doc) 데이터 컬럼

• doc JSON
  • json validation 을 위해 JSON Type을 사용한다.
• 다음의 경우 다큐먼트/비정형 데이터를 적극적으로 쓰도록 하자.
  • 인덱스가 필요하지 않은 컬럼들
  • 잦은 alter 가 예상되는 불명확한 테이블 데이터
  • schemaless 모델 구조를 지향하는 사용하는 경우