Este tema describe las estructuras de datos que utiliza la API de metadatos de DLF.
GetViewResponse
|
Nombre |
Tipo |
Descripción |
Ejemplo |
|
- |
object |
Los detalles de la vista. |
- |
|
id |
string |
El identificador de la vista. |
1 |
|
name |
string |
El nombre de la vista. |
view_demo |
|
schema |
La estructura de la vista. |
- |
GetTableResponse
|
Nombre |
Tipo |
Descripción |
Ejemplo |
|
- |
object |
Los detalles de la tabla. |
- |
|
id |
string |
El UUID de la tabla. |
1 |
|
name |
string |
El nombre de la tabla. |
table_test |
|
path |
string |
La ruta de la tabla. |
oss://clg-paimon-xxx/db-xxx/tbl-xxxx |
|
isExternal |
string |
Indica si la tabla es una tabla externa. |
true |
|
schemaId |
string |
El identificador del esquema de la tabla. |
1 |
|
schema |
El esquema de la tabla. |
- |
|
|
owner |
string |
El propietario de la tabla. |
ALIYUN$1234567 |
|
createdAt |
long |
La fecha y hora en que se creó la tabla. Marca de tiempo Unix en milisegundos. |
1741266704867 |
|
createdBy |
string |
El usuario que creó la tabla. |
acs:ram:1234567:root |
|
updatedAt |
long |
La fecha y hora de la última actualización de la tabla. Marca de tiempo Unix en milisegundos. |
1741266704867 |
|
updatedBy |
string |
El usuario que actualizó la tabla por última vez. |
acs:ram:1045689747920334:root |
Partition
|
Nombre |
Tipo |
Descripción |
Ejemplo |
|
- |
object |
Los detalles de la partición. |
- |
|
spec |
map |
Los pares clave-valor de los valores de la partición. |
{"year":"2025"} |
|
recordCount |
long |
La cantidad de registros en la partición. |
1 |
|
fileSizeInBytes |
long |
El tamaño total de los archivos de la partición, en bytes. |
1024 |
|
fileCount |
long |
La cantidad de archivos en la partición. |
1 |
|
lastFileCreationTime |
long |
La fecha y hora de creación del archivo más reciente. Marca de tiempo Unix en milisegundos. |
1741762385537 |
TableSnapshot
|
Nombre |
Tipo |
Descripción |
Ejemplo |
|
- |
object |
La información de la instantánea de la tabla. |
- |
|
snapshot |
Los detalles de la instantánea. |
- |
|
|
recordCount |
long |
La cantidad total de registros. |
1 |
|
fileSizeInBytes |
long |
El tamaño total de los archivos, en bytes. |
1024 |
|
fileCount |
long |
La cantidad total de archivos. |
24 |
|
lastFileCreationTime |
long |
La fecha y hora de creación del archivo más reciente. Marca de tiempo Unix en milisegundos. |
1741701564261 |
Identifier
|
Nombre |
Tipo |
Descripción |
Ejemplo |
|
- |
object |
El identificador de la tabla. |
- |
|
databaseName |
string |
El nombre de la base de datos. |
db_test |
|
tableName |
string |
El nombre de la tabla. |
table_test |
Schema
|
Nombre |
Tipo |
Descripción |
Ejemplo |
|
- |
object |
El esquema de la tabla. |
- |
|
fields |
array |
La lista de campos de la tabla. Cada elemento es un DataField. |
- |
|
partitionKeys |
array |
La lista de nombres de claves de partición. |
["partition_key1", "partition_key2"] |
|
primaryKeys |
array |
La lista de nombres de claves primarias. |
["pk1", "pk2"] |
|
options |
map |
Las opciones de la tabla como pares clave-valor. |
{"manifest.merge-min-count": "10"} |
|
comment |
string |
El comentario de la tabla. |
test_comment |
DataField
|
Nombre |
Tipo |
Descripción |
Ejemplo |
|
- |
object |
Una definición de campo de la tabla. |
- |
|
id |
integer |
El identificador del campo. |
1 |
|
name |
string |
El nombre del campo. |
col_name |
|
type |
El tipo de datos del campo. |
- |
DataType
Un DataType corresponde a uno de los siguientes elementos:
|
Nombre |
Tipo |
Descripción |
Ejemplo |
|
- |
object |
El tipo de datos. Se establece exactamente uno de los siguientes campos. |
- |
|
primitiveType |
string |
Un tipo de datos primitivo. Valores válidos: |
BIGINT |
|
arrayType |
Un tipo de arreglo. |
- |
|
|
multisetType |
Un tipo de multiconjunto. |
- |
|
|
mapType |
Un tipo de mapa. |
- |
|
|
rowType |
Un tipo de fila. |
- |
SchemaChange
Un SchemaChange describe una sola operación de evolución de esquema. Cada operación se identifica mediante su campo type. Utilice la siguiente tabla para determinar qué subtipo debe usar:
|
Valor de Type |
Estructura |
Operación |
|
|
Establece una opción de la tabla. |
|
|
|
Elimina una opción de la tabla. |
|
|
|
Actualiza el comentario de la tabla. |
|
|
|
Agrega una columna. |
|
|
|
Cambia el nombre de una columna. |
|
|
|
Quita una columna. |
|
|
|
Actualiza el comentario de una columna. |
|
|
|
Actualiza el tipo de una columna. |
|
|
|
Actualiza la posición de una columna. |
|
|
|
Actualiza la nulabilidad de una columna. |
ViewSchema
|
Nombre |
Tipo |
Descripción |
Ejemplo |
|
- |
object |
La estructura de la vista. |
- |
|
fields |
array |
La lista de campos de la vista. Cada elemento es un DataField. |
- |
|
query |
string |
La instrucción de consulta de la vista. |
- |
|
dialects |
map\<string, string\> |
Los dialectos SQL y sus instrucciones de consulta correspondientes. |
{"flink": "xxxx", "spark": "xxxx"} |
|
comment |
string |
El comentario de la vista. |
- |
|
options |
map |
Las opciones de la vista como pares clave-valor. |
- |
Snapshot
|
Nombre |
Tipo |
Nullable |
Descripción |
Ejemplo |
|
- |
object |
- |
Los detalles de la instantánea. |
- |
|
version |
integer |
Yes |
La versión del formato del archivo de instantánea. La versión actual es 3. |
3 |
|
id |
long |
No |
El identificador de la instantánea. |
6 |
|
schemaId |
long |
No |
El identificador del esquema de la tabla al momento de esta instantánea. |
0 |
|
baseManifestList |
string |
No |
La lista de manifiestos base. |
manifest-list-0c6fcaa1-b6bc-413d-9634-6471cce4f37e-2 |
|
baseManifestListSize |
long |
Yes |
El tamaño de la lista de manifiestos base, en bytes. |
845 |
|
deltaManifestList |
string |
No |
La lista de manifiestos que registra todos los cambios nuevos en esta instantánea. |
manifest-list-0c6fcaa1-b6bc-413d-9634-6471cce4f37e-3 |
|
deltaManifestListSize |
long |
Yes |
El tamaño de la lista de manifiestos delta, en bytes. |
759 |
|
changelogManifestList |
string |
Yes |
La lista de manifiestos que registra todos los registros de cambios generados en esta instantánea. |
manifest-list-0c6fcaa1-b6bc-413d-9634-6471cce4f37e-4 |
|
changelogManifestListSize |
long |
Yes |
El tamaño de la lista de manifiestos de registro de cambios, en bytes. |
759 |
|
indexManifest |
string |
Yes |
El manifiesto que registra todos los archivos de índice de esta tabla. |
index-manifest-7cbdaa47-9578-43ac-ae6e-a7ec0486bba8-0 |
|
commitUser |
string |
No |
Por lo general, un UUID que se usa para reanudar la escritura de flujo. |
446aac61-bd5c-4fa0-8b14-846fa8810651 |
|
commitIdentifier |
long |
No |
El identificador de transacción para la escritura de flujo. |
9223372036854775807 |
|
commitKind |
string |
No |
El tipo de escritura de flujo. Valores válidos: |
COMPACT |
|
timeMillis |
long |
No |
La marca de tiempo de confirmación (commit) en milisegundos. |
1741701564261 |
|
logOffsets |
Map\<Integer, Long\> |
Yes |
Los desplazamientos de registro al momento de esta confirmación. |
{0: 1L, 1: 3L} |
|
totalRecordCount |
long |
Yes |
La cantidad total de registros en todos los cambios de esta instantánea. |
1024 |
|
deltaRecordCount |
long |
Yes |
La cantidad de registros en los cambios nuevos de esta instantánea. |
10 |
|
changelogRecordCount |
long |
Yes |
La cantidad de registros de cambio generados en esta instantánea. |
100 |
|
watermark |
long |
Yes |
El valor de la marca de agua. |
-9223372036854775808 |
|
statistics |
string |
Yes |
El nombre del archivo de estadísticas de esta tabla. |
- |
Instant
Un Instant corresponde a uno de los siguientes elementos:
|
Nombre |
Tipo |
Descripción |
Ejemplo |
|
- |
object |
Una referencia a un punto en el tiempo. Se establece exactamente uno de los siguientes campos. |
- |
|
snapshotInstant |
Un instante basado en una instantánea. |
1 |
|
|
tagInstant |
Un instante basado en una etiqueta. |
test_tag |
SnapshotInstant
|
Nombre |
Tipo |
Descripción |
Ejemplo |
|
- |
object |
Una referencia a un punto en el tiempo basada en una instantánea. |
- |
|
snapshotId |
long |
El identificador de la instantánea. |
1 |
TagInstant
|
Nombre |
Tipo |
Descripción |
Ejemplo |
|
- |
object |
Una referencia a un punto en el tiempo basada en una etiqueta. |
- |
|
tagName |
string |
El nombre de la etiqueta. |
1 |
ArrayType
|
Nombre |
Tipo |
Descripción |
Ejemplo |
|
- |
object |
Un tipo de datos de arreglo. |
- |
|
type |
string |
El identificador de tipo. Patrón: |
ARRAY |
|
element |
El tipo de datos del elemento. |
INT |
MultisetType
|
Nombre |
Tipo |
Descripción |
Ejemplo |
|
- |
object |
Un tipo de datos de multiconjunto. |
- |
|
type |
string |
El identificador de tipo. Patrón: |
MULTISET |
|
element |
El tipo de datos del elemento. |
BIGINT |
MapType
|
Nombre |
Tipo |
Descripción |
Ejemplo |
|
- |
object |
Un tipo de datos de mapa. |
- |
|
type |
string |
El identificador de tipo. Patrón: |
MAP |
|
key |
El tipo de datos de la clave. |
STRING |
|
|
value |
El tipo de datos del valor. |
BOOLEAN |
RowType
|
Nombre |
Tipo |
Descripción |
Ejemplo |
|
- |
object |
Un tipo de datos de fila. |
- |
|
type |
string |
El identificador de tipo. Patrón: |
ROW |
|
fields |
array |
La lista de campos. Cada elemento es un DataField. |
- |
SetOption
|
Nombre |
Tipo |
Descripción |
Ejemplo |
|
- |
object |
Establece una opción de la tabla. |
- |
|
type |
string |
Valor fijo: |
setOption |
|
key |
string |
La clave de la opción. |
manifest.delete-file-drop-stats |
|
value |
string |
El valor de la opción. |
true |
RemoveOption
|
Nombre |
Tipo |
Descripción |
Ejemplo |
|
- |
object |
Elimina una opción de la tabla. |
- |
|
type |
string |
Valor fijo: |
removeOption |
|
key |
string |
La clave de la opción que se va a eliminar. |
manifest.delete-file-drop-stats |
UpdateComment
|
Nombre |
Tipo |
Descripción |
Ejemplo |
|
- |
object |
Actualiza el comentario de la tabla. |
- |
|
type |
string |
Valor fijo: |
updateComment |
|
comment |
string |
El nuevo comentario de la tabla. |
comment_test |
AddColumn
|
Nombre |
Tipo |
Descripción |
Ejemplo |
|
- |
object |
Agrega una columna a la tabla. |
- |
|
type |
string |
Valor fijo: |
addColumn |
|
fieldNames |
array |
La ruta al nuevo campo, representada como una lista de segmentos de nombres de campo. |
- |
|
dataType |
El tipo de datos del nuevo campo. |
- |
|
|
comment |
string |
El comentario del campo. |
comment_test |
|
move |
La posición donde insertar el nuevo campo. |
- |
RenameColumn
|
Nombre |
Tipo |
Descripción |
Ejemplo |
|
- |
object |
Cambia el nombre de una columna. |
- |
|
type |
string |
Valor fijo: |
renameColumn |
|
fieldNames |
array |
La ruta al campo, representada como una lista de segmentos de nombres de campo. |
- |
|
newName |
string |
El nuevo nombre del campo. |
new_col_test |
DropColumn
|
Nombre |
Tipo |
Descripción |
Ejemplo |
|
- |
object |
Quita una columna. |
- |
|
type |
string |
Valor fijo: |
dropColumn |
|
fieldNames |
array |
La ruta al campo, representada como una lista de segmentos de nombres de campo. |
- |
UpdateColumnComment
|
Nombre |
Tipo |
Descripción |
Ejemplo |
|
- |
object |
Actualiza el comentario de una columna. |
- |
|
type |
string |
Valor fijo: |
updateColumnComment |
|
fieldNames |
array |
La ruta al campo, representada como una lista de segmentos de nombres de campo. |
- |
|
newComment |
string |
El nuevo comentario del campo. |
col_comment_test |
UpdateColumnType
|
Nombre |
Tipo |
Descripción |
Ejemplo |
|
- |
object |
Actualiza el tipo de una columna. |
- |
|
type |
string |
Valor fijo: |
updateColumnType |
|
fieldNames |
array |
La ruta al campo, representada como una lista de segmentos de nombres de campo. |
- |
|
newDataType |
El nuevo tipo de datos del campo. |
- |
|
|
keepNullability |
boolean |
Indica si se conserva la configuración de nulabilidad existente al cambiar el tipo. |
true |
UpdateColumnPosition
|
Nombre |
Tipo |
Descripción |
Ejemplo |
|
- |
object |
Actualiza la posición de una columna. |
- |
|
type |
string |
Valor fijo: |
updateColumnPosition |
|
fieldNames |
array |
La ruta al campo, representada como una lista de segmentos de nombres de campo. |
- |
|
move |
La posición de destino del campo. |
- |
UpdateColumnNullability
|
Nombre |
Tipo |
Descripción |
Ejemplo |
|
- |
object |
Actualiza la nulabilidad de una columna. |
- |
|
type |
string |
Valor fijo: |
updateColumnNullability |
|
newNullability |
boolean |
Indica si la columna acepta valores nulos. |
true |
Move
Especifica cómo posicionar un campo al agregar o mover una columna.
|
Nombre |
Tipo |
Descripción |
Ejemplo |
|
- |
object |
La información de posición de la columna. |
- |
|
fieldName |
string |
El nombre del campo que se va a mover. |
col_test |
|
referenceFieldName |
string |
El campo de referencia para el posicionamiento con |
other_col_test |
|
type |
string |
El tipo de movimiento. Valores válidos: |
FIRST |