System Tables
HeavyDB system tables provide a way to access information about database objects, database object permissions, and system resource (storage, CPU, and GPU memory) utilization. These system tables can be found in the information_schema
database that is available by default on server startup. You can query system tables in the same way as regular tables, and you can use the SHOW CREATE TABLE
command to view the table schemas.
Users
The users
system table provides information about all database users and contains the following columns:
Databases
The databases
system table provides information about all created databases on the server and contains the following columns:
Permissions
The permissions
system table provides information about all user/role permissions for all database objects and contains the following columns:
Roles
The roles
system table lists all created database roles and contains the following columns:
Tables
The tables
system table provides information about all database tables and contains the following columns:
Dashboards
The dashboards
system table provides information about created dashboards (enterprise edition only) and contains the following columns:
Role Assignments
The role_assignments
system table provides information about database roles that have been assigned to users and contains the following columns:
Memory Summary
The memory_summary
system table provides high level information about utilized memory across CPU and GPU devices and contains the following columns:
Memory Details
The memory_details
system table provides detailed information about allocated memory segments across CPU and GPU devices and contains the following columns:
Storage Details
The storage_details
system table provides detailed information about utilized storage per table and contains the following columns:
Log-Based System Tables
Log-based system tables are considered beta functionality in Release 6.1.0 and are disabled by default.
Request Logs
The request_logs
system table provides information about HeavyDB Thrift API requests and contains the following columns:
Server Logs
The server_logs
system table provides HeavyDB server logs in tabular form and contains the following columns:
Web Server Logs
The web_server_logs
system table provides HEAVY.AI Web Server logs in tabular form and contains the following columns (Enterprise Edition only):
Web Server Access Logs
The web_server_access_logs
system table provides information about requests made to the HEAVY.AI Web Server. The table contains the following columns:
Refreshing Logs System Tables
The logs system tables must be refreshed manually to view new log entries. You can run the REFRESH FOREIGN TABLES
SQL command (for example, REFRESH FOREIGN TABLES server_logs, request_logs;
), or click the Refresh Data Now button on the table’s Data Manager page in Heavy Immerse.
Request Logs and Monitoring System Dashboard
The Request Logs and Monitoring system dashboard is built on the log-based system tables and provides visualization of request counts, performance, and errors over time, along with the server logs.
System Dashboards
Preconfigured system dashboards are built on various system tables. Specifically, two dashboards named System Resources and User Roles and Permissions are available by default. The Request Logs and Monitoring system dashboard is considered beta functionality and disabled by default. These dashboards can be found in the information_schema
database, along with the system tables that they use.
Access to system dashboards is controlled using Heavy Immerse privileges; only users with Admin privileges or users/roles with access to the information_schema
database can access the system dashboards.
Cross-linking must be enabled to allow cross-filtering across charts that use different system tables. Enable cross-linking by adding "ui/enable_crosslink_panel": true
to the feature_flags
section of the servers.json file.
Last updated