视图及其字段详细信息文档

WORKSPACES视图

记录了WORKSPACE的详细信息

COLUMN NAME	DATA TYPE	DESCRIPTION
WORKSPACE_ID	STRING	工作空间ID
WORKSPACE_NAME	STRING	工作空间的名字
WORKSPACE_CREATOR	STRING	工作空间的所有者
WORKSPACE_CREATOR_ID	STRING	工作空间的所有者的帐号ID
WORKSPACE_STORAGE	BIGINT	工作空间存储情况，外部表和外部数据湖不计入，统计内部数据湖和表存储情况
CREATE_TIME	TIMESTAMP	工作空间创建时间
LAST_MODIFY_TIME	TIMESTAMP	工作空间改时间
COMMENT	STRING	工作空间注释信息
DELETE_TIME	TIMESTAMP	工作空间删除时间
PROPERTIES	MAP<STRING,STRING>	设置的PROPERTIES都会记录在此参数中

SCHEMAS视图

记录了SCHEMA的详细信息 字段详细信息

COLUMN NAME	DATA TYPE	DESCRIPTION
CATALOG_NAME	STRING	当前WORKSPACE的名字
SCHEMA_ID	STRING	SCHEMA的ID
SCHEMA_NAME	STRING	SCHEMA的名字
TYPE	STRING	枚举值EXTERNAL 、MANAGED
SCHEMA_CREATOR	STRING	数据库的所有者的帐号名字
SCHEMA_CREATOR_ID	STRING	数据库的所有者的帐号ID
CREATE_TIME	TIMESTAMP	数据库创建时间
LAST_MODIFY_TIME	TIMESTAMP	数据库修改时间
COMMENT	STRING	创建数据库时注释信息
DELETE_TIME	TIMESTAMP	数据库删除时间
PROPERTIES	MAP<STRING,STRING>	设置的PROPERTIES都会记录在此参数中

TABLES视图

当前WORKSPACE下，每个表显示一行

COLUMN NAME	DATA TYPE	DESCRIPTION
TABLE_CATALOG	STRING	当前WORKSPACE的名称
TABLE_CATALOG_ID	STRING	WORKSPACE的ID
TABLE_SCHEMA	STRING	当前TABLE所属的SCHEMA
TABLE_SCHEMA_ID	STRING	表对应数据库的ID
TABLE_NAME	STRING	表名字
TABLE_ID	STRING	表ID
TABLE_CREATOR	STRING	表的所有者
TABLE_CREATOR_ID	STRING	表创建者ID
TABLE_TYPE	STRING	EXTERNAL TABLE：外部表 VIRTUAL_VIEW：视图 MATERIALIIZED VIEW：物化视图 MANAGED_TABLE：标准表
ROW_COUNT	BIGINT	条数,此处可能显示的为估计值，，显示估计值统计的情况包含 1.通过实时写入的数据包含PRIMARY KEY表，由于数据一直在变动存在MEMORY TABLE的数据无法准确统计 2.通常大部分UPDATE和DELETE操作是可以统计，但是实时写过的分区表，然后做UPDATE/DELETE 可能统计不准确,因为在执行删除提交时，请求没有携带文件删除多少条信息暂时无法记录 3.删除分区INSERT OVERWRITE PARTITION和TRUNCATE PARTITION，请求没有携带文件删除多少条信息可能统计不准确
BYTES	BIGINT	占用空间大小, 条数,此处可能显示的为估计值，，显示估计值统计的情况包含 1.通过实时写入的数据包含PRIMARY KEY表，由于数据一直在变动存在MEMORY TABLE的数据无法准确统计 2.通常大部分UPDATE和DELETE操作是可以统计，但是实时写过的分区表，然后做UPDATE/DELETE 可能统计不准确,因为在执行删除提交时，请求没有携带文件删除文件信息暂时无法记录 3.删除分区INSERT OVERWRITE PARTITION和TRUNCATE PARTITION，请求没有携带文件删除大小信息可能统计不准确
CREATE_TIME	TIMESTAMP	表创建时间
LAST_MODIFY_TIME	TIMESTAMP	表修改时间
DATA_LIFECYCLE	BIGINT	生命周期
IS_PARTITIONED	BOOLEAN	是否是分区表
IS_CLUSTERED	BOOLEAN	是否是分桶表
COMMENT	STRING	表注释信息
DELETE_TIME	TIMESTAMP	删除时间，没有删除为NULL
DATA_LIFECYCLE	INT	设置的生命周期，如果未设置显示为NULL代表永久，设置则会显示相应时间
PROPERTIES	MAP<STRING,STRING>	设置的PROPERTIES都会记录在此参数中

