SQL 포매터

정상 동작

의미를 바꾸지 않고 쿼리를 정리하세요. 포매터는 의도적으로 신중하게 작동합니다.

포매터는 설정 가능하지만, 의도적으로 신중하게 설계되었습니다. SQLly 출력을 토큰 단위로 다시 렉싱하고 비교합니다. 입력과 대조합니다. 조금이라도 다르면 SQL은 그대로 둡니다. 주석이나 리터럴은 절대 건드리지 않으면서 다시 들여쓰기, 키워드 대소문자 정리, 절 정렬을 합니다.

SQL 포맷

다음을 누르세요 ⌥⇧F (Alt+Shift+F Windows와 Linux에서) 다음을 선택하세요 편집 › 문서 서식, 또는 우클릭 › 문서 포맷 선택 상태와 관계없이 쿼리 전체의 서식을 지정합니다. 선택 영역만 서식을 지정하려면, ⌘K ⌘F (Ctrl+K Ctrl+F) 사용 선택 영역 포맷. 두 단축키는 다음에서 바꿀 수 있습니다 설정 › 작업 공간 › 키보드 단축키. 또한 선택할 수 있습니다 쿼리 › SQL 포맷팅, 툴바 버튼을 쓰거나 명령 팔레트에서 실행할 수도 있습니다: 텍스트를 선택한 상태에서는 선택 영역만, 아니면 전체 쿼리를 포맷합니다. 기본 설정으로 포맷한 한 줄짜리 쿼리는 다음과 같습니다:

-- before
select o.OrderId, c.Name, sum(l.Qty * l.Price) as total from dbo.Orders o join dbo.Customers c on c.Id = o.CustomerId left join dbo.OrderLines l on l.OrderId = o.OrderId where o.Status = 'open' and o.Total > 100 group by o.OrderId, c.Name order by total desc

-- after
SELECT
    o.OrderId,
    c.Name,
    SUM(l.Qty * l.Price) AS total
FROM
    dbo.Orders o
    JOIN dbo.Customers c ON c.Id = o.CustomerId
    LEFT JOIN dbo.OrderLines l ON l.OrderId = o.OrderId
WHERE
    o.Status = 'open'
    AND o.Total > 100
GROUP BY
    o.OrderId,
    c.Name
ORDER BY
    total DESC

키워드와 함수는 대문자로 작성되며, 각 주요 절은 새로운 줄에서 시작하고, 선택 목록은 한 줄당 한 열씩 쌓이며, 테이블은 FROM (고유의 JOIN들)과 다음 뒤에 오는 조건 WHERE 그리고 HAVING 각자 자기 들여쓰기 줄에 놓이며, AND/OR 줄의 맨 앞에 옵니다. 80자 안에 들어가는 단일 문장은 한 줄로 유지됩니다: SELECT id, name FROM dbo.Users WHERE id = 1. 별도로 고르지 않으면 들여쓰기는 편집기의 탭 설정을 따릅니다.

SQLly
Format SQL을 실행한 편집기 화면으로, 조인이 여러 개인 Orders 쿼리에 키워드는 대문자로, 절은 줄마다 나뉘어 표시됩니다Format SQL을 실행한 편집기 화면으로, 조인이 여러 개인 Orders 쿼리에 키워드는 대문자로, 절은 줄마다 나뉘어 표시됩니다
Format SQL을 적용한, 여러 조인이 있던 한 줄짜리 쿼리: 키워드는 대문자, 열은 한 줄에 하나씩, 절은 정렬된 모습

입력하면서 포맷

그 입력하면서 포맷 맨 위의 토글 설정 › 편집기 › 서식 입력하는 동안 서식이 정리됩니다. 이 기능을 켜면 엔터 를 누르면 입력 중인 문장이 다시 포맷되고 캐럿은 전과 같은 문자 바로 뒤에 그대로 있어 그 자리에서 계속 입력할 수 있습니다. 기본값은 꺼짐이며, 꺼져 있을 때는 필요할 때 Format Document(⌥⇧F macOS에서는, Alt+Shift+F Windows 및 Linux에서, 다음에서 다시 지정 가능 설정 › 작업 공간 › 키보드 단축키).

다음 경우에는 Enter를 눌러도 텍스트가 변경되지 않습니다:

  • 텍스트가 선택되었거나 여러 커서를 사용하여 편집 중입니다;
  • 탭이 Redis 연결에 있어 편집기가 SQL 대신 명령을 다루는 경우;
  • 명령문이 statement 키워드로 시작하지 않습니다: SELECT, INSERT, UPDATE, DELETE, WITH, CREATE, ALTER, DROP, MERGE, TRUNCATE, GRANT, REVOKE, BEGIN, DECLARE, 또는 EXEC.

스크립트 및 GO 배치

