SQL 스타일 가이드: 가독성 높은 SQL 코드 작성 방법

1. SQL Style Guide

https://www.sqlstyle.guide/

SQL style guide by Simon Holywell

 

 

[요약정리]

SQL 작성 시 일관성과 가독성은 코드 유지보수와 협업에서 핵심 요소다. 특히 여러 사람이 협업하는 프로젝트에서는 통일된 스타일대로 하는 것이 중요한데, 프로그래밍 코드뿐만 아니라 SQL도 마찬가지다.

 

오늘 내가 읽은 SQL 스타일 가이드는 이러한 일관된 스타일을 유지하는 데 필요한 부분과 가이드 라인을 제시한다. 

SQL 스타일 가이드의 주요 내용과 이를 통해 얻을 수 있는 효과에 대해 정리해보겠다. 

 

 

 

1. SQL 스타일 가이드란?

• SQL문 작성시 따라야 할 일관된 코딩 규칙을 제공하는 가이드
• 네이밍 규칙부터 다양한 스타일 요소를 포함한 SQL 코드의 일관성을 높이고 가독성을 개선해 준다
• 가이드에 맞춰 작성하면 SQL 쿼리가 한눈에 들어오고 협업이 수월해진다!

 

 

2. 주요 스타일 가이드

2.1. 대소문자 사용

• 키워드는 대문자: SELECT, FROM, WHERE와 같은 SQL 키워드는 대문자로 강조
• 테이블, 열 이름은 소문자: 일관성 유지

SELECT student_id, first_name, last_name
FROM student
WHERE sex = 'F';

 

2.2. 인덴트와 줄 바꿈

• 정렬된 인덴트: 각 절마다 줄을 바꿔 작성하고, 필요한 경우 특정 부분을 인덴트한다
• 조건부 줄 바꿈: AND, OR 같은 조건이 붙는 경우 새 줄에 작성하여 가독성을 챙긴다

SELECT student_id, first_name, last_name
FROM student
WHERE sex = 'F'
  AND enroll_date > '2023-03-02';

 

2.3. 테이블, 열 이름

• 단수형 테이블 이름: 복수형 대신 단수형 사용하여 간결하게 표현하기
• 명확한 열 이름: id, name보단 student_id, student_name과 같이 명확한 이름을 붙여 의미를 분명히 하기

2.4. 주석 처리

• 단일 줄 주석: '--'를 사용하여 필요한 부분에 주석 추가. 코드 목적을 설명해 주어 유지보수가 쉽다

-- 2023년 3월 2일 이후 입학한 여학생 가져오는 쿼리
SELECT student_id, first_name, last_name
FROM student
WHERE sex = 'F'
  AND enroll_date > '2023-03-02';

 

 

 

3. SQL 스타일 가이드 효과

1. 가독성 향상: 일관된 코드로 인해 더 쉽게 읽고 이해할 수 있어, 디버깅과 코드 리뷰 시간을 줄일 수 있다

2. 협업 효율성 증가: 동일한 스타일을 유지하면 팀원 간 코드 이해가 쉬워져, 협업이 더 원활하게 진행된다

3. 오류 감소: 명확한 인덴트와 일관된 네이밍 규칙을 통해 코드 오류를 사전에 막을 수 있다

4. 유지보수성 강화: 직관적이고 깔끔한 코드를 작성하면 향후 수정할 때 쉽게 접근할 수 있

 

 

 

---

 

🤔 이에 대한 나의 생각

SQL 스타일 가이드를 통해 SQL 코드 작성 시 가독성과 일관성을 유지하는 것이 얼마나 중요한지 다시금 느낄 수 있었다.

작은 규칙들이지만 이를 잘 지키면 협업할 때 훨씬 더 효율적으로 작업할 수 있을 것이라 생각한다.

그동안 SQL 는 코드가 아니라고 생각해서 그런지.. 간단한 규칙들임에도 잘 지키지 않아 왔던 그동안의 나를 반성하게 되었다

앞으로 SQL 작성 시 이 가이드라인을 준수하여 더욱 깔끔하고 직관적인 코드를 작성할 수 있도록 신경 써야겠다!ㅎㅎ