Retrieve statistical and auxiliary data type information about the specified set of published table columns. Cardinality statistics must be enabled and gathered on the data source to enable gathering of profiling information. Please note that the table or view may have underlying procedures and column profiles can be got for such views if cardinality statistics are enabled. This procedure is present in “/services/databases/system/profile/GetColumnProfiles”.

When a published resource has an underlying view, caching and cardinality statistics must be enabled and gathered before using the profile APIs. Enabling cardinality statistics at the data source level may not be sufficient in gathering profile information.

database: The name of the published database to which the column belongs. Special character '*' can be used as a wildcard to denote any database. This parameter is required.

catalog: The name of the published catalog to which the column belongs. Special character '*' can be used as a wildcard to denote any/no catalog. This parameter is optional (i.e. it may be set to NULL to denote no catalog).

schema: The name of the published schema to which the column belongs. Special character '*' can be used as a wildcard to denote any/no schema. This parameter is optional (i.e. it may be set to NULL to denote no schema).

table: The name of the published table to which the column belongs. Special character '*' can be used as a wildcard to denote any table. This parameter is required.

columnFilter: A comma-separated list of column names. This parameter is optional. If set to NULL all table columns will be profiled.

A cursor whose rows encode table column profiles, having the following columns:

database: The name of the published database to which the column belongs.

catalog: The name of the published catalog to which the column belongs. May be NULL.

schema: The name of the published schema to which the column belongs. May be NULL.

table: The name of the published table to which the column belongs.

column: The name of the published column.

minValue: The textual representation of the column's minimum value. NULL if unknown or not applicable.

maxValue: The textual representation of the column's maximum value. NULL if unknown or not applicable.

distinctCount: The number of distinct column values. NULL if unknown or not applicable.

nullCount: The number of NULL column values. NULL if unknown or not applicable.

partitionable: TRUE if partitions can be defined against the specified column; otherwise, FALSE.

message: A message specifying any detected reason preventing the analysis of the specified table column.

Exceptions:

 

An IllegalArgumentException is thrown when the specified resources cannot be found. An exception is also thrown when the user does not have the authorization to read the specified resource(s).