여러 문장이 담긴 스크립트는 한 번에 한 문장씩 포맷되고 각 문장은 자기 줄에서 시작하며, 한 줄 단축 포맷은 전체가 단일 문장일 때만 적용됩니다. 문장은 다음에서 끝납니다 ; 그리고 SQL Server의 경우에는 GO 배치 구분자. GO 항상 자신의 줄을 유지하며, 다른 키워드와 같은 대소문자로 표기되고, 반복 횟수(GO 5)나 같은 줄에 붙는 주석:

-- before
select 1
go
select name from dbo.Users
go

-- after
SELECT
    1
GO
SELECT
    name
FROM dbo.Users
GO

GO 은(는) 개수나 주석만 더 담은 줄을 시작할 때만 구분자로 간주되며, 문장 사이에 다음이 기대하는 대로 놓입니다 sqlcmd 와 SSMS가 기대하는 형태입니다. 이름이 go SELECT 목록 중간에, [go], 그리고 go 문자열이나 주석 안에 있는 것은 일반 SQL 그대로 둡니다. 방언이 자동 감지 모드일 때는, GO 줄은 스크립트를 SQL Server로 표시합니다. 다른 엔진으로 설정된 경우, GO 은 구분자가 아닙니다.

설정

이 모든 것이 모이는 곳은 설정 › 편집기 › 서식, 실시간 미리보기가 있습니다: SQL을 붙여넣고 설정을 바꿔 가며 어떻게 달라지는지 바로 보입니다. 가장 빠른 시작 방법은 프리셋:

프리셋스타일
기본값위에 표시된 레이아웃입니다.
컴팩트짧은 절과 SELECT 목록은 한 줄에 유지되고, AND/OR 는 줄 끝에 붙습니다.
확장선행 쉼표, 주요 절 앞의 빈 줄, ON 자체 줄에 나오며, 연산자, 데이터 타입 및 별칭이 정렬됩니다.
대문자 키워드 / 소문자 키워드해당 경우의 키워드와 함수가 포함된 기본 레이아웃입니다.
기존 유지대소문자, 쉼표, 절 배치는 그대로 두고 나머지만 다듬습니다.

프리셋을 선택하면 모든 레이아웃 설정이 재작성되지만 형식 트리거(입력하면서 포맷, 저장할 때 포맷, 그리고 붙여넣을 때 포맷), 그래서 다른 프리셋을 골라도 더 이상 꺼지지 않습니다. 이후에 설정을 하나만 바꾸면 다음으로 전환됩니다 사용자 지정로 전환됩니다. 개별 섹션에서 키워드 대소문자(전체 또는 데이터 타입, JOIN처럼 그룹별), 식별자 대소문자와 인용, 절 배치, select 목록, 쉼표 스타일, 불리언 조건, CASE연산자, JOIN, 함수, 서브쿼리 및 CTE, DML, DDL, 주석, 들여쓰기, 줄 길이(기본 120) 및 문을 다룹니다. SQL 방언 이 설정의 기본값은 자동 감지이며, SQL 자체에서 방언을 알아냅니다.

저장할 때 포맷 그리고 붙여넣을 때 포맷 아래에 있습니다 포맷 트리거. 둘 다 기본적으로 꺼져 있습니다.

FROM과 WHERE 위치

다음 아래의 두 가지 설정은 절 레이아웃 절의 본문을 키워드가 있는 줄에서 시작할지, 그 아래 별도로 들여쓴 줄에서 시작할지 고르세요:

옵션기능
FROM 뒤에 오는 테이블새 줄, 들여쓰기 (기본값)은 첫 번째 테이블을 다음 아래의 별도 줄에 놓습니다 FROM, 그리고 자기와 나란히 놓습니다 JOIN들을 그 줄에 맞춰 정렬합니다; ON 자신만의 줄에서는 한 단계 더 들여쓰기를 합니다. 키워드와 같은 줄 은(는) 테이블을 FROM 줄, 함께 JOIN이 배치되는 방식을 정하는 것은 JOIN 레이아웃 설정.
WHERE / HAVING 다음 첫 번째 조건새 줄, 들여쓰기 (기본값)은 첫 번째 조건을 다음 아래의 별도 줄에 놓습니다 WHERE 또는 HAVING, 다음과 정렬된 AND/OR 뒤따르는 줄들과 맞습니다. 키워드와 같은 줄 키워드가 있는 줄에 그대로 둡니다.

그 컴팩트 그리고 기존 유지 프리셋은 둘 다 키워드의 줄에 유지합니다. 바로 뒤에 작성한 주석은 FROM 또는 WHERE 그 줄에 그대로 남습니다.

CTE, DML, 그리고 인덱스 열

이 옵션들은 흔한 문장 형태를 어떻게 배치할지 정합니다:

