Product Documentation

WORKSPACES View

Records detailed information of WORKSPACE

COLUMN NAME	DATA TYPE	DESCRIPTION
WORKSPACE_ID	STRING	Workspace ID
WORKSPACE_NAME	STRING	Name of the workspace
WORKSPACE_CREATOR	STRING	Owner of the workspace
WORKSPACE_CREATOR_ID	STRING	Account ID of the workspace owner
WORKSPACE_STORAGE	BIGINT	Workspace storage status, excluding external tables and external data lakes, only internal data lakes and table storage are counted
CREATE_TIME	TIMESTAMP	Workspace creation time
LAST_MODIFY_TIME	TIMESTAMP	Workspace modification time
COMMENT	STRING	Workspace comment information
DELETE_TIME	TIMESTAMP	Workspace deletion time
PROPERTIES	MAP<STRING,STRING>	All set PROPERTIES are recorded in this parameter

SCHEMAS View

Records detailed information of SCHEMA Field Details

COLUMN NAME	DATA TYPE	DESCRIPTION
CATALOG_NAME	STRING	Name of the current WORKSPACE
SCHEMA_ID	STRING	SCHEMA ID
SCHEMA_NAME	STRING	Name of the SCHEMA
TYPE	STRING	Enum values EXTERNAL, MANAGED
SCHEMA_CREATOR	STRING	Account name of the database owner
SCHEMA_CREATOR_ID	STRING	Account ID of the database owner
CREATE_TIME	TIMESTAMP	Database creation time
LAST_MODIFY_TIME	TIMESTAMP	Database modification time
COMMENT	STRING	Comment information when creating the database
DELETE_TIME	TIMESTAMP	Database deletion time
PROPERTIES	MAP<STRING,STRING>	All set PROPERTIES will be recorded in this parameter

TABLES View

Each table in the current WORKSPACE is displayed in one row

COLUMN NAME	DATA TYPE	DESCRIPTION
TABLE_CATALOG	STRING	Name of the current WORKSPACE
TABLE_CATALOG_ID	STRING	ID of the WORKSPACE
TABLE_SCHEMA	STRING	SCHEMA to which the current TABLE belongs
TABLE_SCHEMA_ID	STRING	ID of the database corresponding to the table
TABLE_NAME	STRING	Table name
TABLE_ID	STRING	Table ID
TABLE_CREATOR	STRING	Table owner
TABLE_CREATOR_ID	STRING	Table creator ID
TABLE_TYPE	STRING	EXTERNAL TABLE: External table VIRTUAL_VIEW: View MATERIALIIZED VIEW: Materialized view MANAGED_TABLE: Standard table
ROW_COUNT	BIGINT	Number of rows, MATERIALIZED VIEW shows the corresponding number of rows. When the TABLE's ROW COUNT is NULL, it means it cannot be counted. The situations where it cannot be counted include: 1. Data written in real-time includes PRIMARY KEY tables. Since the data is constantly changing, the data in the MEMORY TABLE cannot be counted. 2. Most UPDATE and DELETE operations can usually be counted, but real-time written partition tables may not be counted after performing UPDATE/DELETE because the request does not carry information on how many rows were deleted at the time of deletion submission. 3. Deleting partitions with INSERT OVERWRITE PARTITION and TRUNCATE PARTITION, the request does not carry information on how many rows were deleted, so it cannot be recorded temporarily.
BYTES	BIGINT	Space occupied, VIEW shows NULL, MATERIALIZED VIEW shows the corresponding size
CREATE_TIME	TIMESTAMP	Table creation time
LAST_MODIFY_TIME	TIMESTAMP	Table modification time
DATA_LIFECYCLE	BIGINT	Lifecycle
IS_PARTITIONED	BOOLEAN	Whether it is a partitioned table
IS_CLUSTERED	BOOLEAN	Whether it is a clustered table
COMMENT	STRING	Table comment information
DELETE_TIME	TIMESTAMP	Deletion time, NULL if not deleted
DATA_LIFECYCLE	INT	Set lifecycle, if not set it shows NULL representing permanent, if set it will show the corresponding time
PROPERTIES	MAP<STRING,STRING>	All set PROPERTIES will be recorded in this parameter

COLUMNS View

The query result contains each field in the table as a row

COLUMN NAME	DATA TYPE	DESCRIPTION
TABLE_CATALOG	STRING	Name of the current WORKSPACE
TABLE_CATALOG_ID	STRING	ID of the WORKSPACE
TABLE_SCHEMA	STRING	SCHEMA to which the current TABLE belongs
TABLE_SCHEMA_ID	STRING	ID of the database corresponding to the table
TABLE_NAME	STRING	Table name
TABLE_ID	STRING	Table ID
COLUMN_NAME	STRING	Field name
COLUMN_ID	STRING	Field ID
COLUMN_DEFAULT	STRING	Field default value, currently reserved value
IS_NULLABLE	BOOLEAN	Whether it can be NULL
DATA_TYPE	STRING	Field type
IS_PARTITIONING_COLUMN	BOOLEAN	Whether it is a partition field
IS_CLUSTERING_COLUMN	BOOLEAN	Whether it is a CLUSTER table
IS_PRIMARY_KEY	BOOLEAN	Whether it is a primary key
COMMENT	STRING	Field comment information
DELETE_TIME	TIMESTAMP	Deletion time, NULL if not deleted

