SQLC

핵심 개념

Query File

개발자가 작성하는 .sql 파일로, 실제 실행할 SQL 쿼리와 함께 SQLC 전용 주석(annotation)을 포함합니다. 이 주석으로 생성할 함수 이름과 동작 방식을 지정합니다.

Schema File

데이터베이스 테이블 구조를 정의한 DDL 파일입니다. SQLC는 이 스키마를 분석해 각 테이블에 대응하는 Go 구조체를 생성합니다.

Code Generation

SQLC가 SQL 파일과 스키마를 분석해 Go 코드를 자동 생성하는 과정입니다. 쿼리 파라미터와 결과를 타입 안전하게 다룰 수 있는 함수와 구조체가 만들어집니다.

sqlc.yaml

SQLC 설정 파일로, 어떤 SQL 파일을 읽을지, 어느 디렉토리에 코드를 생성할지, 어떤 데이터베이스 엔진을 사용할지 등을 명시합니다.

Query Annotation

SQL 주석으로 작성하는 SQLC 메타데이터입니다. -- name: GetUser :one 같은 형태로 생성할 함수 이름과 반환 타입(one, many, exec 등)을 지정합니다.

SQLC 기본 설정 및 쿼리 예시

설정 파일과 스키마, 쿼리를 작성한 뒤 sqlc generate 명령을 실행하면 GetUser, ListUsers 함수와 User 구조체가 Go 코드로 생성됩니다.

# sqlc.yaml
version: "2"
sql:
  - schema: "schema.sql"
    queries: "query.sql"
    engine: "postgresql"
    gen:
      go:
        out: "db"

# schema.sql
CREATE TABLE users (
  id SERIAL PRIMARY KEY,
  name TEXT NOT NULL
);

# query.sql
-- name: GetUser :one
SELECT * FROM users WHERE id = $1;

-- name: ListUsers :many
SELECT * FROM users;