COLUMNS视图

查询结果包含表中每个字段为一行

COLUMN NAME	DATA TYPE	DESCRIPTION
TABLE_CATALOG	STRING	当前WORKSPACE的名称
TABLE_CATALOG_ID	STRING	WORKSPACE的ID
TABLE_SCHEMA	STRING	当前TABLE所属的SCHEMA
TABLE_SCHEMA_ID	STRING	表对应数据库的ID
TABLE_NAME	STRING	表名字
TABLE_ID	STRING	表ID
COLUMN_NAME	STRING	字段的名字
COLUMN_ID	STRING	字段ID
COLUMN_DEFAULT	STRING	字段默认值,当前保留值
IS_NULLABLE	BOOLEAN	是否可以为NULL
DATA_TYPE	STRING	字段类型
IS_PARTITIONING_COLUMN	BOOLEAN	是否是分区字段
IS_CLUSTERING_COLUMN	BOOLEAN	是否是CLUSTER表
IS_PRIMARY_KEY	BOOLEAN	是否是主键
COMMENT	STRING	字段的注释信息
DELETE_TIME	TIMESTAMP	删除时间，没有删除为NULL

VIEWS视图

每个视图显示一行，包含当前INSTANCE下所有的视图

COLUMN NAME	DATA TYPE	DESCRIPTION
TABLE_CATALOG	STRING	当前WORKSPACE的名称
TABLE_CATALOG_ID	STRING	WORKSPACE的ID
TABLE_SCHEMA	STRING	当前VIEW所属的SCHEMA
TABLE_SCHEMA_ID	STRING	视图对应数据库的ID
TABLE_NAME	STRING	视图名字
TABLE_ID	STRING	视图ID
TABLE_CREATOR	STRING	视图所有者的帐号名字
TABLE_CREATOR_ID	STRING	视图所有者的帐号ID
VIEW_DEFINITION	STRING	创建视图的语句
CREATE_TIME	TIMESTAMP	视图创建时间
LAST_MODIFY_TIME	TIMESTAMP	视图修改时间
COMMENT	STRING	视图的注释信息
DELETE_TIME	TIMESTAMP	删除时间，没有删除为NULL

USERS视图

每个用户和空间显示一行，包含当前ACCOUNT所有的用户

COLUMN NAME	DATA TYPE	DESCRIPTION
WORKSPACE_NAME	STRING	用户所在的工作空间
WORKSPACE_ID	STRING	用户所在的空间ID
USER_ID	STRING	系统根据用户生成的用户ID,
USER_NAME	STRING	用户名称，使用WORKSPACE NAME和USER NAME 拼接
ROLE_NAME	STRING	当前用户拥有的角色，多个角色使用逗号分隔
ADD_TIME	TIEMSTAMP	用户创建时间
EMAIL	STRING	用户邮箱
TELEPHONE	STRING	用户电话
LAST_SUCCESS_LOGIN	TIMESTAMP	上次登录时间
COMMENT	STRING	描述用户信息
DELETE_TIME	TIMESTAMP	删除时间，没有删除为NULL
PROPERTIES	MAP<STRING,STRING>	设置的PROPERTIES都会记录在此参数中

