Skip to main content
Version: 2.5

Information Schema

The StarRocks information_schema is a database within each StarRocks instance. information_schema contains several read-only, system-defined tables which store extensive metadata information of all objects that the StarRocks instance maintains.

View metadata via Information Schema

You can view the metadata information within a StarRocks instance by querying the content of tables in information_schema.

The following example views metadata information about a table named sr_member in StarRocks by querying the table tables.

mysql> SELECT * FROM information_schema.tables WHERE TABLE_NAME like 'sr_member'\G
*************************** 1. row ***************************
TABLE_CATALOG: def
TABLE_SCHEMA: sr_hub
TABLE_NAME: sr_member
TABLE_TYPE: BASE TABLE
ENGINE: StarRocks
VERSION: NULL
ROW_FORMAT: NULL
TABLE_ROWS: 6
AVG_ROW_LENGTH: 542
DATA_LENGTH: 3255
MAX_DATA_LENGTH: NULL
INDEX_LENGTH: NULL
DATA_FREE: NULL
AUTO_INCREMENT: NULL
CREATE_TIME: 2022-11-17 14:32:30
UPDATE_TIME: 2022-11-17 14:32:55
CHECK_TIME: NULL
TABLE_COLLATION: utf8_general_ci
CHECKSUM: NULL
CREATE_OPTIONS: NULL
TABLE_COMMENT: OLAP
1 row in set (1.04 sec)

Information Schema tables

StarRocks have optimized the metadata information provided by the following tables in information_schema:

Information Schema table nameDescription
tablesProvides general metadata information of tables.
tables_configProvides additional table metadata information that is unique to StarRocks.

tables

The following fields are provided in tables:

FieldDescription
TABLE_CATALOGName of the catalog that stores the table.
TABLE_SCHEMAName of the database that stores the table.
TABLE_NAMEName of the table.
TABLE_TYPEType of the table. Valid values: "BASE TABLE" or "VIEW".
ENGINEEngine type of the table. Valid values: "StarRocks", "MySQL", "MEMORY" or an empty string.
VERSIONApplies to a feature not available in StarRocks.
ROW_FORMATApplies to a feature not available in StarRocks.
TABLE_ROWSRow count of the table.
AVG_ROW_LENGTHAverage row length (size) of the table. It is equivalent to DATA_LENGTH / TABLE_ROWS. Unit: Byte.
DATA_LENGTHData length (size) of the table. Unit: Byte.
MAX_DATA_LENGTHApplies to a feature not available in StarRocks.
INDEX_LENGTHApplies to a feature not available in StarRocks.
DATA_FREEApplies to a feature not available in StarRocks.
AUTO_INCREMENTApplies to a feature not available in StarRocks.
CREATE_TIMEThe time when the table is created.
UPDATE_TIMEThe last time when the table is updated.
CHECK_TIMEThe last time when a consistency check is performed on the table.
TABLE_COLLATIONThe default collation of the table.
CHECKSUMApplies to a feature not available in StarRocks.
CREATE_OPTIONSApplies to a feature not available in StarRocks.
TABLE_COMMENTComment on the table.

tables_config

The following fields are provided in tables_config:

FieldDescription
TABLE_SCHEMAName of the database that stores the table.
TABLE_NAMEName of the table.
TABLE_ENGINEEngine type of the table.
TABLE_MODELTable type. Valid values: "DUP_KEYS", "AGG_KEYS", "UNQ_KEYS" or "PRI_KEYS".
PRIMARY_KEYThe primary key of a Primary Key table or a Unique Key table. An empty string is returned if the table is not a Primary Key table or a Unique Key table.
PARTITION_KEYThe partitioning columns of the table.
DISTRIBUTE_KEYThe bucketing columns of the table.
DISTRIBUTE_TYPEThe data distribution method of the table.
DISTRIBUTE_BUCKETNumber of buckets in the table.
SORT_KEYSort keys of the table.
PROPERTIESProperties of the table.
TABLE_IDID of the table.

load_tracking_logs

This feature is supported since StarRocks v3.0.

The following fields are provided in load_tracking_logs:

FieldDescription
JOB_IDThe ID of the load job.
LABELThe label of the load job.
DATABASE_NAMEThe database that the load job belongs to.
TRACKING_LOGError logs (if any) of the load job.
TypeThe type of the load job. Valid values: BROKER, INSERT, ROUTINE_LOAD and STREAM_LOAD.

materialized_views

The following fields are provided in materialized_views:

FieldDescription
MATERIALIZED_VIEW_IDID of the materialized view
TABLE_SCHEMADatabase in which the materialized view resides
TABLE_NAMEName of the materialized view
TABLE_ROWSNumber of data rows in the materialized view, based on approximate background statistics
MATERIALIZED_VIEW_DEFINITIONSQL definition of the materialized view