옵션기능
CTE 스타일스택형 (기본값)은 각 CTE의 본문을 별도의 줄에 놓습니다. 인라인 는 각 CTE의 name AS ( … ) 를 한 줄에 놓습니다. CTE에 포함된 내용은 -- 주석이 붙은 줄이나 최대 줄 길이를 넘을 줄은 그대로 쌓아 둡니다.
DML 스타일표준 (기본값)은 일반적인 레이아웃입니다. 컴팩트 는 다음 중 하나를 INSERT, UPDATE, DELETE, 또는 MERGE 최대 줄 길이에 맞으면 한 줄에. 확장 는 각각의 INSERT 열, 각각 VALUES 항목, 그리고 각각 UPDATE SET 할당은 자기 줄에 따로 쓰고 다음에 의해 한 줄로 합쳐지지 않습니다 짧은 쿼리는 한 줄로 유지.
여러 줄 인덱스 열인덱스가 둘 이상의 열을 가질 때는 각 키 열과 각 INCLUDE 열 CREATE INDEX 별도의 줄에 적습니다. 다음도 마찬가지입니다 PRIMARY KEY, UNIQUE, INDEX, 그리고 KEY 열 목록 내부 CREATE TABLE. FOREIGN KEY 열 목록은 그대로 둡니다.
후행 주석을 표현식과 함께 이동다음과 함께 사용 인라인 주석은 인라인으로 유지. 둘 다 켜면 줄 끝에 있는 -- comment 포매터가 해당 줄을 다시 나눈 후에도 코드 줄 끝에 남아 있습니다.

그 컴팩트 그리고 확장 프리셋은 이 그룹의 일치하는 옵션을 켭니다. 다음에서는 CREATE INDEX … ON table (…), 테이블 이름은 대소문자를 유지합니다; 더 이상 키워드처럼 대문자로 변환되지 않습니다.

자동 완성은 설정을 따릅니다

당신이 수락할 때 IntelliSense 제안을 받아들이면 SQLly가 Format SQL이 그 문장을 배치하던 방식 그대로 삽입합니다. 키워드와 함수의 대소문자, 식별자의 대소문자와 인용 방식, JOIN 그리고 ON 배치 및 나머지 서식 설정입니다. 예를 들어, ON 절 배치 설정됨 새 줄에, 조인 제안 는 다음 ON 을(를) 자체 줄에 둡니다. 다음 문이 한 줄에 들어갈 만큼 짧으면 짧은 쿼리는 한 줄로 유지 제안은 Format SQL을 썼을 때처럼 한 줄로 유지됩니다. 포매터가 결과를 입력한 내용과 맞추지 못하면 제안이 있는 그대로 삽입됩니다.

SQL을 그대로 두기

포매터가 간섭하지 않고 입력한 그대로 둘 영역을 표시하세요:

-- formatter:off
SELECT weird , hand_aligned
       , columns   -- left exactly as typed
FROM t;
-- formatter:on

스위치는 한 번에 한 명령문씩 작동합니다. 다음 이후에 시작하는 명령문은 -- formatter:off 은(는) 그대로 유지되고, 그 뒤의 모든 문장도 마찬가지입니다. 다음 표시가 나올 때까지 유지됩니다 -- formatter:on전까지 그대로 유지됩니다. 마커가 문장 중간에 있으면 일부를 보호하지 못 하므로, 문장 끝은 ; 또는 GO 줄에 표시됩니다. 마커는 다음으로 끌 수 있습니다 제어 주석 준수 댓글 섹션에서 남깁니다.

SQL에는 아무 해도 없습니다. 토큰 검사 덕분에 포매팅 버그는 SQL을 망치는 대신 아무 일도 일어나지 않는 것(no-op)으로 끝납니다. 종결되지 않은 문자열이나 주석처럼 토큰이 깔끔하게 나눠지지 않는 SQL은 다시 배치하지 않고 그대로 돌려 주고, 주석은 절대 버려지지 않습니다.

Redis 연결에서는 Format SQL이 아무 작업도 하지 않습니다. Redis 편집기에는 SQL이 아닌 명령이 담기기 때문입니다.

SQL 축소

반대로 로그, JSON 페이로드, 커맨드라인용으로는 한 줄로 압축하고, SQL 축소 일반 주석을 제거하고 모든 공백을 공백 하나로 압축하지만, 문자열 리터럴, 따옴표로 묶인 식별자, 달러 인용 본문은 그대로 두므로 압축된 SQL도 원본과 완전히 똑같이 실행됩니다. -- sqlly 지시문 주석과 /*+ hint */ 옵티마이저 힌트는 그대로 유지되고, SQL Server의 GO 구분자는 서버가 요구하기 때문에 자기 줄을 유지하고, 깔끔히 파싱되지 않는 SQL은 망가뜨리지 않고 그대로 둡니다.

축약할 SQL을 선택하거나, 문 안에 커서를 놓거나, 아무것도 선택하지 않은 채 전체 쿼리를 축약한 다음 ⌘⌥⇧F (Ctrl+Alt+Shift+F Windows와 Linux에서) 다음을 선택하세요 쿼리 › SQL 축소, 또는 명령 팔레트에서 실행하세요. 결과는 하나의 취소 가능한 편집으로 나타나므로, 한 번의 실행 취소로 포맷된 SQL을 복원할 수 있습니다.