ROLES视图

每个角色和空间显示一行，包含当前ACCOUNT所有的角色

COLUMN NAME	DATA TYPE	DESCRIPTION
WORKSPACE_NAME	STRING	当前空间的名字
WORKSPACE_ID	STRING	角色所在的空间ID
ROLE_NAME	STRING	角色名称,
ROLE_ID	STRING	ROLE ID
USER_NAME	STRING	被授予该角色的用户名称，多个用户使用逗号分隔符。ROLE对应用户有哪些
USER_ID	STRING	被授予该角色的用户ID
COMMENT	STRING	描述用户信息
DELETE_TIME	TIMESTAMP	删除时间，没有删除为NULL

JOB_HISTORY视图

所有空间下的运行信息

COLUMN NAME	DATA TYPE	DESCRIPTION
WORKSPACE_NAME	STRING	运行JOB所在的空间
WORKSPACE_ID	STRING
JOB_ID	STRING	作业ID
JOB_NAME	STRING	作业名称
JOB_CREATOR_ID	STRING	运行作业的用户ID
JOB_CREATOR	STRING	运行作业的用户
STATUS	STRING	SETUP RESUMING_CLUSTER QUEUED RUNNING SUCCESS FAILED CANCELED
CRU	DECIMAL(38,5)	用户消耗的计算资源
ERROR_MESSAGE	STRING	如果运行出错会有此信息
JOB_TYPE	STRING	作业类型 SQL
JOB_TEXT	STRING	执行JOB的语句
START_TIME	TIMESTAMP	JOB运行开始时间
END_TIME	TIMESTAMP	JOB运行结束时间
EXECUTION_TIME	DOUBLE	执行时间，单位为秒
INPUT_BYTES	BIGINT	实际扫描的数据量。
CACHE_HIT	BIGINT	从缓存中读取的数据
OUTPUT_BYTES	BIGINT	输出字节数。
INPUT_OBJECTS	STRING	输入的表名格式为[SCHEMA].[TABLE]多个以，分隔
OUTPUT_OBJECTS	STRING	输出的表名格式为[SCHEMA].[TABLE]
CLIENT_INFO	STRING	客户端信息，来自于JDBC、客户端、WEB页面、JAVA SDK
VIRTUAL_CLUSTER	STRING	使用的计算资源
VIRTUAL_CLUSTER_ID	BIGINT
ROWS_PRODUCED	BIGINT	处理的总记录数，输入的数据
ROWS_INSERTED	BIGINT	如果是插入行为应该有值
ROWS_UPDATED	BIGINT	如果是更新行为应该有值
ROWS_DELETED	BIGINT	如果是删除行为应该有值
JOB_CONFIG	STRING	提交作业时设置的参数信息
JOB_PRIORITY	STRING	作业优先级
INPUT_TABLES	STRING	JSON格式数组 INPUT_TABLES:{[{TABLE:WORKSAPCE_NAME.SCHEMA.TABLENAME1, SIZE:0,RECORD:0,CACHESIZE:0,PARTITIONS:[]},{TABLE:WORKSAPCE_NAME.SCHEMA.TABLENAME2 SIZE:0,RECORD:0,CACHESIZE:0,PARTITIONS:[]}......]}
OUTPUT_TABLES	STRING	输出的对象名称
QUERY_TAG	STRING	用户可以在客户给JOB打标签
ERROR_MESSAGE	STRING	错误信息

MATERIALIZED VIEW刷新视图(MATERIALIZED_VIEW_REFRESH_HISTORY)

