Files
dbx-main/scripts/sql/performance_db_init.sql
T
king aa669553db feat(performance): 실적(쇼핑몰 통합 매출) 모듈 1단계 — 대시보드·설정·보안·어댑터 구조
- 네 영역 분리: ① 수집(adapters/ 쇼핑몰 10곳 + sync.py) ② 보안(security/ + credentials.py)
  ③ 계산·저장(calc.py + db.py) ④ 화면(dashboard.py, router.py, templates, performance.css/js)
- 대시보드: 기간(오늘/이번주/이번달/올해/직접선택, 이전·다음), 쇼핑몰 필터, KPI 5개(진행 중 기간은
  직전 기간 같은 경과일 대비), 일자×쇼핑몰 표(주간합계, 총매출/수수료/차감매출 전환), 일별 추이·
  쇼핑몰 비중(SVG), 월 누적(비중)·연간 누적, 금액 클릭 → 주문 상세
- 설정(관리자): 사용/매출 집계, 수수료율 이력(적용 시작일), 쇼핑몰별 API 인증정보 입력·연결 테스트·
  연결 상태, 마스터 키 상태·재암호화, 테스트(모의) 데이터 생성/삭제
- 인증정보: 설정 화면 입력 → AES-256-GCM(키 버전, AAD=쇼핑몰+항목) 암호화 저장, secret 원문은
  화면으로 다시 보내지 않음, 오류·로그·raw 는 비밀값 가린 뒤 저장. 마스터 키는 APP_ENCRYPTION_KEY(.env)
- 매출 기준일: 결제=결제일, 취소·반품=발생일. 금액 원 단위 정수, 수수료 반올림은 calc.commission 한 곳
- 동기화: 같은 쇼핑몰 동시 실행 차단(running 부분 유니크), 쇼핑몰별 실패 격리, 중복 방지 UNIQUE+UPSERT
- 카페24 어댑터는 기존 app/integrations/cafe24 OAuth 토큰 재사용, 나머지는 입력칸만(수집은 다음 단계)
- performance_db 초기화 스크립트, 권한키 performance(설정은 is_admin), 문서·.env.example

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-29 16:07:46 +09:00

224 lines
13 KiB
PL/PgSQL

