DESCRIBE SECRET
DESCRIBE SECRET
시크릿(Secret)의 속성을 설명하는 명령어입니다. DESCRIBE는 DESC로 줄여서 쓸 수 있어요.
출처: 문서
본문
DESCRIBE SECRET은 시크릿의 속성을 설명합니다. 관련 명령어로 ALTER SECRET, CREATE SECRET, DROP SECRET, SHOW SECRETS가 있어요.
구문 (Syntax)
{ DESC | DESCRIBE } SECRET <name>
파라미터 (Parameters)
- name — 설명할 시크릿의 식별자를 지정합니다. 식별자에 공백이나 특수 문자가 포함된 경우 전체 문자열을 큰따옴표로 감싸야 합니다. 큰따옴표로 감싼 식별자는 대소문자를 구분해요.
출력 (Output)
명령어 출력은 다음 컬럼으로 시크릿 속성과 메타데이터를 제공합니다.
| 컬럼 | 설명 |
|---|---|
| created_on | 시크릿이 생성된 날짜와 시간입니다. |
| name | 시크릿의 이름입니다. |
| schema_name | 시크릿이 포함된 스키마의 이름입니다. |
| database_name | 시크릿이 포함된 데이터베이스의 이름입니다. |
| owner | 시크릿을 소유한 역할의 이름입니다. |
| comment | 시크릿에 대한 주석입니다. 주석이 지정되지 않으면 NULL입니다. |
| secret_type | OAUTH2, PASSWORD, GENERIC, SYMMETRIC_KEY, CLOUD_PROVIDER_TOKEN 또는 WORKLOAD_IDENTITY_FEDERATION 중 하나입니다. |
| username | 시크릿에 저장된 사용자 이름입니다. |
| oauth_access_token_expiry_time | OAuth 액세스 토큰이 만료되는 시점을 문자열로 나타낸 타임스탬프입니다. |
| oauth_refresh_token_expiry_time | OAuth 갱신 토큰이 만료되는 시점을 문자열로 나타낸 타임스탬프입니다. 시크릿이 이 값을 저장하지 않으면 NULL입니다. |
| oauth_scopes | OAuth 클라이언트 자격 증명 흐름 중 통합에 USAGE 권한이 있는 역할이 OAuth 서버에 요청할 때 사용할 스코프의 쉼표로 구분된 목록입니다. 스코프가 없으면 NULL입니다. |
| integration_name | 시크릿에서 참조하는 External API Authentication(외부 API 인증) 통합의 이름입니다. 시크릿이 외부 API 인증 통합을 참조하지 않으면 NULL입니다. |
| algorithm | 대칭 키 시크릿에 사용되는 알고리즘입니다. |
| key_length | 대칭 키 시크릿에 사용되는 키의 길이입니다. |
| workload_identity_federation_issuer | 워크로드 ID 페더레이션 시크릿에 대한 OIDC 공급자로서의 Snowflake 발급자 URL입니다. 외부 서비스가 이 값을 ID 토큰의 iss 클레임과 비교할 수 있도록 이 값을 제공하세요. |
| workload_identity_federation_subject | 워크로드 ID 페더레이션 시크릿에 대한 OIDC 클라이언트로서의 워크로드 식별자입니다. 외부 서비스가 이 값을 ID 토큰의 sub 클레임과 비교할 수 있도록 이 값을 제공하세요. |
접근 제어 요구 사항 (Access control requirements)
이 작업을 실행하는 역할은 최소한 USAGE 권한(객체: Secret)이 있어야 합니다.
스키마 안의 객체를 조작하려면 상위 데이터베이스에 대한 권한이 1개 이상, 상위 스키마에 대한 권한이 1개 이상 필요합니다. 지정된 권한 집합으로 커스텀 역할을 만드는 방법은 Creating custom roles을, securable 객체에 대한 역할과 권한 부여에 관한 일반 정보는 Overview of Access Control을 참고하세요.
사용 참고 사항 (Usage notes)
- Snowflake는
PASSWORD속성 값을 절대 반환하지 않습니다. - 이 명령어의 출력을 후처리하려면 파이프 연산자(
->>)나RESULT_SCAN함수를 사용할 수 있어요. 두 방식 모두 출력을 조회 가능한 결과 집합으로 취급합니다. 예를 들어 SHOW 명령어 출력에서 원하는 컬럼만 선택하거나 행을 필터링할 수 있어요. - 출력 컬럼을 참조할 때는 컬럼 이름을 큰따옴표 식별자로 사용하세요. 예를 들어 출력 컬럼
type을 선택하려면SELECT "type"처럼 지정합니다. SHOW 명령어의 출력 컬럼 이름은 소문자이므로 큰따옴표 식별자를 반드시 사용해야 해요.
예제 (Examples)
시크릿을 설명합니다.
DESC SECRET service_now_creds_pw;