Profiler Object:Column-Based Value Frequency Table Iteration
These functions allow you to step through each distinct value for a specific column.
StartDataFrequency
This function initiates the iterator. It returns 1 to indicate if there are records to iterate through. Otherwise it returns 0.
This function takes two parameters.
Parameters
Name | Data Type | Description |
---|---|---|
ColumnName | String | Column Name to start the iterator. |
Order | Order | This specifies how to order. See Order Enumeration for details. |
Syntax | int = profiler->StartDataFrequency(columnNameStr, Order); |
---|---|
C | int = mdProfilerStartDataFrequency(profiler,columnNameStr, Order); |
.Net | profiler.StartDataFrequency(columnNameStr, Order); |
GetDataFrequencyValue
This function returns a column's distinct value.
This function takes one parameter.
Parameters
Name | Data Type | Description |
---|---|---|
ColumnName | String | Column Name to get the column’s distinct value. |
Syntax | profiler->GetDataFrequencyValue(columnNameStr); |
---|---|
C | const char* = mdProfilerGetDataFrequencyValue(profiler,columnNameStr); |
.Net | string = profiler.GetDataFrequencyValue(columnNameStr); |
GetDataFrequencyCount
This function returns the number of times the value appeared in the profiled data for this particular column.
This function takes one parameter.
Parameters
Name | Data Type | Description |
---|---|---|
ColumnName | String | Column Name to get the number of times the value appeared in the profiled data. |
Syntax | profiler->GetDataFrequencyCount(columnNameStr); |
---|---|
C | integer = mdProfilerGetDataFrequencyCount(profiler,columnNameStr); |
.Net | integer = profiler.GetDataFrequencyCount(columnNameStr); |
GetNextDataFrequency
This function steps to the next distinct value. It returns 1 if there are more distinct values and 0 when there are no more values.
This function takes one parameter.
Parameters
Name | Data Type | Description |
---|---|---|
ColumnName | String | Column Name to get the next distinct value. |
Syntax | profiler->GetNextDataFrequency(columnNameStr); |
---|---|
C | integer = mdProfilerGetNextDataFrequency(profiler,columnNameStr); |
.Net | integer = profiler.GetNextDataFrequency(columnNameStr); |