REST Resource: hive.v1.projects.catalogs.databases.tables

リソース: HiveTable

Hive テーブル情報を保存します。これには、テーブル名、スキーマ（列名と型）、データの場所、ストレージ形式、serde 情報などが含まれます。このメッセージは、IMetastoreClient の Table オブジェクトと密接に一致します。

JSON 表現 
{
  "name": string,
  "description": string,
  "storageDescriptor": {
    object (StorageDescriptor)
  },
  "createTime": string,
  "partitionKeys": [
    {
      object (FieldSchema)
    }
  ],
  "parameters": {
    string: string,
    ...
  },
  "viewOriginalText": string,
  "viewExpandedText": string,
  "tableType": string,
  "updateTime": string
}
フィールド
name

string

ID。リソース名。形式: projects/{project_id_or_number}/catalogs/{catalogId}/databases/{databaseId}/tables/{tableId}
description

string

省略可。テーブルの説明。最大文字数は 4,000 文字です。
storageDescriptor

object (StorageDescriptor)

必須。テーブルのストレージ記述子。
createTime

string (Timestamp format)

出力専用。テーブルの作成時刻。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
partitionKeys[]

object (FieldSchema)

省略可。テーブルのパーティション キー。
parameters

map (key: string, value: string)

省略可。テーブルに関連付けられているプロパティを保存します。最大サイズは 4 MiB です。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
viewOriginalText

string

省略可。元のビューテキスト。ビュー以外の場合は空です。最大サイズは 16 MiB です。
viewExpandedText

string

省略可。展開ビューのテキスト。ビュー以外の場合は空です。最大サイズは 16 MiB です。
tableType

string

出力専用。テーブルの種類。BigLake Hive テーブルの場合は EXTERNAL です。
updateTime

string (Timestamp format)

出力専用。テーブルの更新時刻。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。

StorageDescriptor

テーブルデータの物理ストレージに関する情報が含まれます。

JSON 表現 
{
  "columns": [
    {
      object (FieldSchema)
    }
  ],
  "locationUri": string,
  "inputFormat": string,
  "outputFormat": string,
  "serdeInfo": {
    object (SerdeInfo)
  },
  "bucketCols": [
    string
  ],
  "sortCols": [
    {
      object (Order)
    }
  ],
  "parameters": {
    string: string,
    ...
  },
  "skewedInfo": {
    object (SkewedInfo)
  },
  "compressed": boolean,
  "numBuckets": integer,
  "storedAsSubDirs": boolean
}
フィールド
columns[]

object (FieldSchema)

必須。テーブルの列を指定します。
locationUri

string

省略可。テーブルが配置されている Cloud Storage URI。デフォルトは <database_location_uri>/<table_name> です。最大文字数は 4,000 文字です。
inputFormat

string

省略可。入力形式の完全修飾された Java クラス名。最大文字数は 4,000 文字です。
outputFormat

string

省略可。出力形式の完全修飾された Java クラス名。最大文字数は 4,000 文字です。
serdeInfo

object (SerdeInfo)

省略可。シリアル化とデシリアル化の情報。
bucketCols[]

string

省略可。リデューサーのグループ化列、クラスタリング列、バケット列
sortCols[]

object (Order)

省略可。各バケット内のデータの並べ替え順序
parameters

map (key: string, value: string)

省略可。ストレージ記述子の Key-Value ペア。最大サイズは 10 Kib です。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
skewedInfo

object (SkewedInfo)

省略可。テーブルのデータスキュー情報。
compressed

boolean

省略可。テーブルが圧縮されているかどうか。
numBuckets

integer

省略可。テーブル内のバケット数。
storedAsSubDirs

boolean

省略可。テーブルがサブディレクトリとして保存されるかどうか。

FieldSchema

フィールド スキーマ情報。

JSON 表現 
{
  "name": string,
  "type": string,
  "comment": string
}
フィールド
name

string

必須。フィールドの名前。最大文字数は 767 文字です。
type

string

必須。フィールドの型。最大長は 128 文字です。
comment

string

省略可。フィールドのコメント。最大長は 256 文字です。

SerdeInfo

シリアル化とデシリアル化の情報。

JSON 表現 
{
  "name": string,
  "serializationLib": string,
  "description": string,
  "parameters": {
    string: string,
    ...
  },
  "serializerClass": string,
  "deserializerClass": string,
  "serdeType": enum (SerdeType)
}
フィールド
name

string

必須。SerDe の名前。デフォルトではテーブル名。最大長は 128 文字です。
serializationLib

string

必須。シリアル化ライブラリの完全修飾 Java クラス名。最大文字数は 4,000 文字です。
description

string

省略可。serde の説明。最大文字数は 4,000 文字です。
parameters

map (key: string, value: string)

省略可。serde のパラメータ。最大サイズは 10 Kib です。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
serializerClass

string

省略可。シリアライザーの完全修飾 Java クラス名。最大文字数は 4,000 文字です。
deserializerClass

string

省略可。デシリアライザーの完全修飾された Java クラス名。最大文字数は 4,000 文字です。
serdeType

enum (SerdeType)

省略可。serde 型。

SerdeType

serde 型。

列挙型
SERDE_TYPE_UNSPECIFIED serde 型が指定されていません。
HIVE Hive。
SCHEMA_REGISTRY スキーマ レジストリ。

注文

列ごとの保存データの並べ替え順序。

JSON 表現 
{
  "col": string,
  "order": integer
}
フィールド
col

string

必須。列の名前。最大文字数は 767 文字です。
order

integer

必須。列の並べ替え順序を定義します。1 の場合は昇順、0 の場合は降順。

SkewedInfo

スキューされたテーブルに関するすべての情報を保存します。

JSON 表現 
{
  "skewedColNames": [
    string
  ],
  "skewedColValues": [
    {
      object (SkewedColumnValue)
    }
  ],
  "skewedKeyValuesLocations": [
    {
      object (SkewedKeyValuesLocation)
    }
  ]
}
フィールド
skewedColNames[]

string

必須。スキューされている列名。最大長は列名あたり 256 文字です。
skewedColValues[]

object (SkewedColumnValue)

必須。歪んだ列の値。
skewedKeyValuesLocations[]

object (SkewedKeyValuesLocation)

必須。スキューされたキー値の場所。

SkewedColumnValue

歪んだ列の値。

JSON 表現 
{
  "values": [
    string
  ]
}
フィールド
values[]

string

必須。スキューされた列の値。最大長は値あたり 256 文字です。

SkewedKeyValuesLocation

スキューされたキー値と対応する場所。

JSON 表現 
{
  "values": [
    string
  ],
  "location": string
}
フィールド
values[]

string

必須。スキューされた列の値。最大長は値あたり 256 文字です。
location

string

必須。歪んだ列の値の場所。最大文字数は 4,000 文字です。

メソッド

create

 新しい Hive テーブルを作成します。

delete

 テーブル名で指定された既存のテーブルを削除します。

get

 リソース名で指定されたテーブルを取得します。

list

 Hive カタログとデータベースにある指定されたプロジェクトのすべての Hive テーブルを一覧表示します。

patch

 テーブル名で指定された既存のテーブルを更新します。