Skip to main content
collect_statistics(table_name=None, column_names=None, options=)[source]

Collect statistics for a column(s) in a specified table.

Parameters

table_name (str) –

Name of a table, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. A value of ‘*’ collects statistics on every user table the caller may read (excluding system schemas, views, and temporary tables); when used, input parameter column_names must be ‘*’.

column_names (list of str) –

List of one or more column names in input parameter table_name for which to collect statistics (cardinality, mean value, etc.). A single entry of ‘*’ expands to every collectable column on the table (geometry, vector, JSON, and array columns are skipped). The user can provide a single element (which will be automatically promoted to a list internally) or a list.

options (dict of str to str) –

Optional parameters. The default value is an empty dict ( ).

Returns

A dict with the following entries–

table_name (str) –

Value of input parameter table_name.

column_names (list of str) –

Value of input parameter column_names.

info (dict of str to str) –

Additional information.