콘텐츠로 이동

Interactive Mode Guide

1. 시작

인자 없이 실행하면 대화형 모드로 진입합니다.

브라우저에서 작업을 편집·실행하려면 웹 콘솔 가이드를 사용하세요. 웹 콘솔은 조회뿐 아니라 프로젝트 작업 생성, 매핑·스크램블링 편집, 검증·실행·예약을 지원합니다.

$ datatrans
DATATRANS>

Help에 정의되지 않은 비대화형 datatrans status=... 또는 datatrans progress=... shorthand 대신 아래 대화형 명령을 사용합니다.

2. 도움말과 관리 프로세스

명령 동작
HELP, ?, HELP=Y 도움말 표시
VERSION 프로그램 버전 표시
ACTIVATE, ACTIVATE=Y 라이선스 활성화
STARTUP Background 관리 프로세스 시작 요청
QUIT, EXIT 대화형 모드 종료

QUIT|EXIT는 실행 중인 작업을 중지하는 명령이 아닙니다.

3. 작업 조회와 연결

JOB_LIST

DATATRANS> JOB_LIST

관리 중인 작업 목록을 표시합니다.

CONTINUE_JOB

DATATRANS> CONTINUE_JOB=SALES_TRANSFER
DATATRANS:SALES_TRANSFER>

기존 작업에 연결합니다. 이후 인자 없는 작업 명령은 연결된 작업을 대상으로 합니다.

STATUS

DATATRANS:SALES_TRANSFER> STATUS
DATATRANS> STATUS=SALES_TRANSFER
DATATRANS> STATUS=SALES_TRANSFER,3
DATATRANS:SALES_TRANSFER> STATUS_WATCH,3
  • STATUS: 현재 연결된 작업 상태
  • STATUS=JOBNAME: 지정한 작업 상태
  • STATUS=JOBNAME,SECONDS: 지정한 작업 상태를 반복 조회
  • STATUS_WATCH,SECONDS: 연결된 작업 상태를 반복 조회

반복 조회 최소 주기는 3초입니다.

PROGRESS

DATATRANS:SALES_TRANSFER> PROGRESS
DATATRANS> PROGRESS=SALES_TRANSFER
DATATRANS:SALES_TRANSFER> PROGRESS_WATCH,3
  • PROGRESS: 연결된 작업의 table별 진행 상태
  • PROGRESS=JOBNAME: 지정한 작업의 table별 진행 상태
  • PROGRESS_WATCH,SECONDS: 연결된 작업의 table별 진행 상태를 반복 조회

반복 조회 최소 주기는 3초입니다.

4. 일시 정지·재개·종료

STOP_JOB

DATATRANS> STOP_JOB=SALES_TRANSFER
DATATRANS:SALES_TRANSFER> STOP_JOB

현재 또는 지정한 작업을 일시 정지합니다.

START_JOB

DATATRANS> CONTINUE_JOB=SALES_TRANSFER
DATATRANS:SALES_TRANSFER> START_JOB

연결된 작업을 재개합니다. START_JOB=JOBNAME은 지원하지 않습니다.

KILL_JOB

DATATRANS> KILL_JOB=SALES_TRANSFER
DATATRANS:SALES_TRANSFER> KILL_JOB

현재 또는 지정한 작업을 강제 종료합니다.

JOB_CLEANUP

DATATRANS> JOB_CLEANUP

작업 metadata directory를 확인한 뒤 제거합니다.

5. Schedule 운영

명령 동작
SCHEDULE_LIST 예약 목록 표시
SCHEDULE_HISTORY 최근 예약 실행 이력 표시
SCHEDULE_HISTORY=JOBNAME 지정 작업의 예약 실행 이력 표시
SCHEDULE_ERASE=JOBNAME 지정 예약과 이력을 확인 후 삭제
SCHEDULE_CLEANUP 모든 예약과 이력을 확인 후 삭제
DATATRANS> SCHEDULE_LIST
DATATRANS> SCHEDULE_HISTORY=SALES_NIGHTLY
DATATRANS> SCHEDULE_ERASE=SALES_NIGHTLY

예약 생성 시에는 CLI schedule에 실제 datetime 또는 cron expression을 전달하고 jobname을 반드시 지정합니다.

예약은 systemd 사용자 timer/service가 기동합니다. 운영 계정의 사용자 서비스·linger 준비와 등록 확인, 기존 예약 이행은 작업 예약을 참고하세요. 웹 콘솔에서도 저장된 작업 버전을 기준으로 예약을 만들고 관리할 수 있습니다.

