ANALYZE

Description

This statement is used to collect column statistics. Statistics of columns can be collected for a table (specific columns can be specified) or for the entire database.

Syntax

ANALYZE {TABLE <table_name> [ (<column_name> [, ...]) ] | DATABASE <database_name>}
    [ [ WITH SYNC ] [ WITH SAMPLE {PERCENT | ROWS} <sample_rate> ] [ WITH HOT VALUE ] ];

Required Parameters

1. <table_name>

The specified target table. This parameter and the <database_name> parameter must have and can only have one of them specified.

2. <database_name>

The specified target database. This parameter and the <table_name> parameter must have and can only have one of them specified.

Optional Parameters

1. <column_name>

The specified target column. It must be an existing column in table_name. You can specify multiple column names separated by commas.

2. WITH SYNC

Collect statistics synchronously. Returns after collection. If not specified, it executes asynchronously.

3. WITH SAMPLE {PERCENT | ROWS} <sample_rate>

Specify to use the sampling method for collection. When not specified, full collection is the default. <sample_rate> is the sampling parameter. When using PERCENT sampling, it specifies the sampling percentage; when using ROWS sampling, it specifies the number of sampled rows.

4. WITH HOT VALUE

Specify to collect hot values during manual full collection. Hot values help the optimizer estimate predicates on skewed data more accurately, but collecting them can consume more memory on high-cardinality columns. When this option is not specified, Doris keeps the existing behavior: full collection does not collect hot values, while sample collection always collects hot values. WITH HOT VALUE is rejected when used together with WITH SAMPLE.

Return Value

Column	Note
Job_Id	Unique Job Id
Catalog_Name	Catalog name
DB_Name	database name
Columns	column name list

Access Control Requirements

The user who executes this SQL must have at least the following permissions:

Privilege	Object	Notes
SELECT_PRIV	Table	When executing ANALYZE, the SELECT_PRIV privilege for the queried table is required.

Examples

1. Collect statistics by sampling 10% of table lineitem.

ANALYZE TABLE lineitem WITH SAMPLE PERCENT 10;

2. Collect statistics by sampling 100,000 rows from table lineitem.

ANALYZE TABLE lineitem WITH SAMPLE ROWS 100000;

3. Collect full statistics and collect hot values.

ANALYZE TABLE lineitem WITH SYNC WITH HOT VALUE;