COLUMN_NAME	DATA_TYPE	DESCRIPTION
WORKSPACE_ID	BIGINT	项目空间ID
WORKSPACE_NAME	STIRNG	项目空间名字
SCHEMA_ID	BIGINT	SCHEMA ID
SCHEMA_NAME	STRING	SCHEMA名字
MATERIALIZED_VIEW_ID	BIGINT	物化视图
MATERIALIZED_VIEW_NAME	STRING	物化视图名字
CREDITS_USED	DECIMAL	刷新物化视图使用的计费
VIRTUAL_CLUSER_ID	BIGINT	物化视图ID
VIRTUAL_CLUSTER	STRING	物化视图名字，自动刷新会有此信息
STATUS	STRING	PENDING\RUNNING\FINISHED\FAILED
REFRESH_MODE	STRING	枚举值INCREMETAL FULL_REFRESH NO_DATA
STATISTICS	STRING	记录增量刷多少条
SCHEDULE_START_TIME	TIMESTAMP_LTZ	计划刷新时间
START_TIME	TIMESTAMP_LTZ	物化视图开始时间
END_TIME	TIMESTAMP_LTZ	物化视图结束时间
ERROR_MESSAGE	STRING	刷新失败的信息，如果失败则会在这里有

VOLUMES视图

column_name	data_type	description
VOLUME_CATALOG	STRING	所属 Workspace 名称
VOLUME_CATALOG_ID	STRING	所属 Workspace 的ID
VOLUME_SCHEMA	STRING	所属 Schema 名称
VOLUME_SCHEMA_ID	STRING	Volume对应数schema的ID
VOLUME_NAME	STRING	Volume 名称
VOLUME_ID	STRING	Volume的ID
VOLUME_URL	STRING	Volume 绑定的URL
VOLUME_REGION	STRING	Volume 所属区域
VOLUME_TYPE	STRING	Volume 类型(internal指创建volumn时不用指定第三方云厂商地址，或者 external)
VOLUME_CREATOR	STRING	Volume 的 owner
CONNECTION_NAME	STRING	引用的connection名称
CONNECTION_ID	STRING	引用的connection的ID
PROPERTIES	map<string,string>
COMMENT	STRING	注释
CREATE_TIME	TIMESTAMP	创建时间
LAST_MODIFY_TIME	TIMESTAMP	修改时间

CONNECTIONS视图

column_name	data type	description
WORKSPACE_NAME	STRING	对象所在的空间
WORKSPACE_ID	STRING
CONNECTION_NAME	STRING	连接对象名称
CONNECTION_ID	STRING
CONNECTION_KIND	STRING	枚举值支持的connection种类，STORAGE CONNECTION、 API CONNECTION
TYPE	STRING	指定连接数据源的类型 storage connection支持 FILE_SYSTEM api connection支持 CLOUD_FUNCTION
PROVIDER	STRING	TYPE 为 FILE_SYSTEM 时为 OSS / COS TYPE 为 CLOUD_FUNCTION 时为 aliyun / tencent
REGION	STRING	connection 连接的region，比如 ap-shanghai / cn-beijing
SOURCE_CREATOR	STRING	创建者
CREATED_TIME	TIMESTAMP	创建时间
COMMENT	STRING	注释信息
PROPERTIES	map<string,string>

OBJECT_PRIVILEGES视图

Column Name	Data Type	Description
GRANTOR	TEXT	授出权限的USER
GRANTEE	TEXT	被授予权限的user_name 或 role_name
GRANTED_TO	TEXT	USER/ROLE
OBJECT_CATALOG	TEXT	被授予对象所在的工作空间或catalog名称
OBJECT_SCHEMA	TEXT	被授予对象所在的schema，如果对象不在schema下则为空
OBJECT_NAME	TEXT	被授权的对象名称。直接显示名称，不用workspace.schema.name的方式。
OBJECT_TYPE	TEXT	被授权的对象的类型
SUB_OBJECT_TYPE	TEXT
PRIVILEGE_TYPE	TEXT	被授予的具体角色
IS_GRANTABLE	TEXT	授权时是否有 WITH GRANT OPTION
AUTHORIZATION_TIME	TIMESTAMP_LTZ	权限授予时间

联系我们