Cette rubrique décrit les structures de données utilisées par l'API de métadonnées DLF.
GetViewResponse
| Name | Type | Description | Example |
|---|---|---|---|
| - | object | Détails de la vue. | - |
| id | string | ID de la vue. | 1 |
| name | string | Nom de la vue. | view_demo |
| schema | ViewSchema | Structure de la vue. | - |
GetTableResponse
| Name | Type | Description | Example |
|---|---|---|---|
| - | object | Détails de la table. | - |
| id | string | UUID de la table. | 1 |
| name | string | Nom de la table. | table_test |
| path | string | Chemin de la table. | oss://clg-paimon-xxx/db-xxx/tbl-xxxx |
| isExternal | string | Indique si la table est externe. | true |
| schemaId | string | ID du schéma de la table. | 1 |
| schema | Schema | Schéma de la table. | - |
| owner | string | Propriétaire de la table. | ALIYUN$1234567 |
| createdAt | long | Date de création de la table. Horodatage Unix en millisecondes. | 1741266704867 |
| createdBy | string | Utilisateur ayant créé la table. | acs:ram:1234567:root |
| updatedAt | long | Date de la dernière mise à jour de la table. Horodatage Unix en millisecondes. | 1741266704867 |
| updatedBy | string | Utilisateur ayant effectué la dernière mise à jour de la table. | acs:ram:1045689747920334:root |
Partition
| Name | Type | Description | Example |
|---|---|---|---|
| - | object | Détails de la partition. | - |
| spec | map | Paires clé-valeur des valeurs de partition. | {"year":"2025"} |
| recordCount | long | Nombre d'enregistrements dans la partition. | 1 |
| fileSizeInBytes | long | Taille totale des fichiers de partition, en octets. | 1024 |
| fileCount | long | Nombre de fichiers dans la partition. | 1 |
| lastFileCreationTime | long | Date de création du fichier le plus récent. Horodatage Unix en millisecondes. | 1741762385537 |
TableSnapshot
| Name | Type | Description | Example |
|---|---|---|---|
| - | object | Informations sur l'instantané de la table. | - |
| snapshot | Snapshot | Détails de l'instantané. | - |
| recordCount | long | Nombre total d'enregistrements. | 1 |
| fileSizeInBytes | long | Taille totale des fichiers, en octets. | 1024 |
| fileCount | long | Nombre total de fichiers. | 24 |
| lastFileCreationTime | long | Date de création du fichier le plus récent. Horodatage Unix en millisecondes. | 1741701564261 |
Identifier
| Name | Type | Description | Example |
|---|---|---|---|
| - | object | Identifiant de la table. | - |
| databaseName | string | Nom de la base de données. | db_test |
| tableName | string | Nom de la table. | table_test |
Schema
| Name | Type | Description | Example |
|---|---|---|---|
| - | object | Schéma de la table. | - |
| fields | array | Liste des champs de la table. Chaque élément est un DataField. | - |
| partitionKeys | array | Liste des noms de clés de partition. | ["partition_key1", "partition_key2"] |
| primaryKeys | array | Liste des noms de clés primaires. | ["pk1", "pk2"] |
| options | map | Options de la table sous forme de paires clé-valeur. | {"manifest.merge-min-count": "10"} |
| comment | string | Commentaire de la table. | test_comment |
DataField
| Name | Type | Description | Example |
|---|---|---|---|
| - | object | Définition d'un champ de table. | - |
| id | integer | ID du champ. | 1 |
| name | string | Nom du champ. | col_name |
| type | DataType | Type de données du champ. | - |
DataType
Un DataType correspond à l'un des éléments suivants :
| Name | Type | Description | Example |
|---|---|---|---|
| - | object | Type de données. Un seul des champs suivants est défini. | - |
| primitiveType | string | Type de données primitif. Valeurs valides : BIGINT, BINARY, BOOLEAN, CHAR, DATE, DECIMAL, DOUBLE, FLOAT, INT, SMALLINT, TIMESTAMP, TINYINT, VARBINARY, VARCHAR, VARIANT. |
BIGINT |
| arrayType | ArrayType | Type tableau. | - |
| multisetType | MultisetType | Type multiensemble. | - |
| mapType | MapType | Type mappage. | - |
| rowType | RowType | Type ligne. | - |
SchemaChange
Un SchemaChange décrit une opération unique d'évolution du schéma. Chaque opération est identifiée par son champ type. Utilisez le tableau suivant pour déterminer le sous-type à utiliser :
| Type value | Structure | Operation |
|---|---|---|
setOption |
SetOption | Définit une option de table. |
removeOption |
RemoveOption | Supprime une option de table. |
updateComment |
UpdateComment | Met à jour le commentaire de la table. |
addColumn |
AddColumn | Ajoute une colonne. |
renameColumn |
RenameColumn | Renomme une colonne. |
dropColumn |
DropColumn | Supprime une colonne. |
updateColumnComment |
UpdateColumnComment | Met à jour le commentaire d'une colonne. |
updateColumnType |
UpdateColumnType | Met à jour le type d'une colonne. |
updateColumnPosition |
UpdateColumnPosition | Met à jour la position d'une colonne. |
updateColumnNullability |
UpdateColumnNullability | Met à jour la nullabilité d'une colonne. |
ViewSchema
| Name | Type | Description | Example |
|---|---|---|---|
| - | object | Structure de la vue. | - |
| fields | array | Liste des champs de la vue. Chaque élément est un DataField. | - |
| query | string | Instruction de requête de la vue. | - |
| dialects | map\ |
Dialectes SQL et leurs instructions de requête correspondantes. | {"flink": "xxxx", "spark": "xxxx"} |
| comment | string | Commentaire de la vue. | - |
| options | map | Options de la vue sous forme de paires clé-valeur. | - |
Snapshot
| Name | Type | Nullable | Description | Example |
|---|---|---|---|---|
| - | object | - | Détails de l'instantané. | - |
| version | integer | Yes | Version du format de fichier de l'instantané. La version actuelle est 3. | 3 |
| id | long | No | ID de l'instantané. | 6 |
| schemaId | long | No | ID du schéma de la table au moment de cet instantané. | 0 |
| baseManifestList | string | No | Liste des manifestes de base. | manifest-list-0c6fcaa1-b6bc-413d-9634-6471cce4f37e-2 |
| baseManifestListSize | long | Yes | Taille de la liste des manifestes de base, en octets. | 845 |
| deltaManifestList | string | No | Liste des manifestes enregistrant toutes les nouvelles modifications dans cet instantané. | manifest-list-0c6fcaa1-b6bc-413d-9634-6471cce4f37e-3 |
| deltaManifestListSize | long | Yes | Taille de la liste des manifestes delta, en octets. | 759 |
| changelogManifestList | string | Yes | Liste des manifestes enregistrant tous les journaux de modifications générés dans cet instantané. | manifest-list-0c6fcaa1-b6bc-413d-9634-6471cce4f37e-4 |
| changelogManifestListSize | long | Yes | Taille de la liste des manifestes du journal des modifications, en octets. | 759 |
| indexManifest | string | Yes | Manifeste enregistrant tous les fichiers d'index pour cette table. | index-manifest-7cbdaa47-9578-43ac-ae6e-a7ec0486bba8-0 |
| commitUser | string | No | Généralement un UUID, utilisé pour reprendre l'écriture en flux continu. | 446aac61-bd5c-4fa0-8b14-846fa8810651 |
| commitIdentifier | long | No | ID de transaction pour l'écriture en flux continu. | 9223372036854775807 |
| commitKind | string | No | Type d'écriture en flux continu. Valeurs valides : APPEND, COMPACT, OVERWRITE, ANALYZE. |
COMPACT |
| timeMillis | long | No | Horodatage de validation en millisecondes. | 1741701564261 |
| logOffsets | Map\ |
Yes | Décalages de journal au moment de cette validation. | {0: 1L, 1: 3L} |
| totalRecordCount | long | Yes | Nombre total d'enregistrements pour toutes les modifications dans cet instantané. | 1024 |
| deltaRecordCount | long | Yes | Nombre d'enregistrements dans les nouvelles modifications de cet instantané. | 10 |
| changelogRecordCount | long | Yes | Nombre d'enregistrements du journal des modifications générés dans cet instantané. | 100 |
| watermark | long | Yes | Valeur du filigrane (watermark). | -9223372036854775808 |
| statistics | string | Yes | Nom du fichier de statistiques pour cette table. | - |
Instant
Un Instant correspond à l'un des éléments suivants :
| Name | Type | Description | Example |
|---|---|---|---|
| - | object | Référence temporelle ponctuelle. Un seul des champs suivants est défini. | - |
| snapshotInstant | SnapshotInstant | Instant basé sur un instantané. | 1 |
| tagInstant | TagInstant | Instant basé sur un tag. | test_tag |
SnapshotInstant
| Name | Type | Description | Example |
|---|---|---|---|
| - | object | Référence temporelle ponctuelle basée sur un instantané. | - |
| snapshotId | long | ID de l'instantané. | 1 |
TagInstant
| Name | Type | Description | Example |
|---|---|---|---|
| - | object | Référence temporelle ponctuelle basée sur un tag. | - |
| tagName | string | Nom du tag. | 1 |
ArrayType
| Name | Type | Description | Example |
|---|---|---|---|
| - | object | Type de données tableau. | - |
| type | string | Identifiant de type. Modèle : ^ARRAY.*. |
ARRAY |
| element | DataType | Type de données des éléments. | INT |
MultisetType
| Name | Type | Description | Example |
|---|---|---|---|
| - | object | Type de données multiensemble. | - |
| type | string | Identifiant de type. Modèle : ^MULTISET.*. |
MULTISET |
| element | DataType | Type de données des éléments. | BIGINT |
MapType
| Name | Type | Description | Example |
|---|---|---|---|
| - | object | Type de données mappage. | - |
| type | string | Identifiant de type. Modèle : ^MAP.*. |
MAP |
| key | DataType | Type de données des clés. | STRING |
| value | DataType | Type de données des valeurs. | BOOLEAN |
RowType
| Name | Type | Description | Example |
|---|---|---|---|
| - | object | Type de données ligne. | - |
| type | string | Identifiant de type. Modèle : ^ROW.*. |
ROW |
| fields | array | Liste des champs. Chaque élément est un DataField. | - |
SetOption
| Name | Type | Description | Example |
|---|---|---|---|
| - | object | Définit une option de table. | - |
| type | string | Valeur fixe : setOption. |
setOption |
| key | string | Clé de l'option. | manifest.delete-file-drop-stats |
| value | string | Valeur de l'option. | true |
RemoveOption
| Name | Type | Description | Example |
|---|---|---|---|
| - | object | Supprime une option de table. | - |
| type | string | Valeur fixe : removeOption. |
removeOption |
| key | string | Clé de l'option à supprimer. | manifest.delete-file-drop-stats |
UpdateComment
| Name | Type | Description | Example |
|---|---|---|---|
| - | object | Met à jour le commentaire de la table. | - |
| type | string | Valeur fixe : updateComment. |
updateComment |
| comment | string | Nouveau commentaire de la table. | comment_test |
AddColumn
| Name | Type | Description | Example |
|---|---|---|---|
| - | object | Ajoute une colonne à la table. | - |
| type | string | Valeur fixe : addColumn. |
addColumn |
| fieldNames | array | Chemin vers le nouveau champ, sous forme de liste de segments de nom de champ. | - |
| dataType | DataType | Type de données du nouveau champ. | - |
| comment | string | Commentaire du champ. | comment_test |
| move | Move | Position d'insertion du nouveau champ. | - |
RenameColumn
| Name | Type | Description | Example |
|---|---|---|---|
| - | object | Renomme une colonne. | - |
| type | string | Valeur fixe : renameColumn. |
renameColumn |
| fieldNames | array | Chemin vers le champ, sous forme de liste de segments de nom de champ. | - |
| newName | string | Nouveau nom du champ. | new_col_test |
DropColumn
| Name | Type | Description | Example |
|---|---|---|---|
| - | object | Supprime une colonne. | - |
| type | string | Valeur fixe : dropColumn. |
dropColumn |
| fieldNames | array | Chemin vers le champ, sous forme de liste de segments de nom de champ. | - |
UpdateColumnComment
| Name | Type | Description | Example |
|---|---|---|---|
| - | object | Met à jour le commentaire d'une colonne. | - |
| type | string | Valeur fixe : updateColumnComment. |
updateColumnComment |
| fieldNames | array | Chemin vers le champ, sous forme de liste de segments de nom de champ. | - |
| newComment | string | Nouveau commentaire du champ. | col_comment_test |
UpdateColumnType
| Name | Type | Description | Example |
|---|---|---|---|
| - | object | Met à jour le type d'une colonne. | - |
| type | string | Valeur fixe : updateColumnType. |
updateColumnType |
| fieldNames | array | Chemin vers le champ, sous forme de liste de segments de nom de champ. | - |
| newDataType | DataType | Nouveau type de données du champ. | - |
| keepNullability | boolean | Indique s'il faut conserver le paramètre de nullabilité existant lors du changement de type. | true |
UpdateColumnPosition
| Name | Type | Description | Example |
|---|---|---|---|
| - | object | Met à jour la position d'une colonne. | - |
| type | string | Valeur fixe : updateColumnPosition. |
updateColumnPosition |
| fieldNames | array | Chemin vers le champ, sous forme de liste de segments de nom de champ. | - |
| move | Move | Position cible pour le champ. | - |
UpdateColumnNullability
| Name | Type | Description | Example |
|---|---|---|---|
| - | object | Met à jour la nullabilité d'une colonne. | - |
| type | string | Valeur fixe : updateColumnNullability. |
updateColumnNullability |
| newNullability | boolean | Indique si la colonne accepte les valeurs nulles. | true |
Move
Spécifie comment positionner un champ lors de l'ajout ou du déplacement d'une colonne.
| Name | Type | Description | Example |
|---|---|---|---|
| - | object | Informations sur la position de la colonne. | - |
| fieldName | string | Nom du champ à déplacer. | col_test |
| referenceFieldName | string | Champ de référence pour le positionnement AFTER et BEFORE. |
other_col_test |
| type | string | Type de déplacement. Valeurs valides : FIRST, AFTER, BEFORE, LAST. |
FIRST |