digna CLI Reference 2024.11¶
2024-11-03
이 페이지는 digna CLI 릴리스 2024.11에서 이용 가능한 전체 명령어 집합을 사용법 예시와 옵션과 함께 문서화한 것입니다.
CLI 기초¶
help 옵션 사용법¶
--help 옵션은 사용 가능한 명령어와 사용법에 대한 정보를 제공합니다. 이 옵션을 사용하는 주요 방법은 두 가지입니다:
- 일반 도움말 표시:
키워드 digna 뒤에 즉시 --help를 사용합니다.
dignacli --help
-
특정 명령어에 대한 도움말 얻기:
특정 명령어에 대한 자세한 정보를 보려면 해당 명령어 뒤에
--help를 추가합니다.
예를 들어add-user명령어의 도움말을 보려면 다음을 실행하세요:dignacli add-user --help### 출력:
- 명령 설명: 명령이 수행하는 동작에 대한 자세한 설명.
- 문법: 필수 및 선택 인수를 포함한 정확한 사용법 표시.
- 옵션: 명령에 특화된 옵션과 그 설명 목록.
- 예제: 명령을 효과적으로 실행하는 방법의 예제 제공.
check-repo-connection 명령어 사용법¶
check-repo-connection 명령어는 지정한 digna 리포지토리와의 연결 및 접근성을 테스트하기 위해 digna CLI 도구 내에서 제공되는 유틸리티입니다. 이 명령어는 CLI가 리포지토리와 상호작용할 수 있는지 확인합니다.
명령 사용법¶
dignacli check-repo-connection
정상적으로 실행되면 리포지토리 버전, 호스트, 데이터베이스 및 스키마 등 리포지토리에 대한 세부 정보를 포함한 연결 확인 메시지를 출력합니다.
리포지토리 연결이 성공적이지 않다면 config.toml 파일의 설정이 올바른지 확인하세요.
version 명령어 사용법¶
설치된 dignacli 버전을 확인하려면 --version 옵션을 사용하세요.
명령 사용법¶
dignacli --version
예제 출력¶
dignacli version 2024.11
로깅 옵션 사용법¶
기본적으로 digna 명령어의 콘솔 출력은 최소한의 정보만 표시하도록 설계되어 있습니다. 대부분의 명령어는 다음 옵션을 사용하여 추가 정보를 제공할 수 있습니다:
--verbose (-v)
--debug (-d)
--logfile (lf)
“verbose”와 “debug”는 출력의 상세 수준을 정의하며, “logfile” 스위치는 출력을 콘솔 창 대신 파일로 스트리밍하도록 리디렉션하는 데 사용됩니다.
사용자 관리¶
add-user 명령어 사용법¶
add-user 명령어는 digna CLI에서 새 사용자를 digna 시스템에 추가하는 데 사용됩니다.
명령 사용법¶
dignacli add-user [OPTIONS] USER_NAME USER_FULL_NAME USER_PASSWORD
인수¶
- USER_NAME: 새 사용자의 사용자 이름(필수).
- USER_FULL_NAME: 새 사용자의 전체 이름(필수).
- USER_PASSWORD: 새 사용자의 비밀번호(필수).
옵션¶
--is_superuser,-su: 새 사용자를 관리자(superuser)로 지정하는 플래그.--valid_until,-vu: 사용자 계정의 만료 시간을YYYY-MM-DD HH:MI:SS형식으로 설정합니다. 설정하지 않으면 계정에 만료일이 없습니다.
예제¶
사용자 이름이 jdoe, 전체 이름이 John Doe, 비밀번호가 password123인 새 사용자를 추가하려면:
dignacli add-user [OPTIONS] USER_NAME USER_FULL_NAME USER_PASSWORD
계정 만료일을 설정하여 새 사용자를 추가하려면:
dignacli add-user jdoe "John Doe" password123 --valid_until "2024-12-31 23:59:59"
delete-user 명령어 사용법¶
delete-user 명령어는 digna CLI에서 기존 사용자를 digna 시스템에서 제거하는 데 사용됩니다.
명령 사용법¶
dignacli delete-user USER_NAME
인수¶
- USER_NAME: 삭제할 사용자의 사용자 이름(필수). 이 명령어에서 필요한 유일한 인수입니다.
예제¶
dignacli delete-user jdoe
이 명령을 실행하면 jdoe 사용자가 digna 시스템에서 제거되어 해당 사용자의 접근 권한이 취소되고 리포지토리에서 관련 데이터와 권한이 삭제됩니다.
modify-user 명령어 사용법¶
modify-user 명령어는 digna CLI에서 기존 사용자의 세부 정보를 업데이트하는 데 사용됩니다.
명령 사용법¶
dignacli modify-user <USER_NAME> <USER_FULL_NAME> [options]
인수¶
- USER_NAME: 수정할 사용자의 사용자 이름(필수).
- USER_FULL_NAME: 사용자의 새로운 전체 이름(필수).
옵션¶
--is_superuser,-su: 사용자를 슈퍼유저로 설정하여 향상된 권한을 부여합니다. 이 플래그는 값이 필요하지 않습니다.--valid_until,-vu: 사용자 계정의 만료 시간을 YYYY-MM-DD HH:MI:SS 형식으로 설정합니다. 제공하지 않으면 계정은 무기한 유효합니다.
예제¶
사용자 jdoe의 전체 이름을 “Johnathan Doe”로 수정하고 해당 사용자를 슈퍼유저로 지정하려면:
dignacli modify-user jdoe "Johnathan Doe" --is_superuser
modify-user-pwd 명령어 사용법¶
modify-user-pwd 명령어는 digna CLI에서 기존 사용자의 비밀번호를 변경하는 데 사용됩니다.
명령 사용법¶
dignacli modify-user-pwd <USER_NAME> <USER_PWD>
인수¶
- USER_NAME: 비밀번호를 변경할 사용자의 사용자 이름(필수).
- USER_PWD: 사용자의 새 비밀번호(필수).
예제¶
사용자 jdoe의 비밀번호를 newpassword123으로 변경하려면:
dignacli modify-user-pwd jdoe newpassword123
list-users 명령어 사용법¶
list-users 명령어는 digna CLI에서 등록된 모든 사용자의 목록을 표시합니다.
명령 사용법¶
dignacli list-users
이 명령을 실행하면 digna 리포지토리에 접속하여 모든 사용자를 나열하며, ID, 사용자 이름, 전체 이름, 슈퍼유저 여부 및 만료 타임스탬프를 표시합니다.
리포지토리 관리¶
upgrade-repo 명령어 사용법¶
upgrade-repo 명령어는 digna CLI에서 리포지토리를 업그레이드하거나 초기화하는 데 사용됩니다. 이 명령어는 업데이트를 적용하거나 처음으로 리포지토리 인프라를 설정하는 데 필수적입니다.
명령 사용법¶
dignacli upgrade-repo [options]
옵션¶
--simulation-mode,-s: 활성화하면 명령을 시뮬레이션 모드로 실행하여 실제로 SQL 문을 실행하지 않고 실행될 SQL 문을 출력합니다. 리포지토리에 변경을 가하지 않고 변경 사항을 미리 확인할 때 유용합니다.
예제¶
옵션 없이 리포지토리를 업그레이드하려면:
dignacli upgrade-repo
dignacli upgrade-repo --simulation-mode
이 명령은 데이터베이스 스키마와 기타 리포지토리 구성요소가 소프트웨어의 최신 버전과 일치하도록 유지하는 데 중요합니다.
encrypt 명령어 사용법¶
encrypt 명령어는 digna CLI에서 비밀번호를 암호화하는 데 사용됩니다.
명령 사용법¶
dignacli encrypt <PASSWORD>
인수¶
- PASSWORD: 암호화할 비밀번호(필수).
예제¶
비밀번호를 암호화하려면 비밀번호를 인수로 제공하면 됩니다.
예를 들어, 비밀번호 mypassword123을 암호화하려면 다음을 사용합니다:
dignacli encrypt mypassword123
generate-key 명령어 사용법¶
generate-key 명령어는 Fernet 키를 생성하는 데 사용되며, 이는 digna 리포지토리에 저장된 비밀번호를 보호하는 데 필수적입니다.
명령 사용법¶
dignacli generate-key
데이터 관리¶
clean-up 명령어 사용법¶
clean-up 명령어는 지정된 프로젝트 내 하나 이상의 데이터 소스에 대해 프로파일, 예측(predictions), 그리고 Traffic Light System 데이터(트래픽 라이트 시스템 데이터)를 제거하는 데 사용됩니다. 이 명령어는 데이터 라이프사이클 관리를 위해 필수적이며, 오래되었거나 불필요한 데이터를 정리하여 조직적이고 효율적인 데이터 환경을 유지하는 데 도움이 됩니다.
명령 사용법¶
dignacli clean-up <PROJECT_NAME> <FROM_DATE> <TO_DATE> [options]
인수¶
- PROJECT_NAME: 데이터를 제거할 프로젝트 이름(필수). 이 인수에 키워드 all-projects를 사용하면 digna가 모든 기존 프로젝트를 순회하며 해당 명령을 적용합니다.
- FROM_DATE: 데이터 제거 시작 날짜 및 시간. 허용되는 형식은 %Y-%m-%d, %Y-%m-%dT%H:%M:%S 또는 %Y-%m-%d %H:%M:%S 입니다(필수).
- TO_DATE: 데이터 제거 종료 날짜 및 시간(FROM_DATE와 동일한 형식)(필수).
옵션¶
--table-name,-tn: 정리 작업을 프로젝트 내 특정 테이블로 제한합니다.--table-filter,-tf: 이름에 지정된 부분 문자열이 포함된 테이블로 정리 대상을 필터링합니다.--timing,-tm: 완료 후 정리 작업의 소요 시간을 표시합니다.--help: clean-up 명령어의 도움말을 표시하고 종료합니다.
예제¶
ProjectA 프로젝트에서 2023년 1월 1일부터 2023년 6월 30일까지의 데이터를 제거하려면:
dignacli clean-up ProjectA 2023-01-01 2023-06-30
특정 테이블 Table1에서만 데이터를 제거하려면:
dignacli clean-up ProjectA 2023-01-01 2023-06-30 --table-name Table1
이 명령은 데이터 저장 관리를 돕고 리포지토리에 관련 있는 정보만 보관되도록 보장합니다.
inspect 명령어 사용법¶
inspect 명령어는 지정된 프로젝트 내 하나 이상의 데이터 소스에 대해 프로파일, 예측(predictions), 그리고 Traffic Light System 데이터를 생성하는 데 사용됩니다. 이 명령어는 특정 기간 동안의 데이터를 분석하고 모니터링하는 데 도움을 줍니다.
명령 사용법¶
dignacli inspect <PROJECT_NAME> <FROM_DATE> <TO_DATE> [options]
인수¶
- PROJECT_NAME: 데이터를 검사할 프로젝트 이름(필수). 이 인수에 키워드 all-projects를 사용하면 digna가 모든 기존 프로젝트를 순회하며 해당 명령을 적용합니다.
- FROM_DATE: 데이터 검사의 시작 날짜 및 시간. 허용되는 형식은 %Y-%m-%d, %Y-%m-%dT%H:%M:%S 또는 %Y-%m-%d %H:%M:%S 입니다(필수).
- TO_DATE: 데이터 검사의 종료 날짜 및 시간( FROM_DATE와 동일한 형식)(필수).
옵션¶
--table-name,-tn: 검사를 프로젝트 내 특정 테이블로 제한합니다.--table-filter,-tf: 이름에 지정된 부분 문자열이 포함된 테이블만 검사하도록 필터링합니다.--do-profile: 프로파일 재수집을 트리거합니다. 기본값은 do-profile입니다.--no-do-profile: 프로파일 재수집을 방지합니다.--do-prediction: 예측 재계산을 트리거합니다. 기본값은 do-prediction입니다.--no-do-prediction: 예측 재계산을 방지합니다.--do-alert-status: 알림 상태 재계산을 트리거합니다. 기본값은 do-alert-status입니다.--no-do-alert-status: 알림 상태 재계산을 방지합니다.--timing,-tm: 완료 후 검사 과정의 소요 시간을 표시합니다.
예제¶
ProjectA 프로젝트의 2024년 1월 1일부터 2024년 1월 31일까지의 데이터를 검사하려면:
dignacli inspect ProjectA 2024-01-01 2024-01-31
특정 테이블만 검사하고 예측의 재계산을 강제하려면:
dignacli inspect ProjectA 2024-01-01 2024-01-31 --table-name Table1 --force-prediction
tls-status 명령어 사용법¶
tls-status 명령어는 지정된 날짜에 프로젝트 내 특정 테이블에 대한 Traffic Light System(TLS) 상태를 조회하는 데 사용됩니다. Traffic Light System은 데이터의 건강 상태와 품질에 대한 인사이트를 제공하며, 주의가 필요한 문제나 알림을 나타냅니다.
명령 사용법¶
dignacli tls-status <PROJECT_NAME> <TABLE_NAME> <DATE>
인수¶
- PROJECT_NAME: TLS 상태를 조회할 프로젝트 이름(필수).
- TABLE_NAME: TLS 상태가 필요한 해당 프로젝트 내 특정 테이블(필수).
- DATE: TLS 상태를 조회할 날짜, 일반적으로 %Y-%m-%d 형식(필수).
예제¶
ProjectA 프로젝트의 UserData 테이블에 대해 2024년 7월 1일의 TLS 상태를 확인하려면:
dignacli tls-status ProjectA UserData 2024-07-01
이 명령은 미리 정의된 기준에 따라 명확하고 실행 가능한 상태 보고서를 제공하여 사용자가 데이터 품질을 모니터링하고 유지관리하는 데 도움을 줍니다.
list-projects 명령어 사용법¶
list-projects 명령어는 digna CLI에서 사용 가능한 모든 프로젝트 목록을 표시하는 데 사용됩니다.
명령 사용법¶
dignacli list-projects
이 명령은 특히 여러 프로젝트를 관리하는 관리자와 사용자에게 유용하며, digna 리포지토리에서 사용 가능한 프로젝트를 빠르게 개괄할 수 있게 합니다.
list-ds 명령어 사용법¶
list-ds 명령어는 지정된 프로젝트 내에서 사용 가능한 모든 데이터 소스 목록을 표시하는 데 사용됩니다. 이 명령은 분석 및 관리에 사용할 수 있는 데이터 자산을 파악하는 데 유용합니다.
명령 사용법¶
dignacli list-ds <PROJECT_NAME>
인수¶
- PROJECT_NAME: 데이터 소스를 나열할 프로젝트 이름(필수).
예제¶
ProjectA라는 프로젝트의 모든 데이터 소스를 나열하려면:
dignacli list-ds ProjectA
이 명령은 프로젝트에서 사용 가능한 데이터 소스에 대한 개요를 제공하여 데이터 환경을 보다 효과적으로 탐색하고 관리할 수 있도록 돕습니다.