getTable

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in VPC

View a specific table with the database/table name of the user's catalog.

Requests

Request URL

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

Request parameters

Parameter name	Required	Type	Service limits	Description
catalogId	Yes	String	Unique catalog ID (ref: getCatalogs)
databaseName	Yes	String		Database name
tableName	Yes	String		Table name

Request header

See common guide

Request examples

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}"

Responses

Response bodies

Item	Type	Description
catalogId	Int	Unique catalog ID
databaseName	String	Database name
tableName	String	Table name
dataFormat	String	Data format of table
location	String	Position of table
description	String	Description
createTime	Date	Table creation date and time
updateTime	Date	Table editing date and time
properties.EXTERNAL	String	External storage status
properties.connectionId	String	Unique ID of the connection used for scanning
properties.connectionName	String	Connection name used for scanning
properties.created_time	String	Table creation date and time
properties.dataFormat	String	Format of data source
properties.dataType	String	Type of data source
properties.delimiter	String	Delimiter if the source data is a CSV file
properties.inputFormat	String	Format for reading file into Object
properties.isDirectory	String	Information on whether the scan target is a directory
properties.last_modified_time	String	Table modification date and time
properties.numFiles	String	Total number of files scanned when the scan target is a directory
properties.outputFormat	String	Format for writing file into Object
properties.scannerId	String	ID of the scanner for which a table is created
properties.scannerName	String	Name of the scanner for which a table is created
properties.serializationLib	String	Serializer and Deserializer Library
properties.totalSize	String	Total amount of data scanned when the scan target is a directory
properties.transient_lastDdlTime	String	Date and time of the last change in the DDL of table

Additional properties for RDB

Item	Type	Description
properties.{dbType}Collation	String	Table collation
properties.{dbType}DataSize	String	Data size saved in table
properties.{dbType}IndexSize	String	Index size of table
properties.{dbType}Indexes	String	Index information set in table
properties.{dbType}Rows	String	Number of row in table
properties.{dbType}TableSize	String	Total table size

Additional properties for MongoDB

Item	Type	Description
properties.mongodbAvgObjSize	String	Average object size of collection
properties.mongodbFreeStorageSize	String	Available save size of collection
properties.mongodbIndexSize	String	Index size of collection
properties.mongodbIndexes	String	Index information of collection
properties.mongodbRowCount	String	Number of row in collection
properties.mongodbSize	String	Uncompressed size of collection (exclude index size)
properties.mongodbStorageSize	String	Total save size assigned to collection
properties.mongodbTotalSize	String	Total disk usage of collection (storage size + index size)

Response examples

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"
  }
}

Was this article helpful?

What's Next

getTablesByDatabase

Table of contents

Requests
Responses