DESCRIBE STAGE
DESCRIBE STAGE
스테이지(Stage)의 속성(파일 형식, 복사 옵션, 위치)에 지정된 값과 각 속성의 기본 값을 설명하는 명령어입니다. DESCRIBE는 DESC로 줄여서 쓸 수 있어요.
출처: 문서
본문
DESCRIBE STAGE는 스테이지의 속성(file format, copy, location)에 지정된 값과 각 속성의 기본 값을 설명합니다. 관련 명령어로 DROP STAGE, ALTER STAGE, CREATE STAGE, SHOW STAGES가 있어요.
구문 (Syntax)
DESC[RIBE] STAGE <name>
파라미터 (Parameters)
- name — 설명할 스테이지의 식별자를 지정합니다. 식별자에 공백이나 특수 문자가 포함된 경우 전체 문자열을 큰따옴표로 감싸야 합니다. 큰따옴표로 감싼 식별자는 대소문자를 구분해요.
사용 참고 사항 (Usage notes)
- 이 명령어의 출력을 후처리하려면 파이프 연산자(
->>)나RESULT_SCAN함수를 사용할 수 있어요. 두 방식 모두 출력을 조회 가능한 결과 집합으로 취급합니다. 예를 들어 SHOW 명령어 출력에서 원하는 컬럼만 선택하거나 행을 필터링할 수 있어요. - 출력 컬럼을 참조할 때는 컬럼 이름을 큰따옴표 식별자로 사용하세요. 예를 들어 출력 컬럼
type을 선택하려면SELECT "type"처럼 지정합니다. SHOW 명령어의 출력 컬럼 이름은 소문자이므로 큰따옴표 식별자를 반드시 사용해야 해요.
출력 (Output)
명령어 출력은 다음 컬럼으로 스테이지 속성과 메타데이터를 제공합니다.
| 컬럼 | 설명 |
|---|---|
| parent_property | 각 스테이지 속성이 속한 상위 속성입니다. 가능한 값에는 STAGE_FILE_FORMAT, STAGE_COPY_OPTIONS, STAGE_LOCATION, STAGE_CREDENTIALS, DIRECTORY가 있습니다. |
| property | 속성의 이름입니다. 속성 설명은 CREATE STAGE를 참고하세요. |
| property_type | 속성의 유형입니다. |
| property_value | 속성에 할당된 값입니다. |
| property_default | 속성의 기본 값입니다. |
참고: 디렉터리 테이블이 있는 스테이지의 경우 출력에
LAST_REFRESHED_ON(유형 TIMESTAMP)이라는 속성이 포함됩니다.LAST_REFRESHED_ON은 디렉터리 테이블의 메타데이터가 스테이지의 관련 파일과 마지막으로 동기화된 시점(수동 또는 자동)을 나타냅니다.
예제 (Examples)
my_s3_stage라는 내부 스테이지를 설명합니다.
DESC STAGE my_s3_stage;
+--------------------+--------------------------------+---------------+-------------------------------------------------------+------------------+
| parent_property | property | property_type | property_value | property_default |
|--------------------+--------------------------------+---------------+-------------------------------------------------------+------------------|
| STAGE_FILE_FORMAT | TYPE | String | CSV | CSV |
| STAGE_FILE_FORMAT | RECORD_DELIMITER | String | \n | \n |
| STAGE_FILE_FORMAT | FIELD_DELIMITER | String | , | , |
| STAGE_FILE_FORMAT | FILE_EXTENSION | String | | |
| STAGE_FILE_FORMAT | SKIP_HEADER | Integer | 0 | 0 |
| STAGE_FILE_FORMAT | DATE_FORMAT | String | AUTO | AUTO |
| STAGE_FILE_FORMAT | TIME_FORMAT | String | AUTO | AUTO |
| STAGE_FILE_FORMAT | TIMESTAMP_FORMAT | String | AUTO | AUTO |
| STAGE_FILE_FORMAT | BINARY_FORMAT | String | HEX | HEX |
| STAGE_FILE_FORMAT | ESCAPE | String | NONE | NONE |
| STAGE_FILE_FORMAT | ESCAPE_UNENCLOSED_FIELD | String | \\ | \\ |
| STAGE_FILE_FORMAT | TRIM_SPACE | Boolean | false | false |
| STAGE_FILE_FORMAT | FIELD_OPTIONALLY_ENCLOSED_BY | String | NONE | NONE |
| STAGE_FILE_FORMAT | NULL_IF | List | [\\N] | [\\N] |
| STAGE_FILE_FORMAT | COMPRESSION | String | AUTO | AUTO |
| STAGE_FILE_FORMAT | ERROR_ON_COLUMN_COUNT_MISMATCH | Boolean | true | true |
| STAGE_FILE_FORMAT | VALIDATE_UTF8 | Boolean | true | true |
| STAGE_FILE_FORMAT | SKIP_BLANK_LINES | Boolean | false | false |
| STAGE_FILE_FORMAT | REPLACE_INVALID_CHARACTERS | Boolean | false | false |
| STAGE_FILE_FORMAT | EMPTY_FIELD_AS_NULL | Boolean | true | true |
| STAGE_FILE_FORMAT | SKIP_BYTE_ORDER_MARK | Boolean | true | true |
| STAGE_FILE_FORMAT | ENCODING | String | UTF8 | UTF8 |
| STAGE_COPY_OPTIONS | ON_ERROR | String | ABORT_STATEMENT | ABORT_STATEMENT |
| STAGE_COPY_OPTIONS | SIZE_LIMIT | Long | | |
| STAGE_COPY_OPTIONS | PURGE | Boolean | false | false |
| STAGE_COPY_OPTIONS | RETURN_FAILED_ONLY | Boolean | false | false |
| STAGE_COPY_OPTIONS | ENFORCE_LENGTH | Boolean | true | true |
| STAGE_COPY_OPTIONS | TRUNCATECOLUMNS | Boolean | false | false |
| STAGE_COPY_OPTIONS | FORCE | Boolean | false | false |
| STAGE_LOCATION | URL | String | ["s3://EXAMPLE-S3-PATH/my-csvfiles/"] | |
| STAGE_CREDENTIALS | AWS_KEY_ID | String | | |
| DIRECTORY | LAST_REFRESHED_ON | Timestamp | 2023-05-03 12:50:28.000 -0700 | |
| DIRECTORY | ENABLE | Boolean | true | false |
| DIRECTORY | AUTO_REFRESH | Boolean | false | false |
+--------------------+--------------------------------+---------------+-------------------------------------------------------+------------------+