VIEWS View

Each view displays a row, containing all views under the current INSTANCE

COLUMN NAME	DATA TYPE	DESCRIPTION
TABLE_CATALOG	STRING	Name of the current WORKSPACE
TABLE_CATALOG_ID	STRING	ID of the WORKSPACE
TABLE_SCHEMA	STRING	SCHEMA to which the current VIEW belongs
TABLE_SCHEMA_ID	STRING	ID of the database corresponding to the view
TABLE_NAME	STRING	View name
TABLE_ID	STRING	View ID
TABLE_CREATOR	STRING	Account name of the view owner
TABLE_CREATOR_ID	STRING	Account ID of the view owner
VIEW_DEFINITION	STRING	Statement to create the view
CREATE_TIME	TIMESTAMP	View creation time
LAST_MODIFY_TIME	TIMESTAMP	View modification time
COMMENT	STRING	View comment information
DELETE_TIME	TIMESTAMP	Deletion time, NULL if not deleted

USERS View

Each user and workspace displays one row, containing all users of the current ACCOUNT

COLUMN NAME	DATA TYPE	DESCRIPTION
WORKSPACE_NAME	STRING	Workspace of the user
WORKSPACE_ID	STRING	Workspace ID of the user
USER_ID	STRING	User ID generated by the system
USER_NAME	STRING	User name, concatenated with WORKSPACE NAME and USER NAME
ROLE_NAME	STRING	Roles owned by the current user, multiple roles separated by commas
ADD_TIME	TIEMSTAMP	User creation time
EMAIL	STRING	User email
TELEPHONE	STRING	User phone
LAST_SUCCESS_LOGIN	TIMESTAMP	Last login time
COMMENT	STRING	Description of user information
DELETE_TIME	TIMESTAMP	Deletion time, NULL if not deleted
PROPERTIES	MAP<STRING,STRING>	All set PROPERTIES will be recorded in this parameter

ROLES View

Each role and workspace displays one row, containing all roles of the current ACCOUNT

COLUMN NAME	DATA TYPE	DESCRIPTION
WORKSPACE_NAME	STRING	Name of the current workspace
WORKSPACE_ID	STRING	Workspace ID of the role
ROLE_NAME	STRING	Role name
ROLE_ID	STRING	ROLE ID
USER_NAME	STRING	The name of the user granted this role, multiple users are separated by commas. Corresponding users for the ROLE
USER_ID	STRING	The ID of the user granted this role
COMMENT	STRING	Description of user information
DELETE_TIME	TIMESTAMP	Deletion time, NULL if not deleted

JOB_HISTORY View

Run information under all spaces

COLUMN NAME	DATA TYPE	DESCRIPTION
WORKSPACE_NAME	STRING	The space where the JOB is running
WORKSPACE_ID	STRING
JOB_ID	STRING	Job ID
JOB_NAME	STRING	Job name
JOB_CREATOR_ID	STRING	User ID running the job
JOB_CREATOR	STRING	User running the job
STATUS	STRING	SETUP RESUMING_CLUSTER QUEUED RUNNING SUCCESS FAILED CANCELED
CRU	DECIMAL(38,5)	Computing resources consumed by the user
ERROR_MESSAGE	STRING	This information will be available if there is an error during execution
JOB_TYPE	STRING	Job type SQL
JOB_TEXT	STRING	Statement executed by the JOB
START_TIME	TIMESTAMP	JOB start time
END_TIME	TIMESTAMP	JOB end time
EXECUTION_TIME	DOUBLE	Execution time, in seconds
INPUT_BYTES	BIGINT	Actual scanned data volume.
CACHE_HIT	BIGINT	Data read from cache
OUTPUT_BYTES	BIGINT	Output bytes.
INPUT_OBJECTS	STRING	Input table names in the format [SCHEMA].[TABLE], multiple tables separated by commas
OUTPUT_OBJECTS	STRING	Output table names in the format [SCHEMA].[TABLE]
CLIENT_INFO	STRING	Client information, from JDBC, client, web page, JAVA SDK
VIRTUAL_CLUSTER	STRING	Computing resources used
VIRTUAL_CLUSTER_ID	BIGINT
ROWS_PRODUCED	BIGINT	Total number of records processed, input data
ROWS_INSERTED	BIGINT	Should have a value if it is an insert action
ROWS_UPDATED	BIGINT	Should have a value if it is an update action
ROWS_DELETED	BIGINT	Should have a value if it is a delete action
JOB_CONFIG	STRING	Parameter information set when submitting the job
JOB_PRIORITY	STRING	Job priority
INPUT_TABLES	STRING	JSON format array 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	Name of the output object
QUERY_TAG	STRING	Users can tag the JOB in the client
ERROR_MESSAGE	STRING	Error message

