 This wiki is no longer being updated as of December 10, 2025.
|
Profiler Object:Column-Based Value Date/Time 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: | ||
==StartDateFrequency== | ==StartDateFrequency== | ||
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 three parameters. | This function takes three parameters. | ||
| Line 167: | Line 92: | ||
|- | |- | ||
|} | |} | ||
{{Object Syntax | {{Object Syntax | ||
|Syntax=profiler->StartDateFrequency(columnNameStr, Order, DateSpan); | |Syntax=int = profiler->StartDateFrequency(columnNameStr, Order, DateSpan); | ||
|C= | |C=int = mdProfilerStartDateFrequency(profiler,columnNameStr, Order, DateSpan); | ||
|.Net=profiler.StartDateFrequency(columnNameStr, Order, DateSpan); | |.Net=integer = profiler.StartDateFrequency(columnNameStr, Order, DateSpan); | ||
}} | }} | ||
| Line 188: | Line 114: | ||
{{Object Syntax | {{Object Syntax | ||
|Syntax=profiler->GetDateFrequencyValue(columnNameStr); | |Syntax=profiler->GetDateFrequencyValue(columnNameStr); | ||
|C= | |C=const char* = mdProfilerGetDateFrequencyValue(profiler,columnNameStr); | ||
|.Net=string = profiler.GetDateFrequencyValue(columnNameStr); | |.Net=string = profiler.GetDateFrequencyValue(columnNameStr); | ||
}} | }} | ||
Latest revision as of 16:23, 15 May 2015
These functions allow you to step through each distinct value date/time for a specific column. Date values are gathered for all column types, not just date/time data types.
StartDateFrequency
This function initiates the iterator. It returns 1 to indicate if there are records to iterate through. Otherwise it returns 0.
This function takes three 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. |
| Date Span | DateSpan | You must specify a DateSpan - the resolution to be used when stepping through each value (e.g., date, month, year, etc). |
Date Span Enumerations
| Value | Name | Description |
|---|---|---|
| 1 | DateSpanDate | Group by date |
| 2 | DateSpanTime | Group by time |
| 3 | DateSpanHour | Group by hour |
| 4 | DateSpanMinute | Group by minute |
| 5 | DateSpanSecond | Group by second |
| 6 | DateSpanMillisecond | Group by millisecond |
| 7 | DateSpanDayOfWeek | Group by day of the week |
| 8 | DateSpanDay | Group by day of the month |
| 9 | DateSpanWeek | Group by week of the year |
| 10 | DateSpanMonth | Group by month |
| 11 | DateSpanQuarter | Group by quarter |
| 12 | DateSpanYear | Group by year |
| 13 | DateSpanDecade | Group by decade |
| 14 | DateSpanCentury | Group by century |
| Syntax | int = profiler->StartDateFrequency(columnNameStr, Order, DateSpan); |
|---|---|
| C | int = mdProfilerStartDateFrequency(profiler,columnNameStr, Order, DateSpan); |
| .Net | integer = profiler.StartDateFrequency(columnNameStr, Order, DateSpan); |
GetDateFrequencyValue
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->GetDateFrequencyValue(columnNameStr); |
|---|---|
| C | const char* = mdProfilerGetDateFrequencyValue(profiler,columnNameStr); |
| .Net | string = profiler.GetDateFrequencyValue(columnNameStr); |
GetDateFrequencyCount
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->GetDateFrequencyCount(columnNameStr); |
|---|---|
| C | integer = mdProfilerGetDateFrequencyCount(profiler,columnNameStr); |
| .Net | integer = profiler.GetDateFrequencyCount(columnNameStr); |
GetNextDateFrequency
This function steps to the next distinct value. It returns 1 if there are more distinct values or 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->GetNextDateFrequency(columnNameStr); |
|---|---|
| C | integer = mdProfilerGetNextDateFrequency(profiler,columnNameStr); |
| .Net | integer = profiler.GetNextDateFrequency(columnNameStr); |