6. Dashboard

대화형 명령

DATATRANS> DASHBOARD_STARTUP
DATATRANS> DASHBOARD_STARTUP=7501
DATATRANS> DASHBOARD_SHUTDOWN
DATATRANS> DASHBOARD_SHUTDOWN=7501

비대화형 명령

datatrans dashboard_startup
datatrans dashboard_startup 7501
datatrans dashboard_startup port=7501
datatrans dashboard_shutdown 7501
datatrans dashboard_shutdown port=7501

Dashboard server 직접 실행

datatrans-dashboard --host 0.0.0.0 --port 7501 --root /managed/job/root
옵션 의미
--host HOST Bind 주소. 기본값 0.0.0.0
--port PORT Port. 기본값 7501
--root PATH 조회할 작업 경로. 반복 지정 가능

현재 Dashboard는 웹 콘솔로 제공됩니다. 서버 설치 루트에서는 번들 Python으로 직접 기동할 수도 있습니다.

DATATRANS_HOME="$PWD" python/bin/python3 -m dashboard --host 0.0.0.0 --port 7501

최초 관리자를 등록한 뒤 DB 연결·프로젝트·사용자를 설정합니다. 관리자가 권한을 할당하면 사용자 계정으로 작업을 생성·편집·검증·실행할 수 있습니다.

도움말 메뉴는 CLI help를 절별로 표시하고 검색·전체 펼치기·전체 접기를 지원합니다. 실행 모니터에서는 권한 범위 내 프로젝트·CLI 실행을 조회합니다. 신규 PREVIEW 실행의 상세에서 테이블·컬럼별 보고서를 확인하고 Markdown으로 내보낼 수 있습니다. {JOBNAME}.md만 있는 과거 실행은 자동 연결되지 않습니다.

프로젝트 실행과 CLI 실행은 실행 경로로 구분합니다. 관리자는 프로젝트 미지정 CLI 이력을 조회할 수 있지만 일반 웹 사용자는 할당된 프로젝트의 실행만 볼 수 있습니다. CLI 상세는 조회용이며 콘솔의 프로젝트 실행 제어와는 다릅니다. 자세한 절차는 웹 콘솔 가이드를 참고하세요.

7. 공개 config

공개 config/config.json에서 다음 값을 설정할 수 있습니다.

설정 기본값 의미
dashboard_port 7501 Dashboard startup/shutdown 기본 port
thick_mode false true이면 Oracle Thick client 초기화
completed_job_erase true 완료 후 실행 metadata 자동 삭제
job_history_retention_days 90 작업 실행 이력 보존 일수

Dashboard Preview 보고서도 연결된 작업 이력과 같은 기간 보존됩니다. job_history_retention_days <= 0이면 기간 기준 자동 정리를 수행하지 않습니다.

8. 상태 판정

작업 상태 의미
COMPLETED 오류 없이 완료
COMPLETED_WITH_ERRORS 처리 가능한 table은 완료했지만 하나 이상의 오류가 기록됨. Process exit code 0
FAILED 설정, 엔진 또는 저장소 무결성 오류로 계속할 수 없음
KILLED 사용자가 종료 요청

PREVIEW outcome은 다음과 같습니다.

outcome 의미
PASSED 조회 sample에서 위반 없음
VIOLATIONS 조회 sample에서 하나 이상의 column 위반 발견
NOT_EVALUATED 조회 row가 없어 판정 불가
INCOMPLETE Metadata, 조회 또는 변환 오류로 검증 불완전

VIOLATIONS|NOT_EVALUATED 자체는 실행 오류가 아니므로 다른 실행 오류가 없으면 작업 상태는 COMPLETED입니다. 선택적 원본 민감정보 탐색의 조회·분석 오류 등은 별도 반영됩니다. 운영 자동화는 process exit code만 보지 말고 상태와 outcome을 함께 확인해야 합니다. 자세한 결과 해석은 Preview 가이드를 참고하세요.

9. 운영 예시

$ datatrans
DATATRANS> JOB_LIST
DATATRANS> STATUS=SALES_TRANSFER
DATATRANS> CONTINUE_JOB=SALES_TRANSFER
DATATRANS:SALES_TRANSFER> PROGRESS_WATCH,3
DATATRANS:SALES_TRANSFER> STOP_JOB
DATATRANS:SALES_TRANSFER> START_JOB