코드 생성 설정

도구용 프로젝트에 @sqlbraid/cli, @sqlbraid/codegen, 선택한 방언, 드라이버를 설치하세요. 그리고 실행 가능한 Node 설정 파일(.mjs, .js, .cjs)을 만드세요.

import { defineConfig } from "@sqlbraid/cli/config";
import { typePolicyForProfile } from "@sqlbraid/postgres";

const typePolicy = typePolicyForProfile({ json: "text", temporal: "text" });

export default defineConfig({
  codegen: {
    targets: [
      {
        name: "main",
        metadata: "./db/main.metadata.json",
        outFile: "./src/generated/database.ts",
        typePolicy,
        filters: { includeNamespaces: ["public"] },
      },
    ],
  },
});

설정 파일이 있는 프로젝트에서 다음 명령을 실행하세요.

sqlbraid codegen
sqlbraid codegen --config ./sqlbraid.config.mjs
sqlbraid codegen --target main --check
sqlbraid codegen --json

메타데이터와 출력 경로는 설정 파일 기준 상대 경로입니다.

• 여러 대상을 고르려면 --target을 반복하세요.
• 출력을 쓰기 전에 선택한 대상을 모두 검증합니다.
• 내용이 바뀌지 않은 생성 파일은 수정 시각(mtime)이 그대로 유지됩니다.
• JSON 결과는 I/O가 성공한 뒤에만 written을 보고합니다.

설정 파일은 CLI가 실행하는 신뢰된 Node 코드입니다. 샌드박스가 아닙니다. 스키마 변경을 사람이 검토해야 한다면 메타데이터와 생성된 출력을 버전 관리에 넣으세요.

선택한 TypePolicy는 표현 방식 프로필입니다. 겉모양만 바꾸는 codegen 옵션이 아닙니다. 런타임과 이 설정에서 같은 PostgreSQL, mysql2, MariaDB 프로필 설명 객체를 쓰세요. 드라이버용 선언이 좁혀 주지 않는 한, 네이티브 JSON 최상위 값은 일부러 unknown으로 남습니다. 출력 타입을 직접 재정의하면 생성되는 TypeScript만 바뀝니다. 런타임 디코딩은 바뀌지 않습니다.