자동화 도구로서의 Plop: Redshift 환경에 최적화된 코드 생성 방식

Amazon Redshift 기반 데이터 워크스테이션 개발에서 반복적인 작업은 시간과 정확도를 떨어뜨리는 주요 원인입니다. Plop는 이러한 문제를 해결하기 위한 경량이면서 강력한 템플릿 기반 코드 생성 프레임워크로, 일관성 있는 파일 구조와 표준화된 코드 스타일을 보장합니다.

왜 데이터 워크스테이션에서는 코드 생성이 필수인가?

• 각 데이터 테이블마다 동일한 구조의 CREATE TABLE 문, ETL 파이프라인, 테스트 스크립트가 반복됨
• 팀원 간의 컨벤션 차이로 인해 코드 품질 불균형 발생
• 표준 변경 시 모든 파일 수동 수정 필요
• 신입 개발자 입문 과정 지연

Plop 설치 및 초기 설정

npm install --save-dev plop

프로젝트 루트에 plopfile.js 파일을 생성하고 기본 구성 시작:

export default function (plop) {
  // 생성기 정의 위치
}

Redshift 테이블 생성기 예제

간단한 테이블 생성기를 통해 .sql 파일과 ETL 스크립트를 동시에 생성하는 예시:

plop.setGenerator("create-table", {
  description: "Redshift 데이터 테이블 생성",
  prompts: [
    { type: "input", name: "tableName", message: "테이블 이름 입력:", validate: v => v.length > 0 },
    { type: "input", name: "desc", message: "테이블 설명 입력" }
  ],
  actions: [
    {
      type: "add",
      path: "sql/ddl/{{snakeCase tableName}}.sql",
      templateFile: "templates/table-ddl.hbs"
    },
    {
      type: "add",
      path: "etl/load_{{snakeCase tableName}}.sql",
      templateFile: "templates/etl-load.hbs"
    }
  ]
});

고급 기능: 동적 템플릿 및 커스텀 헬퍼

사용자 선택에 따라 다양한 파일 구조를 조건부 생성할 수 있습니다.

plop.setGenerator("model-generator", {
  prompts: [
    { type: "input", name: "modelName", message: "모델명 입력" },
    { type: "checkbox", name: "features", choices: ["ddl", "transform", "test", "docs"] }
  ],
  actions: data => {
    const result = [];
    const base = `models/{{snakeCase data.modelName}}`;

    if (data.features.includes("ddl")) {
      result.push({ type: "add", path: `${base}/schema.sql`, templateFile: "templates/ddl.hbs" });
    }

    if (data.features.includes("transform")) {
      result.push({ type: "add", path: `${base}/transform.sql`, templateFile: "templates/transform.hbs" });
    }

    return result;
  }
});

커스텀 헬퍼 함수 추가

Redshift 특화 타입 및 분산 정책을 자동으로 처리:

plop.setHelper("resolveType", (type) => {
  const map = {
    string: "VARCHAR(255)",
    number: "DECIMAL(18,2)",
    datetime: "TIMESTAMP",
    bool: "BOOLEAN"
  };
  return map[type] || "VARCHAR(255)";
});

plop.setHelper("chooseDistStyle", (size) => {
  return size > 1e6 ? "DISTSTYLE EVEN" : "DISTSTYLE ALL";
});

프로젝트 구조 권장 사항

redshift-project/
├── plopfile.js
├── templates/
│   ├── table-ddl.hbs
│   ├── etl-load.hbs
│   └── transform.hbs
├── sql/
│   ├── ddl/
│   └── views/
└── docs/
    └── data-models.md

템플릿 예시: Redshift 테이블 생성

<!-- {{properCase tableName}} 테이블 -->
<!-- 설명: {{desc}} -->
<!-- 생성 시간: {{date}} -->

CREATE TABLE {{snakeCase tableName}} (
  id INT IDENTITY(1,1),
  {{#each columns}}
    {{this}}{{#unless @last}},{{/unless}}
  {{/each}}
)
{{#if distKey}}DISTKEY({{distKey}}){{/if}}
{{#if sortKeys}}SORTKEY({{sortKeys}}){{/if}};

CI/CD 통합 및 검증

Git 커밋 전 자동 검증을 포함한 스크립트 구성:

{
  "scripts": {
    "generate:table": "plop create-table",
    "validate-templates": "plop check-templates",
    "pre-commit": "npm run validate-templates && git add ."
  }
}

실제 적용 효과

문제 해결 팁

• 템플릿 복잡성 감소: partials를 사용해 공통 부분 분리
• 환경별 차이 처리: process.env.NODE_ENV 기반 조건부 템플릿 생성