매직 문자열 자동 문서화

예정됨

뜻을 알 수 없는 값을 DDL을 따라 추적하고, 다음 사람, 어쩌면 미래의 자신에게 유용한 메모를 남겨 두세요.

결과 집합에서 낯선 코드를 발견했나요? SQLly가 값을 끝까지 추적할 수 있을 때 DDL 인트로스펙션, 값이 어디서 왔는지 설명하는 인라인 메모를 남겨서, 쿼리가 자기 사정을 조금 더 스스로 설명해 줍니다.

SELECT status /* ← enum: orders.status_id → status_codes.code */

설명이 어디서 오는지

스키마에서 가져오되 신뢰할 수 있는 정도 순으로 - 무엇을 사용했는지는 노트에 표시됩니다:

  1. 외래 키. 값은 다른 테이블을 가리키는 ID입니다. 이를 따라가 참조되는 테이블과 그 읽기 쉬운 열을 지정하세요.
  2. CHECK 제약 조건. 몇 개 리터럴로만 쓰게 제한된 열은 이름만 빼면 열거형이고, 제약 조건이 허용값을 그대로 알려 줍니다.
  3. 조회 테이블. 코드-설명 행을 선언된 키가 아닌 이름으로 조인해 만든 작은 테이블로, 아주 흔하고 알아 둘 가치가 있는 패턴입니다.
  4. 확장 속성 또는 열 설명 - 팀이 이미 답을 적어 뒀는데 아무것도 보여 주지 않았던 바로 그곳입니다.
노트는 주석일 뿐이며, 절대 재작성하지 않습니다. 설명은 SQL 주석으로 삽입되므로 다른 곳에서는 아무 동작도 하지 않고, 리포지토리에 커밋해도 남아 있으며, 키 한 번으로 지울 수 있습니다. 쿼리가 뜻하는 바는 그대로입니다.

문서는 덤으로 따라옵니다

기분 좋은 건 나아가는 방향입니다: 어차피 찾아보려던 것이고, 이 메모는 다음 사람, 어쩌면 미래의 자신도, 다시 찾아보지 않아도 됩니다. 이는 스키마 문서화, 데이터베이스 통째로 한꺼번에 바꾸는 대신, 수상한 값을 한 번에 하나씩 적용했습니다.

계획됨. 필요한 관계와 제약 모델은 이미 존재하고 이미 다음의 기반이기도 합니다 조인 제안 그리고 표시 값 해석; 이것은 새로운 지식이 아니라 기존 지식 위에 얹은 새로운 인터페이스입니다.