ProfileConfig

class oci.data_connectivity.models.ProfileConfig(**kwargs)

Bases: object

Profiling configuration.

Attributes

FUNCTIONS_ATTRIBUTE_COUNT A constant which can be used with the functions property of a ProfileConfig.
FUNCTIONS_DATA_TYPE A constant which can be used with the functions property of a ProfileConfig.
FUNCTIONS_DISTINCT_COUNT A constant which can be used with the functions property of a ProfileConfig.
FUNCTIONS_DUPLICATE_COUNT A constant which can be used with the functions property of a ProfileConfig.
FUNCTIONS_HISTOGRAM A constant which can be used with the functions property of a ProfileConfig.
FUNCTIONS_MAX A constant which can be used with the functions property of a ProfileConfig.
FUNCTIONS_MAX_LENGTH A constant which can be used with the functions property of a ProfileConfig.
FUNCTIONS_MEAN A constant which can be used with the functions property of a ProfileConfig.
FUNCTIONS_MEAN_LENGTH A constant which can be used with the functions property of a ProfileConfig.
FUNCTIONS_MEDIAN A constant which can be used with the functions property of a ProfileConfig.
FUNCTIONS_MIN A constant which can be used with the functions property of a ProfileConfig.
FUNCTIONS_MIN_LENGTH A constant which can be used with the functions property of a ProfileConfig.
FUNCTIONS_NULL_COUNT A constant which can be used with the functions property of a ProfileConfig.
FUNCTIONS_OUTLIER A constant which can be used with the functions property of a ProfileConfig.
FUNCTIONS_PATTERN A constant which can be used with the functions property of a ProfileConfig.
FUNCTIONS_ROW_COUNT A constant which can be used with the functions property of a ProfileConfig.
FUNCTIONS_STANDARD_DEVIATION A constant which can be used with the functions property of a ProfileConfig.
FUNCTIONS_UNIQUE_COUNT A constant which can be used with the functions property of a ProfileConfig.
FUNCTIONS_VALUE_FREQUENCY A constant which can be used with the functions property of a ProfileConfig.
FUNCTIONS_VARIANCE A constant which can be used with the functions property of a ProfileConfig.
attributes Gets the attributes of this ProfileConfig.
data_type_threshold Gets the data_type_threshold of this ProfileConfig.
functions Gets the functions of this ProfileConfig.
pattern_threshold Gets the pattern_threshold of this ProfileConfig.
top_n_val_freq Gets the top_n_val_freq of this ProfileConfig.

Methods

__init__(**kwargs) Initializes a new ProfileConfig object with values from keyword arguments.
FUNCTIONS_ATTRIBUTE_COUNT = 'ATTRIBUTE_COUNT'

A constant which can be used with the functions property of a ProfileConfig. This constant has a value of “ATTRIBUTE_COUNT”

FUNCTIONS_DATA_TYPE = 'DATA_TYPE'

A constant which can be used with the functions property of a ProfileConfig. This constant has a value of “DATA_TYPE”

FUNCTIONS_DISTINCT_COUNT = 'DISTINCT_COUNT'

A constant which can be used with the functions property of a ProfileConfig. This constant has a value of “DISTINCT_COUNT”

FUNCTIONS_DUPLICATE_COUNT = 'DUPLICATE_COUNT'

A constant which can be used with the functions property of a ProfileConfig. This constant has a value of “DUPLICATE_COUNT”

FUNCTIONS_HISTOGRAM = 'HISTOGRAM'

A constant which can be used with the functions property of a ProfileConfig. This constant has a value of “HISTOGRAM”

FUNCTIONS_MAX = 'MAX'

A constant which can be used with the functions property of a ProfileConfig. This constant has a value of “MAX”

FUNCTIONS_MAX_LENGTH = 'MAX_LENGTH'

A constant which can be used with the functions property of a ProfileConfig. This constant has a value of “MAX_LENGTH”

FUNCTIONS_MEAN = 'MEAN'

A constant which can be used with the functions property of a ProfileConfig. This constant has a value of “MEAN”

FUNCTIONS_MEAN_LENGTH = 'MEAN_LENGTH'

A constant which can be used with the functions property of a ProfileConfig. This constant has a value of “MEAN_LENGTH”

FUNCTIONS_MEDIAN = 'MEDIAN'

A constant which can be used with the functions property of a ProfileConfig. This constant has a value of “MEDIAN”

FUNCTIONS_MIN = 'MIN'

A constant which can be used with the functions property of a ProfileConfig. This constant has a value of “MIN”

