Back to Starrocks

SHOW MATERIALIZED VIEWS

docs/en/sql-reference/sql-statements/materialized_view/SHOW_MATERIALIZED_VIEW.md

4.1.39.9 KB
Original Source

SHOW MATERIALIZED VIEWS

SHOW MATERIALIZED VIEWS shows all or one specific asynchronous materialized view.

Since v3.0, the name of this statement is changed from SHOW MATERIALIZED VIEW to SHOW MATERIALIZED VIEWS.

:::tip

This operation does not require privileges.

:::

Syntax

SQL
SHOW MATERIALIZED VIEWS
[FROM db_name]
[
WHERE NAME { = "mv_name" | LIKE "mv_name_matcher"}
]

:::note

Since v3.3, SHOW MATERIALIZED VIEWS command will track the state of all task_runs if a refresh task consists of multiple partitions/task_runs to refresh. Only when all task_runs are success, last_refresh_state will return SUCCESS.

:::

Parameters

ParameterRequiredDescription
db_namenoThe name of the database to which the materialized view resides. If this parameter is not specified, the current database is used by default.
mv_namenoThe name of the materialized view to show.
mv_name_matchernoThe matcher used to filter materialized views.

Returns

ReturnDescription
idThe ID of the materialized view.
database_nameThe name of the database in which the materialized view resides.
nameThe name of the materialized view.
refresh_typeThe refresh type of the materialized view. Valid values: SYNC (synchronous materialized view) and ASYNC (asynchronous materialized view, regardless of how the refresh is triggered).
is_activeWhether the materialized view state is active. Valid Value: true and false.
inactive_reasonThe reason why the materialized view is inactive.
partition_typeThe partition type of the materialized view, including RANGE and UNPARTITIONED.
task_idID of the materialized view refresh task.
task_nameName of the materialized view refresh task.
last_refresh_start_timeThe start time of the last refresh of the materialized view.
last_refresh_finished_timeThe end time of the last refresh of the materialized view.
last_refresh_durationThe time taken by the last refresh. Unit: seconds.
last_refresh_stateThe status of the last refresh, including PENDING, RUNNING, FAILED, SUCCESS, and SKIPPED. When no data changes are detected on the base table partition, the refresh for the corresponding materialized view partition is skipped.
last_refresh_force_refreshWhether the last refresh is a FORCE refresh.
last_refresh_start_partitionThe start partition of the last refresh in the materialized view.
last_refresh_end_partitionThe end partition of the last refresh in the materialized view.
last_refresh_base_refresh_partitionsThe base table partitions that were refreshed in the last refresh.
last_refresh_mv_refresh_partitionsThe materialized view partitions that were refreshed in the last refresh.
last_refresh_error_codeThe error code for the last failed refresh of the materialized view (if the materialized view state is not active).
last_refresh_error_messageThe reason why the last refresh failed (if the materialized view state is not active).
rowsThe number of data rows in the materialized view.
textThe statement used to create the materialized view.
extra_messageExtra information about the latest refresh task.
query_rewrite_statusQuery rewrite status of the materialized view.
creatorCreator of the materialized view refresh task.
last_refresh_process_timeThe process start time of the latest refresh task.
last_refresh_job_idJob ID of the latest refresh task.
last_refresh_timeTime up to which base table updates are reflected in the materialized view.
warehouseName of the warehouse that the asynchronous materialized view uses for its refresh tasks. Empty in shared-nothing mode, or for synchronous (rollup) materialized views.
refresh_modeConfigured refresh mode of the asynchronous materialized view. Valid values: PCT (partition change tracking, where only changed partitions are refreshed), INCREMENTAL (incremental view maintenance), and AUTO. Empty for synchronous materialized views.
refresh_triggerHow a refresh is triggered. Valid values: NONE (synchronous materialized view), MANUAL (only via REFRESH MATERIALIZED VIEW), SCHEDULED (periodic, via an EVERY interval), and ON_BASE_TABLE_CHANGE (automatically when a base table loads or changes).
refresh_policyHuman-readable refresh policy. Valid values: NONE, MANUAL, ON_BASE_TABLE_CHANGE, or a schedule such as START("yyyy-MM-dd HH:mm:ss") EVERY(INTERVAL n unit) (the START clause is present only if a start time was defined).
resource_groupResource group used for the materialized view's refresh tasks (from the materialized view's resource_group property). Defaults to default_mv_wg when not set.
query_rewrite_status_reasonThe reason behind query_rewrite_status. Valid values: OK, MV_INACTIVE, QUERY_REWRITE_DISABLED, UNSUPPORTED_DEFINITION, and UNKNOWN.
base_table_refresh_version_timesPer-base-table data version time, as a JSON object mapping each base table's catalog.database.table name to the latest data version time observed for it. This is the per-table detail behind last_refresh_time (their single maximum): external/data lake base tables report the partition source modified time, and OLAP (internal) base tables report the visible-version commit time. {} when no base table has a recorded time.

