このトピックでは、メタデータ API に関連するデータ構造について説明します。
GetViewResponse
名前 | タイプ | 説明 | 例 |
- | object | ビューの詳細。 | |
id | string | ビュー ID。 | 1 |
name | string | ビュー名。 | view_demo |
schema | ビューの構造。 |
GetTableResponse
名前 | タイプ | 説明 | 例 |
- | object | テーブルの詳細。 | |
id | string | テーブルの UUID。 | 1 |
name | string | テーブル名。 | table_test |
path | string | テーブルのパス。 | oss://clg-paimon-xxx/db-xxx/tbl-xxxx |
isExternal | string | 外部。 | true |
schemaId | string | テーブルスキーマの ID。 | 1 |
schema | テーブルスキーマ。 | ||
owner | string | テーブルのオーナー。 | ALIYUN$1234567 |
createdAt | long | テーブルが作成された時間。 | 1741266704867 |
createdBy | string | テーブルを作成したユーザー。 | acs:ram:1234567:root |
updatedAt | long | テーブルが最後に更新された時間。 | 1741266704867 |
updatedBy | string | 更新者 | acs:ram:1045689747920334:root |
パーティション
名前 | タイプ | 説明 | 例 |
- | object | パーティションの詳細。 | |
spec | map | パーティション値のキーと値のペア。 | {"year":"2025"} |
recordCount | long | レコード数。 | 1 |
fileSizeInBytes | long | ファイルサイズ (バイト単位)。 | 1024 |
fileCount | long | ファイル数。 | 1 |
lastFileCreationTime | long | 最新のファイルが作成された時間。 | 1741762385537 |
TableSnapshot
名前 | タイプ | 説明 | 例 |
- | object | テーブルスナップショットに関する情報。 | |
snapshot | スナップショット情報。 | ||
recordCount | long | レコード数。 | table_test |
fileSizeInBytes | long | ファイルサイズ (バイト単位)。 | 1024 |
fileCount | long | ファイル数。 | 24 |
lastFileCreationTime | long | 最新のファイルが作成された時間。 | 1741701564261 |
Identifier
名前 | タイプ | 説明 | 例 |
- | object | テーブル識別子。 | |
databaseName | string | データベース名。 | db_test |
tableName | string | テーブル名。 | table_test |
スキーマ
名前 | タイプ | 説明 | 例 |
- | object | テーブルスキーマ。 | |
| array | テーブルフィールドのリスト。 | |
dataField | テーブルフィールド。 | ||
| array | パーティションキーのリスト。 | ["partition_key1", "partition_key2"] |
partitionKey | string | パーティションキー。 | partition_key1 |
| array | プライマリキーのリスト。 | ["pk1", "pk2"] |
primaryKey | string | プライマリキー。 | pk1 |
options | map | テーブル構成。 | {"manifest.merge-min-count": "10"} |
comment | string | テーブルの説明。 | test_comment |
DataField
名前 | タイプ | 説明 | 例 |
- | object | テーブルフィールド。 | |
id | integer | フィールド ID。 | 1 |
name | string | フィールド名。 | table_test |
type | データの型。 |
DataType
名前 | タイプ | 説明 | 例 |
- | object | データの型。これは、次の特定のデータの型のいずれかになります。 | ArrayType |
primitiveType | string | 基本データ型。有効な値は、BIGINT、BINARY、BOOLEAN、CHAR、DATE、DECIMAL、DOUBLE、FLOAT、INT、TIMESTAMP、SMALLINT、TINYINT、VARBINARY、VARCHAR、および VARIANT です。 | BIGINT |
arrayType | 配列型。 | ||
multisetType | コレクション型。 | ||
mapType | キーと値のペアの型。 | ||
rowType | 複合行型。 |
SchemaChange
名前 | タイプ | 説明 | 例 |
- | object | スキーマ進化に関する情報。これは、次のデータ構造のいずれかになります。 | |
setOption | テーブルオプションを更新します。 | ||
RemoveOption | テーブルオプションを削除します。 | ||
UpdateComment | テーブルの説明を更新します。 | ||
AddColumn | 列を追加します。 | ||
RenameColumn | 列の名前を変更します。 | ||
DropColumn | 列を削除します。 | ||
UpdateColumnComment | 列の説明を更新します。 | ||
UpdateColumnType | 列の型を更新します。 | ||
UpdateColumnPosition | 列の位置を更新します。 | ||
UpdateColumnNullability | 列の Null 許容性を更新します。 |
ViewSchema
名前 | タイプ | 説明 | 例 |
- | object | ビューの構造。 | |
| array | ビューフィールドのリスト。 | |
dataField | ビューフィールド。 | ||
query | string | ビューの検索文。 | |
dialects | map<string, string> | ダイアレクト。 | { "flink": "xxxx", "spark": "xxxx" } |
comment | string | コメント。 | |
options | map | プロパティ。 |
スナップショット
名前 | タイプ | Null 許容 | 説明 | 例 |
- | object | スナップショット情報。 | ||
version | integer | はい | スナップショットファイルのバージョン。現在のバージョンは 3 です。 | 3 |
id | long | いいえ | スナップショット ID。 | 6 |
schemaId | long | いいえ | テーブルスキーマの ID。 | 0 |
baseManifestList | string | いいえ | ベースマニフェストリスト。 | manifest-list-0c6fcaa1-b6bc-413d-9634-6471cce4f37e-2 |
baseManifestListSize | long | はい | ベースマニフェストリストのサイズ。 | 845 |
deltaManifestList | string | いいえ | このスナップショットのすべての新しい変更を記録するマニフェストリスト。 | manifest-list-0c6fcaa1-b6bc-413d-9634-6471cce4f37e-3 |
deltaManifestListSize | long | はい | このスナップショットのすべての新しい変更を記録するマニフェストリストのサイズ。 | 759 |
changelogManifestList | string | はい | このスナップショットで生成されたすべての変更ログを記録するマニフェストリスト。 | manifest-list-0c6fcaa1-b6bc-413d-9634-6471cce4f37e-4 |
changelogManifestListSize | long | はい | このスナップショットで生成されたすべての変更ログを記録するマニフェストリストのサイズ。 | 759 |
indexManifest | string | はい | このテーブルのすべてのインデックスファイルを記録するマニフェスト。 | index-manifest-7cbdaa47-9578-43ac-ae6e-a7ec0486bba8-0 |
commitUser | string | いいえ | 通常は UUID で、ストリーム書き込みを再開するために使用されます。 | 446aac61-bd5c-4fa0-8b14-846fa8810651 |
commitIdentifier | long | いいえ | ストリーム書き込みのトランザクション ID。 | 9223372036854775807 |
commitKind | string | いいえ | ストリーム書き込みのタイプ。有効な値は、APPEND、COMPACT、OVERWRITE、および ANALYZE です。 | COMPACT |
timeMillis | long | いいえ | コミット時間 (ミリ秒単位)。 | 1741701564261 |
logOffsets | Map<Integer, Long> | はい | コミットログのオフセット。 | {0: 1L, 1: 3L} |
totalRecordCount | long | はい | このスナップショットのすべての変更の合計レコード数。 | 1024 |
deltaRecordCount | long | はい | このスナップショットのすべての新しい変更のレコード数。 | 10 |
changelogRecordCount | long | はい | このスナップショットで生成されたすべての変更ログのレコード数。 | 100 |
watermark | long | はい | ウォーターマーク。 | -9223372036854775808 |
statistics | string | はい | このテーブルの統計ファイルの名前。 |
Instant
名前 | タイプ | 説明 | 例 |
- | object | 次のデータ構造のいずれか。 | |
snapshotInstant | スナップショット定数。 | 1 | |
tagInstant | タグ定数。 | test_tag |
SnapshotInstant
名前 | タイプ | 説明 | 例 |
- | object | スナップショット情報定数。 | |
snapshotId | long | スナップショット ID。 | 1 |
TagInstant
名前 | タイプ | 説明 | 例 |
- | object | タグ情報定数。 | |
tagName | string | タグ名。 | 1 |
ArrayType
名前 | タイプ | 説明 | 例 |
- | object | 配列データ型。 | |
type | string | パターン: ^ARRAY.* | ARRAY |
element | データの型。 | INT |
MultisetType
名前 | タイプ | 説明 | 例 |
- | object | コレクションデータ型。 | |
type | string | パターン: ^MULTISET.* | MULTISET |
element | データの型。 | BIGINT |
MapType
名前 | タイプ | 説明 | 例 |
- | object | データの型。 | |
type | string | パターン: ^MAP.* | MAP |
key | データの型。 | STRING | |
value | データの型。 | BOOLEAN |
RowType
名前 | タイプ | 説明 | 例 |
- | object | 行データ型。 | |
type | string | パターン: ^ROW.* | ROW |
| array | フィールドの配列。 | |
field | フィールド。 |
SetOption
名前 | タイプ | 説明 | 例 |
- | object | テーブルオプションを設定します。 | |
type | string | 定数: setOption。 | setOption |
key | string | テーブルオプションのキーと値のペアのキー。 | 'manifest.delete-file-drop-stats' |
value | string | テーブルオプションのキーと値のペアの値。 | 'true' |
RemoveOption
名前 | タイプ | 説明 | 例 |
- | object | テーブルオプションを削除します。 | |
type | string | 定数: removeOption。 | removeOption |
key | string | テーブルオプションのキーと値のペアのキー。 | 'manifest.delete-file-drop-stats' |
UpdateComment
名前 | タイプ | 説明 | 例 |
- | object | テーブルの説明を更新します。 | |
type | string | 定数: updateComment。 | updateComment |
comment | string | テーブルの説明。 | comment_test |
AddColumn
名前 | タイプ | 説明 | 例 |
- | object | 列を追加します。 | |
type | string | 定数: addColumn。 | addColumn |
| array | テーブルフィールドの名前。 | |
dataType | データの型。 | ||
comment | string | 説明。 | comment_test |
move | 移動情報。 |
RenameColumn
名前 | タイプ | 説明 | 例 |
- | object | カラムを追加できます。 | |
type | string | 定数: renameColumn。 | renameColumn |
| array | テーブルフィールド名の配列。 | |
newName | string | 新しいフィールド名。 | new_col_test |
DropColumn
名前 | タイプ | 説明 | 例 |
- | object | カラムを追加できます。 | |
type | string | 定数: dropColumn。 | dropColumn |
| array | テーブルフィールド名の配列。 |
UpdateColumnComment
名前 | タイプ | 説明 | 例 |
- | object | カラムを追加できます。 | |
type | string | 定数: updateColumnComment。 | updateColumnComment |
| array | テーブルフィールド名の配列。 | |
newComment | string | 新しいフィールドの説明。 | col_comment_test |
UpdateColumnType
名前 | タイプ | 説明 | 例 |
- | object | カラムを追加できます。 | |
type | string | 定数: updateColumnType。 | updateColumnType |
| array | テーブルフィールド名の配列。 | |
newDataType | 新しいフィールドのデータの型。 | ||
keepNullability | boolean | 列が Null 許容かどうかを示します。 | true |
UpdateColumnPosition
名前 | タイプ | 説明 | 例 |
- | object | 列の位置を更新します。 | |
type | string | 定数: updateColumnPosition。 | updateColumnPosition |
| array | テーブルフィールド名の配列。 | |
move | 移動情報。 |
UpdateColumnNullability
名前 | タイプ | 説明 | 例 |
- | object | 列の Null 許容性を更新します。 | |
type | string | 定数: updateColumnNullability。 | updateColumnNullability |
newNullability | boolean | 列が Null 許容かどうかを示します。 | true |
Move
名前 | タイプ | 説明 | 例 |
- | object | 列を追加できます。 | |
fieldName | string | フィールド名。 | col_test |
referenceFieldName | string | 参照フィールドの名前。 | other_col_test |
type | string | 移動タイプ。有効な値は FIRST、AFTER、BEFORE、および LAST です。 | FIRST |