migrate — @gj-kit/toss-payments-postgresql

@gj-kit/toss-payments-postgresql에서 공개하는 function입니다. package version 0.5.1의 release declaration을 그대로 표시합니다.

검증된 import 예제

import { migrate } from '@gj-kit/toss-payments-postgresql';

시그니처, 매개변수, 반환 타입

/**
 * 마이그레이션 실행 (설계 §4 절차).
 *
 * 1. BEGIN
 * 2. pg_advisory_xact_lock — 동시 부팅 인스턴스 직렬화 (트랜잭션 종료 시 자동 해제)
 * 3. CREATE SCHEMA IF NOT EXISTS + 버전 테이블 toss_pg_migrations IF NOT EXISTS
 * 4. 미적용 id만 순서대로 실행 + 버전 테이블 INSERT
 * 5. COMMIT (실패 시 ROLLBACK 후 'migration-failed'로 감싸 rethrow — cause 보존)
 */
declare function migrate(sql: SqlClient, options?: MigrateOptions): Promise<MigrationResult>;

이 선언은 매개변수, optionality, 제네릭, 반환값, 공개 union/type 계약의 정본입니다. 호출 전 필요한 환경·권한·오류 경계는 패키지 Golden path와 이 subpath의 import 조건을 함께 확인하세요.

Release context

• 패키지: @gj-kit/toss-payments-postgresql
• 버전: 0.5.1
• 공개 entry: .
• 소스: GitHub

구현 주석

마이그레이션 실행 (설계 §4 절차).

1. BEGIN
2. pg_advisory_xact_lock — 동시 부팅 인스턴스 직렬화 (트랜잭션 종료 시 자동 해제)
3. CREATE SCHEMA IF NOT EXISTS + 버전 테이블 toss_pg_migrations IF NOT EXISTS
4. 미적용 id만 순서대로 실행 + 버전 테이블 INSERT
5. COMMIT (실패 시 ROLLBACK 후 ’migration-failed’로 감싸 rethrow — cause 보존)