getTable

인쇄
공유
PDF

기사 요약

이 요약이 도움이 되었나요?

의견을 보내 주셔서 감사합니다.

VPC 환경에서 이용 가능합니다.

사용자 catalog의 database/table 이름으로 특정 table을 조회합니다.

요청

요청 URL

GET {DATA_CATALOG API_URL}/catalogs/{catalog-id}/databases/{database-name}/tables/{table-name}

요청 파라미터

파라미터명	필수 여부	타입	제약 사항	설명
catalogId	Yes	String	catalog 고유 id (ref: getCatalogs)
databaseName	Yes	String		database 이름
tableName	Yes	String		table 이름

요청 헤더

공통 가이드 참조

요청 예시

curl -X GET "https://datacatalog.apigw.ntruss.com/api/v1/catalogs/{catalog-id}/databases/{database-name}/tables/{table-name}" \
    -H "x-ncp-apigw-timestamp: {x-ncp-apigw-timestamp}" \
    -H "x-ncp-iam-access-key: {x-ncp-iam-access-key}"  \
    -H "x-ncp-apigw-signature-v2: {x-ncp-apigw-signature-v2}"

응답

응답 바디

항목	타입	설명
catalogId	Int	catalog 고유 id
databaseName	String	database 이름
tableName	String	table 이름
dataFormat	String	table의 데이터 형식
location	String	table 위치
description	String	설명
createTime	Date	table 생성 일시
updateTime	Date	table 수정 일시
properties.EXTERNAL	String	외부 저장 여부
properties.connectionId	String	스캔을 위해 이용한 커넥션의 고유 id
properties.connectionName	String	스캔을 위해 이용한 커넥션 이름
properties.created_time	String	table의 생성 일시
properties.dataFormat	String	데이터 소스의 형식
properties.dataType	String	데이터 소스의 유형
properties.delimiter	String	소스 데이터가 CSV 파일인 경우 구분 기호
properties.inputFormat	String	File을 Object로 읽기 위한 Fotmat 형식
properties.isDirectory	String	스캔 대상의 디렉터리 여부
properties.last_modified_time	String	table의 수정 일시
properties.numFiles	String	디렉터리인 경우 스캔한 총 파일 수
properties.outputFormat	String	Object를 File로 쓰기 위한 Fotmat 형식
properties.scannerId	String	table을 생성한 스캐너 ID
properties.scannerName	String	table을 생성한 스캐너 이름
properties.serializationLib	String	Serializer and Deserializer Library
properties.totalSize	String	디렉터리인 경우 스캔한 총 데이터 용량
properties.transient_lastDdlTime	String	table의 DDL 마지막 변경 일시

RDB인 경우 추가 properties

항목	타입	설명
properties.{dbType}Collation	String	테이블의 collation
properties.{dbType}DataSize	String	테이블에 저장된 데이터 크기
properties.{dbType}IndexSize	String	테이블의 인덱스 크기
properties.{dbType}Indexes	String	테이블에 설정한 인덱스 정보
properties.{dbType}Rows	String	테이블의 row 개수
properties.{dbType}TableSize	String	전체 테이블 크기

MongoDB인 경우 추가 properties

항목	타입	설명
properties.mongodbAvgObjSize	String	컬렉션의 평균 오브젝트 크기
properties.mongodbFreeStorageSize	String	컬렉션의 저장 가능 크기
properties.mongodbIndexSize	String	컬렉션의 인덱스 크기
properties.mongodbIndexes	String	컬렉션의 인덱스 정보
properties.mongodbRowCount	String	컬렉션의 row 개수
properties.mongodbSize	String	컬렉션의 압축되지않은 크기 (index size 제외)
properties.mongodbStorageSize	String	컬렉션에 할당된 총 저장 크기
properties.mongodbTotalSize	String	컬렉션의 전체 디스크 사용량 (storage size + index size)

응답 예시

HTTP

HTTP Status	Description
200	OK

JSON

{
  "catalogId": 2144,
  "databaseName": "default",
  "tableName": "scan_dir",
  "dataFormat": "csv",
  "location": "s3a://bububu/scan-dir/",
  "description": "test table description",
  "createTime": "2023-03-29T14:12:37+0900",
  "updateTime": "2023-06-02T14:01:30+0900",
  "properties": {
    "EXTERNAL": "TRUE",
    "connectionName": "bububu-conn",
    "created_time": "1680066757",
    "dataFormat": "csv",
    "dataType": "file",
    "delimiter": ",",
    "inputFormat": "org.apache.hadoop.mapred.TextInputFormat",
    "isDirectory": "TRUE",
    "last_modified_time": "1685682090",
    "numFiles": "1",
    "outputFormat": "org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat",
    "scannerId": "283",
    "scannerName": "bububu-scanner",
    "serializationLib": "org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe",
    "totalSize": "8402",
    "transient_lastDdlTime": "1680066757"
  }
}

이 문서가 도움이 되었습니까?

What's Next

getTablesByDatabase

요청
응답