MATERIALIZED VIEW Refresh View (MATERIALIZED_VIEW_REFRESH_HISTORY) {#materialized-view-refresh-history}

COLUMN_NAME	DATA_TYPE	DESCRIPTION
WORKSPACE_ID	BIGINT	Project space ID
WORKSPACE_NAME	STRING	Project space name
SCHEMA_ID	BIGINT	SCHEMA ID
SCHEMA_NAME	STRING	SCHEMA name
MATERIALIZED_VIEW_ID	BIGINT	Materialized view ID
MATERIALIZED_VIEW_NAME	STRING	Materialized view name
CREDITS_USED	DECIMAL	Credits used for refreshing the materialized view
VIRTUAL_CLUSER_ID	BIGINT	Materialized view ID
VIRTUAL_CLUSTER	STRING	Materialized view name, this information is available for automatic refresh
STATUS	STRING	PENDING\RUNNING\FINISHED\FAILED
REFRESH_MODE	STRING	Enum values INCREMENTAL FULL_REFRESH NO_DATA
STATISTICS	STRING	Records the number of incremental rows
SCHEDULE_START_TIME	TIMESTAMP_LTZ	Scheduled refresh time
START_TIME	TIMESTAMP_LTZ	Materialized view start time
END_TIME	TIMESTAMP_LTZ	Materialized view end time
ERROR_MESSAGE	STRING	Error message if the refresh fails, it will be here

VOLUMES View

column_name	data_type	description
VOLUME_CATALOG	STRING	Name of the associated Workspace
VOLUME_CATALOG_ID	STRING	ID of the associated Workspace
VOLUME_SCHEMA	STRING	Name of the associated Schema
VOLUME_SCHEMA_ID	STRING	ID of the schema corresponding to the Volume
VOLUME_NAME	STRING	Volume name
VOLUME_ID	STRING	Volume ID
VOLUME_URL	STRING	URL bound to the Volume
VOLUME_REGION	STRING	Region to which the Volume belongs
VOLUME_TYPE	STRING	Volume type (internal means no need to specify third-party cloud provider address when creating volume, or external)
VOLUME_CREATOR	STRING	Volume owner
CONNECTION_NAME	STRING	Referenced connection name
CONNECTION_ID	STRING	Referenced connection ID
PROPERTIES	map<string,string>
COMMENT	STRING	Comment
CREATE_TIME	TIMESTAMP	Creation time
LAST_MODIFY_TIME	TIMESTAMP	Modification time

CONNECTIONS View

column_name	data type	description
WORKSPACE_NAME	STRING	The workspace where the object is located
WORKSPACE_ID	STRING
CONNECTION_NAME	STRING	Connection object name
CONNECTION_ID	STRING
CONNECTION_KIND	STRING	Enum values supporting connection types, STORAGE CONNECTION, API CONNECTION
TYPE	STRING	Specifies the type of data source connection, storage connection supports FILE_SYSTEM, API connection supports CLOUD_FUNCTION
PROVIDER	STRING	When TYPE is FILE_SYSTEM, it is OSS / COS; when TYPE is CLOUD_FUNCTION, it is aliyun / tencent
REGION	STRING	The region connected to, such as ap-shanghai / cn-beijing
SOURCE_CREATOR	STRING	Creator
CREATED_TIME	TIMESTAMP	Creation time
COMMENT	STRING	Comment information
PROPERTIES	map<string,string>

OBJECT_PRIVILEGES View

Column Name	Data Type	Description
GRANTOR	TEXT	The USER who grants the privilege.
GRANTEE	TEXT	The user_name or role_name that is granted the privilege.
GRANTED_TO	TEXT	Whether the privilege is granted to a USER or ROLE.
OBJECT_CATALOG	TEXT	The workspace or catalog name where the granted object resides.
OBJECT_SCHEMA	TEXT	The schema where the granted object resides, or null if the object is not schema-bound.
OBJECT_NAME	TEXT	The name of the object that the privilege is granted on. Displayed directly without using workspace.schema.name format.
OBJECT_TYPE	TEXT	The type of the object that the privilege is granted on.
SUB_OBJECT_TYPE	TEXT	Sub-object type (details not provided).
PRIVILEGE_TYPE	TEXT	The specific type of privilege granted.
IS_GRANTABLE	TEXT	Whether the privilege was granted with the WITH GRANT OPTION.
AUTHORIZATION_TIME	TIMESTAMP_LTZ	The time when the privilege was granted.