Profiler Object:Column-Based Value Pattern Table Iteration: Difference between revisions
Jump to navigation
Jump to search
Created page with " ← Profiler Object Reference {| class="mw-collapsible" cellspacing="2" style="background-color:#f9f9f9; border:1px solid #aaaaaa; font-size..." |
No edit summary |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
[[Profiler Object:Reference|← Profiler Object Reference]] | [[Profiler Object:Reference|← Profiler Object Reference]] | ||
{ | {{ProfilerObjectNav | ||
|IteratorsCollapse= | |||
}} | |||
{ | |||
| | |||
| Line 87: | Line 12: | ||
==StartPatternFrequency== | ==StartPatternFrequency== | ||
This function initiates the iterator. | 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. | This function takes two parameters. | ||
| Line 98: | Line 23: | ||
|Name2=Order | |Name2=Order | ||
|Data Type2=Order | |Data Type2=Order | ||
|Description2=This specifies how to order. | |Description2=This specifies how to order. See [[Profiler Object:Iterators#Order Enumeration|Order Enumeration]] for details. | ||
}} | }} | ||
{{Object Syntax | {{Object Syntax | ||
|Syntax=profiler->StartPatternFrequency(columnNameStr, Order); | |Syntax=int = profiler->StartPatternFrequency(columnNameStr, Order); | ||
|C=mdProfilerStartPatternFrequency(profiler,columnNameStr, Order); | |C=int = mdProfilerStartPatternFrequency(profiler,columnNameStr, Order); | ||
|.Net=profiler.StartPatternFrequency(columnNameStr, Order); | |.Net=integer = profiler.StartPatternFrequency(columnNameStr, Order); | ||
}} | }} | ||
| Line 121: | Line 46: | ||
{{Object Syntax | {{Object Syntax | ||
|Syntax=profiler->GetPatternFrequencyValue(columnNameStr); | |Syntax=profiler->GetPatternFrequencyValue(columnNameStr); | ||
|C= | |C=const char* = mdProfilerGetPatternFrequencyValue(profiler,columnNameStr); | ||
|.Net= | |.Net=string = profiler.GetPatternFrequencyValue(columnNameStr); | ||
}} | }} | ||
| Line 139: | Line 64: | ||
{{Object Syntax | {{Object Syntax | ||
|Syntax=profiler->GetPatternFrequencyRegEx(columnNameStr); | |Syntax=profiler->GetPatternFrequencyRegEx(columnNameStr); | ||
|C= | |C=const char* = mdProfilerGetPatternFrequencyRegEx(profiler,columnNameStr); | ||
|.Net= | |.Net=string = profiler.GetPatternFrequencyRegEx(columnNameStr); | ||
}} | }} | ||
| Line 157: | Line 82: | ||
{{Object Syntax | {{Object Syntax | ||
|Syntax=profiler->GetPatternFrequencyExample(columnNameStr); | |Syntax=profiler->GetPatternFrequencyExample(columnNameStr); | ||
|C= | |C=const char* = mdProfilerGetPatternFrequencyExample(profiler,columnNameStr); | ||
|.Net= | |.Net=string = profiler.GetPatternFrequencyExample(columnNameStr); | ||
}} | }} | ||
Latest revision as of 16:22, 15 May 2015
These functions allow you to step through each distinct value pattern for a specific column.
StartPatternFrequency
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->StartPatternFrequency(columnNameStr, Order); |
|---|---|
| C | int = mdProfilerStartPatternFrequency(profiler,columnNameStr, Order); |
| .Net | integer = profiler.StartPatternFrequency(columnNameStr, Order); |
GetPatternFrequencyValue
This function returns a column's distinct pattern.
This function takes one parameter.
Parameters
| Name | Data Type | Description |
|---|---|---|
| ColumnName | String | Column Name to get the column’s distinct pattern. |
| Syntax | profiler->GetPatternFrequencyValue(columnNameStr); |
|---|---|
| C | const char* = mdProfilerGetPatternFrequencyValue(profiler,columnNameStr); |
| .Net | string = profiler.GetPatternFrequencyValue(columnNameStr); |
GetPatternFrequencyRegEx
This function returns a regular expression for a distinct pattern. The regular expressions are 'tuned' for your specified data type. Where appropriate, letters or numbers may be lumped together using the 'one or more' quantifier.
This function takes one parameter.
Parameters
| Name | Data Type | Description |
|---|---|---|
| ColumnName | String | Column Name to get a regular expression for a distinct pattern. |
| Syntax | profiler->GetPatternFrequencyRegEx(columnNameStr); |
|---|---|
| C | const char* = mdProfilerGetPatternFrequencyRegEx(profiler,columnNameStr); |
| .Net | string = profiler.GetPatternFrequencyRegEx(columnNameStr); |
GetPatternFrequencyExample
This function returns an example value represented by the pattern. This will always be the first value encountered while profiling.
This function takes one parameter.
Parameters
| Name | Data Type | Description |
|---|---|---|
| ColumnName | String | Column Name to get an example value represented by the pattern. |
| Syntax | profiler->GetPatternFrequencyExample(columnNameStr); |
|---|---|
| C | const char* = mdProfilerGetPatternFrequencyExample(profiler,columnNameStr); |
| .Net | string = profiler.GetPatternFrequencyExample(columnNameStr); |
GetPatternFrequencyCount
This function returns the number of times the pattern appears 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 pattern appears in the profiled data. |
| Syntax | profiler->GetPatternFrequencyCount(columnNameStr); |
|---|---|
| C | integer = mdProfilerGetPatternFrequencyCount(profiler,columnNameStr); |
| .Net | integer = profiler.GetPatternFrequencyCount(columnNameStr); |
GetNextPatternFrequency
This function steps to the next distinct pattern. It returns 1 if there are more distinct patterns or 0 when there are no more patterns.
This function takes one parameter.
Parameters
| Name | Data Type | Description |
|---|---|---|
| ColumnName | String | Column Name to get the next distinct pattern. |
| Syntax | profiler->GetNextPatternFrequency(columnNameStr); |
|---|---|
| C | integer = mdProfilerGetNextPatternFrequency(profiler,columnNameStr); |
| .Net | integer = profiler.GetNextPatternFrequency(columnNameStr); |