FUNCTIONS_MIN_LENGTH = 'MIN_LENGTH'

A constant which can be used with the functions property of a ProfileConfig. This constant has a value of “MIN_LENGTH”

FUNCTIONS_NULL_COUNT = 'NULL_COUNT'

A constant which can be used with the functions property of a ProfileConfig. This constant has a value of “NULL_COUNT”

FUNCTIONS_OUTLIER = 'OUTLIER'

A constant which can be used with the functions property of a ProfileConfig. This constant has a value of “OUTLIER”

FUNCTIONS_PATTERN = 'PATTERN'

A constant which can be used with the functions property of a ProfileConfig. This constant has a value of “PATTERN”

FUNCTIONS_ROW_COUNT = 'ROW_COUNT'

A constant which can be used with the functions property of a ProfileConfig. This constant has a value of “ROW_COUNT”

FUNCTIONS_STANDARD_DEVIATION = 'STANDARD_DEVIATION'

A constant which can be used with the functions property of a ProfileConfig. This constant has a value of “STANDARD_DEVIATION”

FUNCTIONS_UNIQUE_COUNT = 'UNIQUE_COUNT'

A constant which can be used with the functions property of a ProfileConfig. This constant has a value of “UNIQUE_COUNT”

FUNCTIONS_VALUE_FREQUENCY = 'VALUE_FREQUENCY'

A constant which can be used with the functions property of a ProfileConfig. This constant has a value of “VALUE_FREQUENCY”

FUNCTIONS_VARIANCE = 'VARIANCE'

A constant which can be used with the functions property of a ProfileConfig. This constant has a value of “VARIANCE”

__init__(**kwargs)

Initializes a new ProfileConfig object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • attributes (list[str]) – The value to assign to the attributes property of this ProfileConfig.
  • functions (list[str]) – The value to assign to the functions property of this ProfileConfig. Allowed values for items in this list are: “ATTRIBUTE_COUNT”, “ROW_COUNT”, “DATA_TYPE”, “DISTINCT_COUNT”, “DUPLICATE_COUNT”, “HISTOGRAM”, “MAX”, “MAX_LENGTH”, “MEAN”, “MEAN_LENGTH”, “MEDIAN”, “MIN”, “MIN_LENGTH”, “NULL_COUNT”, “OUTLIER”, “PATTERN”, “STANDARD_DEVIATION”, “UNIQUE_COUNT”, “VARIANCE”, “VALUE_FREQUENCY”
  • top_n_val_freq (int) – The value to assign to the top_n_val_freq property of this ProfileConfig.
  • pattern_threshold (int) – The value to assign to the pattern_threshold property of this ProfileConfig.
  • data_type_threshold (int) – The value to assign to the data_type_threshold property of this ProfileConfig.
attributes

Gets the attributes of this ProfileConfig. Array of column names to profile. If empty all columns in the entity are profiled.

Returns:The attributes of this ProfileConfig.
Return type:list[str]
data_type_threshold

Gets the data_type_threshold of this ProfileConfig. A data type has to qualify minimum this percentage threshold to be considered an infrred data type for a column.

Returns:The data_type_threshold of this ProfileConfig.
Return type:int
functions

Gets the functions of this ProfileConfig. Array of enum Strings basically what all profile functions to run. If empty, all supported functions are run.

Allowed values for items in this list are: “ATTRIBUTE_COUNT”, “ROW_COUNT”, “DATA_TYPE”, “DISTINCT_COUNT”, “DUPLICATE_COUNT”, “HISTOGRAM”, “MAX”, “MAX_LENGTH”, “MEAN”, “MEAN_LENGTH”, “MEDIAN”, “MIN”, “MIN_LENGTH”, “NULL_COUNT”, “OUTLIER”, “PATTERN”, “STANDARD_DEVIATION”, “UNIQUE_COUNT”, “VARIANCE”, “VALUE_FREQUENCY”

Returns:The functions of this ProfileConfig.
Return type:list[str]
pattern_threshold

Gets the pattern_threshold of this ProfileConfig. A pattern has to qualify minumum this percentage threshold to be considered a legitimate pattern on its own. All patterns which does not qualify this will be clubbed together into a single ‘Others’ pattern.

Returns:The pattern_threshold of this ProfileConfig.
Return type:int
top_n_val_freq

Gets the top_n_val_freq of this ProfileConfig. The maximum number of value frequencies to return per column. The VFs are sorted descending on frequency and ascending on value and then topN are returned and rest discarded.

Returns:The top_n_val_freq of this ProfileConfig.
Return type:int