워크플로 가이드
코드 리뷰와 디버깅을 위한 SQL 포맷 팁
쿼리를 리뷰 가능하게 만들기 위해 포맷한 뒤, 읽기 쉬운 쿼리가 위험한 쿼리로 변하기 전에 join, filter, write operation을 확인합니다.
포맷만으로 SQL이 안전해지지는 않지만, 안전하지 않은 패턴을 더 쉽게 보이게 합니다. clause가 안정적인 줄로 나뉘면 리뷰어는 누락된 join 조건, 넓은 delete, 복사된 literal, filter가 의도한 비즈니스 규칙과 어긋난 부분을 찾기 쉬워집니다.
가독성은 리뷰 도구이지 보증이 아닙니다
포맷된 쿼리도 여전히 쿼리일 뿐입니다. 포맷의 역할은 clause를 분리하고, 중첩을 드러내며, join이나 mutation을 보이게 하는 것입니다. 해당 statement가 대상 database dialect에 유효한지, 실제로 실행해야 하는지는 여전히 판단해야 합니다.
포맷으로 위험한 부분 분리하기
가장 가치 있는 리뷰 대상은 보통 범위와 데이터 무결성에 영향을 주는 곳입니다. 조인, 조건절, 그룹화, 제한, 업데이트 대상, 삭제 필터가 여기에 해당합니다. 쿼리가 읽기 쉬워지면 팀은 빽빽한 한 줄을 믿는 대신 해당 줄을 의식적으로 검토할 수 있습니다.
- 스타일 선호를 보기 전에 join과 filter를 먼저 검토합니다.
- write statement는 읽기 전용 포맷 예시보다 더 높은 위험으로 다룹니다.
- 쿼리에 vendor-specific syntax가 있으면 database dialect를 항상 염두에 둡니다.
A practical browser workflow
쿼리를 붙여넣고 포맷한 뒤, 범위를 정의하는 clause를 확인합니다. 팀이 의도에 동의한 뒤에만 읽기 쉬운 결과를 코드 리뷰, migration note, query console로 복사하세요. 포맷은 리뷰를 가능하게 하는 단계이지 실행을 승인하는 단계가 아닙니다.
관련 읽을거리
가이드와 워크플로
관련 도구
도구 라이브러리