-- =====================================================================
-- performance_db 초기화 스크립트 (PostgreSQL) — 실적(쇼핑몰 통합 매출) 모듈
-- =====================================================================
-- 멱등(idempotent): 여러 번 실행해도 안전. 기존 데이터를 삭제하지 않는다.
--
-- ⚠️ 실행 전 사용자 승인 + 백업 확인 필수. DROP/TRUNCATE 없음.
--
-- 실행 방법 (운영 PostgreSQL 컨테이너명: postgres-db):
--
-- 1) DB / 역할 / 스키마 생성 (superuser 로 1회)
-- read -s -p "performance_app password: " APP_PWD; echo
-- docker exec -i postgres-db psql -U postgres \
-- -v app_password="$APP_PWD" \
-- < scripts/sql/performance_db_init.sql
--
-- 2) main-app .env 에 추가
-- PERFORMANCE_DB_URL=postgresql://performance_app:<APP_PWD>@postgres-db:5432/performance_db
-- APP_ENCRYPTION_KEY=$(openssl rand -hex 32) # 쇼핑몰 인증정보 암호화 마스터 키
-- APP_ENCRYPTION_KEY_VERSION=1
--
-- 3) main-app 재기동
-- cd /opt/www/main && docker compose up -d --build
--
-- 주의:
-- - 기존 DB 가 있으면 DROP 하지 않는다(CREATE DATABASE 는 미존재 시에만).
-- - 비밀번호는 절대 Git 에 커밋하지 않는다. psql -v 로만 전달.
-- - 쇼핑몰 API 인증정보는 이 DB 에 **암호문**으로만 들어간다(perf_credentials).
-- 암호화 마스터 키(APP_ENCRYPTION_KEY)는 DB 에 저장하지 않는다.
-- =====================================================================
\set ON_ERROR_STOP on
SELECT 'CREATE DATABASE performance_db ENCODING ''UTF8'' TEMPLATE template0'
WHERE NOT EXISTS (SELECT 1 FROM pg_database WHERE datname = 'performance_db')
\gexec
SELECT 'CREATE ROLE performance_app LOGIN PASSWORD ' || quote_literal(:'app_password')
WHERE NOT EXISTS (SELECT 1 FROM pg_roles WHERE rolname = 'performance_app')
\gexec
SELECT 'ALTER ROLE performance_app WITH LOGIN PASSWORD ' || quote_literal(:'app_password')
\gexec
GRANT CONNECT ON DATABASE performance_db TO performance_app;
\connect performance_db
CREATE OR REPLACE FUNCTION perf_set_updated_at() RETURNS trigger AS $$
BEGIN
NEW.updated_at := now();
RETURN NEW;
END;
$$ LANGUAGE plpgsql;
-- ════════════════════════════════════════════════════════════
-- 1) 쇼핑몰 기본 설정 — 사용 여부 / 매출 집계 여부 / 표시 순서
-- 어댑터(코드)가 쇼핑몰의 "종류"를 정의하고, 이 표는 운영 설정만 담는다.
-- ════════════════════════════════════════════════════════════
CREATE TABLE IF NOT EXISTS perf_marketplaces (
code TEXT PRIMARY KEY,
name TEXT NOT NULL,
enabled BOOLEAN NOT NULL DEFAULT TRUE,
include_in_sales BOOLEAN NOT NULL DEFAULT TRUE,
sort_order INTEGER NOT NULL DEFAULT 0,
created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
updated_at TIMESTAMPTZ NOT NULL DEFAULT now()
);
DROP TRIGGER IF EXISTS trg_perf_marketplaces_updated ON perf_marketplaces;
CREATE TRIGGER trg_perf_marketplaces_updated
BEFORE UPDATE ON perf_marketplaces
FOR EACH ROW EXECUTE FUNCTION perf_set_updated_at();
INSERT INTO perf_marketplaces (code, name, sort_order) VALUES
('cafe24', '카페24', 10),
('naver', '네이버 스마트스토어', 20),
('coupang', '쿠팡', 30),
('ohouse', '오늘의집', 40),
('gmarket', 'G마켓', 50),
('kakao', '카카오', 60),
('gsshop', 'GS샵', 70),
('elevenst', '11번가', 80),
('lotteon', '롯데ON', 90),
('toss', '토스쇼핑', 100)
ON CONFLICT (code) DO NOTHING;
-- ════════════════════════════════════════════════════════════
-- 2) 수수료율 이력 — 적용 시작일(effective_from)부터 다음 변경 전까지 그 요율.
-- 과거 실적은 그 날짜에 유효했던 요율로 계산한다(요율을 바꿔도 과거가 안 바뀜).
-- rule_type 은 향후 상품별/카테고리별/정액 수수료 확장용(현재 'marketplace' 만).
-- ════════════════════════════════════════════════════════════
CREATE TABLE IF NOT EXISTS perf_commission_rates (
id BIGSERIAL PRIMARY KEY,
marketplace_code TEXT NOT NULL REFERENCES perf_marketplaces(code),
rule_type TEXT NOT NULL DEFAULT 'marketplace'
CHECK (rule_type IN ('marketplace')),
rate_percent NUMERIC(7,3) NOT NULL CHECK (rate_percent >= 0 AND rate_percent <= 100),
effective_from DATE NOT NULL,
memo TEXT NOT NULL DEFAULT '',
created_by TEXT NOT NULL DEFAULT '',
created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
UNIQUE (marketplace_code, rule_type, effective_from)
);
CREATE INDEX IF NOT EXISTS idx_perf_rates_code_from
ON perf_commission_rates (marketplace_code, effective_from DESC);
-- ════════════════════════════════════════════════════════════
-- 3) 쇼핑몰 API 인증정보 — 항목 하나 = 행 하나, 값은 AES-256-GCM 암호문.
-- encrypted_value 형식: "v{키버전}:{base64url(nonce + 암호문 + tag)}"
-- key_version 은 마스터 키 교체(rotation) 때 재암호화 대상을 찾는 데 쓴다.
-- access/refresh token 도 여기에 같은 방식으로 저장한다.
-- ════════════════════════════════════════════════════════════
CREATE TABLE IF NOT EXISTS perf_credentials (
marketplace_code TEXT NOT NULL REFERENCES perf_marketplaces(code),
credential_key TEXT NOT NULL,
encrypted_value TEXT NOT NULL,
key_version INTEGER NOT NULL,
updated_by TEXT NOT NULL DEFAULT '',
created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
updated_at TIMESTAMPTZ NOT NULL DEFAULT now(),
PRIMARY KEY (marketplace_code, credential_key)
);
DROP TRIGGER IF EXISTS trg_perf_credentials_updated ON perf_credentials;
CREATE TRIGGER trg_perf_credentials_updated
BEFORE UPDATE ON perf_credentials
FOR EACH ROW EXECUTE FUNCTION perf_set_updated_at();
-- ════════════════════════════════════════════════════════════
-- 4) 연결 상태 — 연결 테스트/동기화 결과. last_error 는 비밀값을 가린 문구만.
-- ════════════════════════════════════════════════════════════
CREATE TABLE IF NOT EXISTS perf_connection_status (
marketplace_code TEXT PRIMARY KEY REFERENCES perf_marketplaces(code),
status TEXT NOT NULL DEFAULT 'unknown'
CHECK (status IN ('ok', 'not_configured', 'auth_failed', 'token_expired',
'api_error', 'not_implemented', 'unknown')),
last_test_at TIMESTAMPTZ,
last_test_ok BOOLEAN,
last_sync_at TIMESTAMPTZ,
last_success_sync_at TIMESTAMPTZ,
last_error TEXT NOT NULL DEFAULT '',
last_error_at TIMESTAMPTZ,
updated_at TIMESTAMPTZ NOT NULL DEFAULT now()
);
DROP TRIGGER IF EXISTS trg_perf_status_updated ON perf_connection_status;
CREATE TRIGGER trg_perf_status_updated
BEFORE UPDATE ON perf_connection_status
FOR EACH ROW EXECUTE FUNCTION perf_set_updated_at();
-- ════════════════════════════════════════════════════════════
-- 5) 매출 사건 — 결제(+), 취소(-), 반품(-). 금액은 원 단위 정수(BIGINT).
-- sales_date = 집계 기준일. 결제는 결제일, 취소·반품은 발생일
-- (지난 실적이 나중에 바뀌지 않게). order_date/payment_date 는 원래 날짜를
-- 따로 보관해 기준을 바꿀 수 있게 한다.
-- 중복 방지: UNIQUE(쇼핑몰, 사건 종류, 외부 사건 ID) — 같은 사건은 덮어쓴다.
-- raw_data 는 비밀값을 가린 원본. is_sample = 테스트(모의) 데이터.
-- ════════════════════════════════════════════════════════════
CREATE TABLE IF NOT EXISTS perf_sales_events (
id BIGSERIAL PRIMARY KEY,
marketplace_code TEXT NOT NULL REFERENCES perf_marketplaces(code),
event_type TEXT NOT NULL CHECK (event_type IN ('SALE', 'CANCEL', 'RETURN', 'ADJUST')),
external_event_id TEXT NOT NULL,
external_order_id TEXT NOT NULL,
external_line_id TEXT NOT NULL DEFAULT '',
order_date DATE,
payment_date DATE,
event_date DATE NOT NULL,
sales_date DATE NOT NULL,
product_name TEXT NOT NULL DEFAULT '',
option_name TEXT NOT NULL DEFAULT '',
quantity INTEGER NOT NULL DEFAULT 0,
amount BIGINT NOT NULL,
discount_amount BIGINT NOT NULL DEFAULT 0,
order_status TEXT NOT NULL DEFAULT '',
raw_data JSONB,
is_sample BOOLEAN NOT NULL DEFAULT FALSE,
synced_at TIMESTAMPTZ NOT NULL DEFAULT now(),
created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
updated_at TIMESTAMPTZ NOT NULL DEFAULT now(),
UNIQUE (marketplace_code, event_type, external_event_id)
);
CREATE INDEX IF NOT EXISTS idx_perf_events_date_code ON perf_sales_events (sales_date, marketplace_code);
CREATE INDEX IF NOT EXISTS idx_perf_events_order ON perf_sales_events (marketplace_code, external_order_id);
CREATE INDEX IF NOT EXISTS idx_perf_events_sample ON perf_sales_events (is_sample) WHERE is_sample;
DROP TRIGGER IF EXISTS trg_perf_events_updated ON perf_sales_events;
CREATE TRIGGER trg_perf_events_updated
BEFORE UPDATE ON perf_sales_events
FOR EACH ROW EXECUTE FUNCTION perf_set_updated_at();
-- ════════════════════════════════════════════════════════════
-- 6) 동기화 실행 기록 — 같은 쇼핑몰은 동시에 하나만(running 부분 유니크 인덱스).
-- 웹/스케줄러 어디서 돌려도 중복 실행이 막힌다.
-- ════════════════════════════════════════════════════════════
CREATE TABLE IF NOT EXISTS perf_sync_runs (
id BIGSERIAL PRIMARY KEY,
marketplace_code TEXT NOT NULL REFERENCES perf_marketplaces(code),
trigger TEXT NOT NULL DEFAULT 'manual' CHECK (trigger IN ('manual', 'schedule')),
range_from DATE,
range_to DATE,
status TEXT NOT NULL DEFAULT 'running'
CHECK (status IN ('running', 'success', 'failed')),
fetched_count INTEGER NOT NULL DEFAULT 0,
upserted_count INTEGER NOT NULL DEFAULT 0,
error TEXT NOT NULL DEFAULT '',
started_by TEXT NOT NULL DEFAULT '',
started_at TIMESTAMPTZ NOT NULL DEFAULT now(),
finished_at TIMESTAMPTZ
);
CREATE UNIQUE INDEX IF NOT EXISTS uq_perf_sync_running
ON perf_sync_runs (marketplace_code) WHERE status = 'running';
CREATE INDEX IF NOT EXISTS idx_perf_sync_runs_code ON perf_sync_runs (marketplace_code, started_at DESC);
-- ════════════════════════════════════════════════════════════
-- 권한 — 앱 계정은 DML 만
-- ════════════════════════════════════════════════════════════
GRANT USAGE ON SCHEMA public TO performance_app;
GRANT SELECT, INSERT, UPDATE, DELETE ON
perf_marketplaces, perf_commission_rates, perf_credentials,
perf_connection_status, perf_sales_events, perf_sync_runs
TO performance_app;
GRANT USAGE, SELECT ON ALL SEQUENCES IN SCHEMA public TO performance_app;
ALTER DEFAULT PRIVILEGES IN SCHEMA public
GRANT SELECT, INSERT, UPDATE, DELETE ON TABLES TO performance_app;
ALTER DEFAULT PRIVILEGES IN SCHEMA public
GRANT USAGE, SELECT ON SEQUENCES TO performance_app;