getTableProperties

Prev Next

VPC環境で利用できます。

テーブルの詳細属性情報を照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /api/v1/catalogs/{catalogId}/databases/{databaseName}/tables/{tableName}/properties

リクエストヘッダ

Data Catalog APIで共通して使用されるヘッダの詳細は、Data Catalogのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
catalogId Integer Required カタログ ID
databaseName String Required データベース名
tableName String Required テーブル名

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://datacatalog.apigw.ntruss.com/api/v1/catalogs/4**/databases/default/tables/atmosphere_data/properties'  \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
EXTERNAL String - テーブルを外部に保存するかどうか
  • TRUE | FALSE
    • TRUE: 外部に保存
    • FALSE: 内部に保存
compressionType String - 圧縮ファイルの拡張子
  • スキャン対象が圧縮ファイルの場合、表示
clusterNo String - DBサービス番号
  • スキャン対象がデータベースの場合、表示
connectionId String - コネクション ID
  • コネクションが存在する場合、表示
connectionName String - コネクション名
  • コネクションが存在する場合、表示
created_time String - テーブルの作成日時
  • Unix Timestamp形式
dataFormat String - データ形式
dataType String - データタイプ
delimiter String - 区切り文字
  • データが CSVファイルの場合、表示
inputFormat String - データ読み取り形式
isDirectory String - スキャン対象はディレクトリかどうか
  • TRUE | FALSE
    • TRUE: ディレクトリ
    • FALSE: ディレクトリではない
last_modified_time String - 更新日時
  • Unix Timestamp形式
metadata_location String - メタデータのファイルパス
  • Icebergテーブルの場合、表示
numFiles String - スキャンした総ファイル数
  • スキャン対象がディレクトリの場合、表示
objectstorageContentLength String - オブジェクトの長さ(Byte)
objectstorageContentType String - オブジェクトのデータタイプ
objectstorageLastModified String - オブジェクトの更新日時
  • Unix Timestamp形式
outputFormat String - データ出力形式
partitioningScheme String - パーティショニングスキーマ
  • スキャン対象にパーティションが認識された場合、表示
scannerId String - スキャナー ID
scannerName String - スキャナー名
serializationLib String - シリアル化・逆シリアル化ライブラリ
skip.header.line.count String - 除外したヘッダライン数
totalSize String - スキャンした総データ量(Byte)
  • スキャン対象がディレクトリの場合、表示
transient_lastDdlTime String - テーブル DDLの更新日時
  • Unix Timestamp形式
serde.escapeChar String - データ認識除去文字
  • データが CSVファイルの場合、表示
serde.quoteChar String - データ認識文字
  • データが CSVファイルの場合、表示
serde.separatorChar String - スキーマ決定区切り文字
  • データが CSVファイルの場合、表示
参考

テーブルタイプに応じて表示される属性情報が異なる場合があります。

RDBデータの場合

RDB(MySQL、MSSQL、PostgreSQL)データの場合、追加で表示される属性の説明は次の通りです。

フィールド タイプ 必須の有無 説明
{dbType}Collation String - 文字列ソート設定
{dbType}DataSize String - データのサイズ
{dbType}IndexSize String - インデックスのサイズ
{dbType}Indexes String - インデックスの構造
{dbType}Rows String - 行(レコード)数
{dbType}TableSize String - テーブルの総サイズ

MongoDBデータの場合

MongoDBデータの場合、追加で表示される属性の説明は次の通りです。

フィールド タイプ 必須の有無 説明
mongodbAvgObjSize String - コレクションのオブジェクトサイズの平均
mongodbFreeStorageSize String - コレクションの空き容量
mongodbIndexSize String - コレクションインデックスのサイズ
mongodbIndexes String - コレクションインデックス情報
mongodbRowCount String - コレクション行(レコード)数
mongodbSize String - コレクションサイズ
  • 圧縮されていないサイズ
  • インデックスサイズを除く
mongodbStorageSize String - コレクションに割り当てられたストレージ容量
mongodbTotalSize String - コレクションの総ディスク容量

レスポンスステータスコード

Data Catalog APIで共通して使用されるレスポンスステータスコードの詳細は、Data Catalogのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
  "EXTERNAL": "TRUE",
  "compressionType": "",
  "created_time": "1743125379",
  "dataFormat": "csv",
  "dataType": "file",
  "inputFormat": "org.apache.hadoop.mapred.TextInputFormat",
  "isDirectory": "TRUE",
  "objectstorageContentLength": "2783",
  "objectstorageContentType": "text/csv",
  "objectstorageLastModified": "1743125017",
  "outputFormat": "org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat",
  "partitioningScheme": "hive",
  "scannerId": "9**",
  "scannerName": "scan_airQuality",
  "serializationLib": "org.apache.hadoop.hive.serde2.OpenCSVSerde",
  "skip.header.line.count": "1",
  "transient_lastDdlTime": "1743125379",
  "serde.quoteChar": "\"",
  "serde.escapeChar": "\\",
  "serde.separatorChar": ","
}