Examples

The following examples is based on this business scenario:

Plain
-- Create Table: customer
CREATE TABLE customer ( C_CUSTKEY     INTEGER NOT NULL,
                        C_NAME        VARCHAR(25) NOT NULL,
                        C_ADDRESS     VARCHAR(40) NOT NULL,
                        C_NATIONKEY   INTEGER NOT NULL,
                        C_PHONE       CHAR(15) NOT NULL,
                        C_ACCTBAL     double   NOT NULL,
                        C_MKTSEGMENT  CHAR(10) NOT NULL,
                        C_COMMENT     VARCHAR(117) NOT NULL,
                        PAD char(1) NOT NULL)
    ENGINE=OLAP
DUPLICATE KEY(`c_custkey`)
COMMENT "OLAP"
DISTRIBUTED BY HASH(`c_custkey`)
PROPERTIES (
"replication_num" = "3",
"storage_format" = "DEFAULT"
);

-- Create MV: customer_mv
CREATE MATERIALIZED VIEW customer_mv
DISTRIBUTED BY HASH(c_custkey)
REFRESH MANUAL
PROPERTIES (
    "replication_num" = "3"
)
AS SELECT
              c_custkey, c_phone, c_acctbal, count(1) as c_count, sum(c_acctbal) as c_sum
   FROM
              customer
   GROUP BY c_custkey, c_phone, c_acctbal;

-- Refresh the MV
REFRESH MATERIALIZED VIEW customer_mv;

Example 1: Show a specific materialized view.

Plain
mysql> SHOW MATERIALIZED VIEWS WHERE NAME='customer_mv'\G
*************************** 1. row ***************************
                        id: 10142
                      name: customer_mv
             database_name: test
              refresh_type: ASYNC
                 is_active: true
   last_refresh_start_time: 2023-02-17 10:27:33
last_refresh_finished_time: 2023-02-17 10:27:33
     last_refresh_duration: 0
        last_refresh_state: SUCCESS
             inactive_code: 0
           inactive_reason:
                      text: CREATE MATERIALIZED VIEW `customer_mv`
COMMENT "MATERIALIZED_VIEW"
DISTRIBUTED BY HASH(`c_custkey`)
REFRESH MANUAL
PROPERTIES (
"replication_num" = "3",
"storage_medium" = "HDD"
)
AS SELECT `customer`.`c_custkey`, `customer`.`c_phone`, `customer`.`c_acctbal`, count(1) AS `c_count`, sum(`customer`.`c_acctbal`) AS `c_sum`
FROM `test`.`customer`
GROUP BY `customer`.`c_custkey`, `customer`.`c_phone`, `customer`.`c_acctbal`;
                      rows: 0
                 warehouse:
              refresh_mode: PCT
           refresh_trigger: MANUAL
            refresh_policy: MANUAL
            resource_group: default_mv_wg
1 row in set (0.11 sec)

Example 2: Show materialized views by matching the name.

Plain
mysql> SHOW MATERIALIZED VIEWS WHERE NAME LIKE 'customer_mv'\G
*************************** 1. row ***************************
                        id: 10142
                      name: customer_mv
             database_name: test
              refresh_type: ASYNC
                 is_active: true
   last_refresh_start_time: 2023-02-17 10:27:33
last_refresh_finished_time: 2023-02-17 10:27:33
     last_refresh_duration: 0
        last_refresh_state: SUCCESS
             inactive_code: 0
           inactive_reason:
                      text: CREATE MATERIALIZED VIEW `customer_mv`
COMMENT "MATERIALIZED_VIEW"
DISTRIBUTED BY HASH(`c_custkey`)
REFRESH MANUAL
PROPERTIES (
"replication_num" = "3",
"storage_medium" = "HDD"
)
AS SELECT `customer`.`c_custkey`, `customer`.`c_phone`, `customer`.`c_acctbal`, count(1) AS `c_count`, sum(`customer`.`c_acctbal`) AS `c_sum`
FROM `test`.`customer`
GROUP BY `customer`.`c_custkey`, `customer`.`c_phone`, `customer`.`c_acctbal`;
                      rows: 0
                 warehouse:
              refresh_mode: PCT
           refresh_trigger: MANUAL
            refresh_policy: MANUAL
            resource_group: default_mv_wg
1 row in set (0.12 sec)