describe 명령
describe 명령
describe 명령은 인덱스 메타데이터를 조회해요. describe 명령은 PPL 쿼리에서 첫 번째 명령으로만 사용할 수 있어요. 명령의 인자는 선택적 데이터 소스, 선택적 스키마, 필수 테이블 이름으로 구성된 점으로 구분된 테이블 경로예요.
출처: 문서
본문
구문(Syntax)
describe 명령은 다음과 같은 구문을 가져요.
describe [<data-source>.][<schema>.]<table-name>
매개변수(Parameters)
describe 명령은 다음 매개변수를 지원해요.
| Parameter | Required/Optional | Description |
|---|---|---|
<table-name> |
Required | 조회할 테이블. |
<data-source> |
Optional | 사용할 데이터 소스. 기본값은 OpenSearch datasource예요. |
<schema> |
Optional | 사용할 스키마. 기본값은 기본 스키마예요. |
예시 1: 모든 메타데이터 가져오기
이 예시는 accounts 인덱스를 설명해요.
describe accounts
이 쿼리는 다음과 같은 결과를 반환해요.
| TABLE_CAT | TABLE_SCHEM | TABLE_NAME | COLUMN_NAME | DATA_TYPE | TYPE_NAME | COLUMN_SIZE | BUFFER_LENGTH | DECIMAL_DIGITS | NUM_PREC_RADIX | NULLABLE | REMARKS | COLUMN_DEF | SQL_DATA_TYPE | SQL_DATETIME_SUB | CHAR_OCTET_LENGTH | ORDINAL_POSITION | IS_NULLABLE | SCOPE_CATALOG | SCOPE_SCHEMA | SCOPE_TABLE | SOURCE_DATA_TYPE | IS_AUTOINCREMENT | IS_GENERATEDCOLUMN |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| docTestCluster | null | accounts | account_number | null | bigint | null | null | null | 10 | 2 | null | null | null | null | null | 0 | null | null | null | null | NO | ||
| docTestCluster | null | accounts | firstname | null | string | null | null | null | 10 | 2 | null | null | null | null | null | 1 | null | null | null | null | NO | ||
| docTestCluster | null | accounts | address | null | string | null | null | null | 10 | 2 | null | null | null | null | null | 2 | null | null | null | null | NO | ||
| docTestCluster | null | accounts | balance | null | bigint | null | null | null | 10 | 2 | null | null | null | null | null | 3 | null | null | null | null | NO | ||
| docTestCluster | null | accounts | gender | null | string | null | null | null | 10 | 2 | null | null | null | null | null | 4 | null | null | null | null | NO | ||
| docTestCluster | null | accounts | city | null | string | null | null | null | 10 | 2 | null | null | null | null | null | 5 | null | null | null | null | NO | ||
| docTestCluster | null | accounts | employer | null | string | null | null | null | 10 | 2 | null | null | null | null | null | 6 | null | null | null | null | NO | ||
| docTestCluster | null | accounts | state | null | string | null | null | null | 10 | 2 | null | null | null | null | null | 7 | null | null | null | null | NO | ||
| docTestCluster | null | accounts | age | null | bigint | null | null | null | 10 | 2 | null | null | null | null | null | 8 | null | null | null | null | NO | ||
| docTestCluster | null | accounts | null | string | null | null | null | 10 | 2 | null | null | null | null | null | 9 | null | null | null | null | NO | |||
| docTestCluster | null | accounts | lastname | null | string | null | null | null | 10 | 2 | null | null | null | null | null | 10 | null | null | null | null | NO |
예시 2: 조건 및 필터로 메타데이터 가져오기
이 예시는 accounts 인덱스에서 bigint 타입의 열을 검색해요.
describe accounts
| where TYPE_NAME="bigint"
| fields COLUMN_NAME
이 쿼리는 다음과 같은 결과를 반환해요.
| COLUMN_NAME |
|---|
| account_number |
| balance |
| age |