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

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

검증된 import 예제

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

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

/**
 * SqlClient seam — 이 패키지의 유일한 드라이버 접점 (설계 §2).
 *
 * `pg`는 peer조차 아니다: 타입 import까지 금지하고 구조적 타입 {@link PgPoolLike}만
 * 소비한다. TypeORM/Prisma/postgres.js 사용자는 {@link SqlClient}를 직접 구현한다.
 *
 * 계약 요점:
 * - `$1, $2` 위치 파라미터 규약(PostgreSQL 프로토콜). 실패는 그대로 throw —
 *   드라이버 에러를 감싸지 않는다(errors.ts 원칙).
 * - `rowCount`에 의존하지 않는다 — 존재 판정은 전부 RETURNING/SELECT의 rows로 한다
 *   (드라이버 간 이식성: rowCount 노출 형태가 제각각이다).
 * - `withConnection`은 migrate()·PostgreSQL billing-key mutation lock·opaque lifecycle
 *   advisory lock의 트랜잭션이 풀의 서로 다른 커넥션으로 흩어지지 않게 한다. 일반
 *   스토어 경로는 단일 문이지만 lock callback은 이 세션을 유지한다.
 */
interface SqlRow {
    readonly [column: string]: unknown;
}

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

Release context

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

구현 주석

SqlClient seam — 이 패키지의 유일한 드라이버 접점 (설계 §2).

pg는 peer조차 아니다: 타입 import까지 금지하고 구조적 타입 {@link PgPoolLike}만 소비한다. TypeORM/Prisma/postgres.js 사용자는 {@link SqlClient}를 직접 구현한다.

계약 요점:

• $1, $2 위치 파라미터 규약(PostgreSQL 프로토콜). 실패는 그대로 throw — 드라이버 에러를 감싸지 않는다(errors.ts 원칙).
• rowCount에 의존하지 않는다 — 존재 판정은 전부 RETURNING/SELECT의 rows로 한다 (드라이버 간 이식성: rowCount 노출 형태가 제각각이다).
• withConnection은 migrate()·PostgreSQL billing-key mutation lock·opaque lifecycle advisory lock의 트랜잭션이 풀의 서로 다른 커넥션으로 흩어지지 않게 한다. 일반 스토어 경로는 단일 문이지만 lock callback은 이 세션을 유지한다.