Profiler Object:Column Specification - Revision history

Admin at 18:59, 3 March 2015

2015-03-03T18:59:55Z

← Older revision		Revision as of 18:59, 3 March 2015
Line 160:		Line 160:
	==SetColumnIgnoreOnError==		==SetColumnIgnoreOnError==
	This feature is not implemented and is reserved for future use.		This feature is not implemented and is reserved for future use.


	==GetColumnCount==		==GetColumnCount==

Admin at 18:59, 3 March 2015

2015-03-03T18:59:20Z

Show changes

Admin at 18:19, 24 February 2015

2015-02-24T18:19:57Z

← Older revision		Revision as of 18:19, 24 February 2015
Line 157:		Line 157:
	\|.Net=profiler.SetColumnScale(columnNameStr, scaleValue);		\|.Net=profiler.SetColumnScale(columnNameStr, scaleValue);
	}}		}}

			==SetColumnIgnoreOnError==
			This feature is not implemented and is reserved for future use.


	[[Category:Profiler Object]]		[[Category:Profiler Object]]

Admin at 21:44, 23 February 2015

2015-02-23T21:44:24Z

@@ Line 2: / Line 2: @@
 [[Profiler Object:Reference|&larr; Profiler Object Reference]]
-{| class="mw-collapsible" cellspacing="2" style="background-color:#f9f9f9; border:1px solid #aaaaaa; font-size:9pt; color:#0645ad; padding:8px 8px;"
+{{ProfilerObjectNav}}
@@ Line 125: / Line 48: @@
 {{ Object Syntax
 |Syntax=profiler->SetColumnCustomPattern(ColumnNameString, RegularExpressionString);
-|C=integer = mdProfilerAddColumn(profiler, ColumnNameString, RegularExpressionString);
+|C=integer = mdProfilerSetColumnCustomPattern(profiler, ColumnNameString, RegularExpressionString);
 |.Net=integer = profiler.SetColumnCustomPattern(ColumnNameString, RegularExpressionString);
 }}
@@ Line 171: / Line 94: @@
 |Syntax=profiler->SetColumnDefaultValue(columnNameStr, defaultValueStr);
 |C=integer = mdProfilerSetColumnDefaultValue(profiler,columnNameStr,defaultValueStr);
-|.Net=integer = profiler.SetColumnCustomPattern(columnNameStr, defaultValueStr);
+|.Net=integer = profiler.SetColumnDefaultValue(columnNameStr, defaultValueStr);
 }}
@@ Line 224: / Line 147: @@
 |Data Type=String
 |Description=This is the name of the column to be added
-|Name2=PrecisionValue
+|Name2=ScaleValue
 |Data Type2=Integer
-|Description2=This is the precision value for a specified column
+|Description2=This is the scale value for the specified column
 }}

Admin at 18:49, 2 February 2015

2015-02-02T18:49:33Z

← Older revision		Revision as of 18:49, 2 February 2015
Line 27:		Line 27:
	{\| class="mw-collapsible mw-collapsed" style="width:100%;"		{\| class="mw-collapsible mw-collapsed" style="width:100%;"
	\|- align="left"		\|- align="left"
	! style="color:black;"\|[[Profiler Object:Column-Based Statistics\|Column-Based Statistics]]		! style="color:black; text-align:left;"\|[[Profiler Object:Column-Based Statistics\|Column-Based Statistics]]
	\|-		\|-
	\|[[Profiler Object:Column-Based String Statistics\|Column-Based String Statistics]]		\|[[Profiler Object:Column-Based String Statistics\|Column-Based String Statistics]]
Line 52:		Line 52:
	{\| class="mw-collapsible mw-collapsed" style="width:100%;"		{\| class="mw-collapsible mw-collapsed" style="width:100%;"
	\|- align="left"		\|- align="left"
	! style="color:black;"\|[[Profiler Object:Iterators\|Iterators]]		! style="color:black; text-align:left;"\|[[Profiler Object:Iterators\|Iterators]]
	\|-		\|-
	\|[[Profiler Object:Column-Based Value Frequency Table Iteration\|Column-Based Value Frequency Table Iteration]]		\|[[Profiler Object:Column-Based Value Frequency Table Iteration\|Column-Based Value Frequency Table Iteration]]
Line 73:		Line 73:
	{\| class="mw-collapsible mw-collapsed" style="width:100%;"		{\| class="mw-collapsible mw-collapsed" style="width:100%;"
	\|- align="left"		\|- align="left"
	! style="color:black;"\|[[Profiler Object:Result Codes\|Result Codes]]		! style="color:black; text-align:left;"\|[[Profiler Object:Result Codes\|Result Codes]]
	\|-		\|-
	\|[[Returned Result Codes:APIs#Profiler Object\|Returned Result Codes]]		\|[[Returned Result Codes:APIs#Profiler Object\|Returned Result Codes]]

Admin at 18:41, 2 February 2015

2015-02-02T18:41:32Z

← Older revision		Revision as of 18:41, 2 February 2015
Line 196:		Line 196:

	==SetColumnPrecision==		==SetColumnPrecision==
	This function sets the precision for a specified column~~. This is '''Optional'''~~. This applies to only ColumnTypeNumeric, ColumnTypeDecimal, ColumnTypeCurrency. Precision is the number of digits maximum allowed for that number. This function takes two parameters.		'''Optional'''. This function sets the precision for a specified column. This applies to only ColumnTypeNumeric, ColumnTypeDecimal, ColumnTypeCurrency. Precision is the number of digits maximum allowed for that number. This function takes two parameters.

	===Parameters===		===Parameters===

Admin: Created page with " ← Profiler Object Reference {| class="mw-collapsible" cellspacing="2" style="background-color:#f9f9f9; border:1px solid #aaaaaa; font-size..."

2015-01-07T01:42:33Z

Created page with " ← Profiler Object Reference {| class="mw-collapsible" cellspacing="2" style="background-color:#f9f9f9; border:1px solid #aaaaaa; font-size..."

New page

[[Profiler Object:Reference|← Profiler Object Reference]]

{| class="mw-collapsible" cellspacing="2" style="background-color:#f9f9f9; border:1px solid #aaaaaa; font-size:9pt; color:#0645ad; padding:8px 8px;"
! style="text-align:left; color:black; border-bottom:1px solid #aaaaaa;"|'''Profiler Object Interface Navigation'''
|-
| style="padding-right:220px;"|
|-
|[[Profiler Object:Initialization|Initialization]]
|-
|[[Profiler Object:Object Information|Object Information]]
|-
|[[Profiler Object:Enumeration Listing and Parsing|Enumeration Listing and Parsing]]
|-
|[[Profiler Object:Column Specification|Column Specification]]
|-
|[[Profiler Object:Initiate Profiling|Initiate Profiling]]
|-
|[[Profiler Object:Data Input|Data Input]]
|-
|[[Profiler Object:Profiling|Profiling]]
|-
|[[Profiler Object:Table-Based Statistics|Table-Based Statistics]]
|-
|-
|
{| class="mw-collapsible mw-collapsed" style="width:100%;"
|- align="left"
! style="color:black;"|[[Profiler Object:Column-Based Statistics|Column-Based Statistics]]
|-
|[[Profiler Object:Column-Based String Statistics|Column-Based String Statistics]]
|-
|[[Profiler Object:Column-Based Numeric Statistics|Column-Based Numeric Statistics]]
|-
|[[Profiler Object:Column-Based Date/Time Statistics|Column-Based Date/Time Statistics]]
|-
|[[Profiler Object:Column-Based Name Statistics|Column-Based Name Statistics]]
|-
|[[Profiler Object:Column-Based State/Province Statistics|Column-Based State/Province Statistics]]
|-
|[[Profiler Object:Column-Based Zip/Postal Code Statistics|Column-Based Zip/Postal Code Statistics]]
|-
|[[Profiler Object:Column-Based Country Statistics|Column-Based Country Statistics]]
|-
|[[Profiler Object:Column-Based Email Statistics|Column-Based Email Statistics]]
|-
|[[Profiler Object:Column-Based Phone Statistics|Column-Based Phone Statistics]]
|-
|}
|-
|
{| class="mw-collapsible mw-collapsed" style="width:100%;"
|- align="left"
! style="color:black;"|[[Profiler Object:Iterators|Iterators]]
|-
|[[Profiler Object:Column-Based Value Frequency Table Iteration|Column-Based Value Frequency Table Iteration]]
|-
|[[Profiler Object:Column-Based Value Length Frequency Table Iteration|Column-Based Value Length Frequency Table Iteration]]
|-
|[[Profiler Object:Column-Based Value Pattern Table Iteration|Column-Based Value Pattern Table Iteration]]
|-
|[[Profiler Object:Column-Based Value Date/Time Table Iteration|Column-Based Value Date/Time Table Iteration]]
|-
|[[Profiler Object:Column-Based Value SoundEx Table Iteration|Column-Based Value SoundEx Table Iteration]]
|-
|[[Profiler Object:Column-Based Word Table Iteration|Column-Based Word Table Iteration]]
|-
|[[Profiler Object:Column-Based Word Length Table Iteration|Column-Based Word Length Table Iteration]]
|-
|}
|-
|
{| class="mw-collapsible mw-collapsed" style="width:100%;"
|- align="left"
! style="color:black;"|[[Profiler Object:Result Codes|Result Codes]]
|-
|[[Returned Result Codes:APIs#Profiler Object|Returned Result Codes]]
|-
|[[Result Codes]]
|}
|}

<div class="toclimit-2">{{CustomTOC}}</div>

You must call '''[[#AddColumn|AddColumn]]''' for each column you intend to profile. All columns must be added before '''[[Profiler Object:Initiate Profiling#StartProfiling|StartProfiling]]''' is called.

==AddColumn==
This function describes a column to be profiled. To successfully profile the data, at least one column should be added. This function accepts three parameters.

===Parameters===
{{Object Parameters3
|Name=ColumnName
|Data Type=String
|Description=This is the name of the column to be added.
|Name2=ColumnType
|Data Type2=Profiler Column Type
|Description2=This is the type of the column to be added. See [[Profiler Object:Enumeration Listing and Parsing#ProfilerColumnType Enumerations|ProfilerColumnType Enumerations]] for details.
|Name3=DataType
|Data Type3=Profiler Data Type
|Description3=This is the data type of the column to be added. These are custom data types. See [[Profiler Object:Enumeration Listing and Parsing#ProfilerDataType Enumerations|ProfilerDataType Enumerations]] for details.
}}

{{ Object Syntax
|Syntax=profiler->AddColumn(columnNameStr, profilerColumnTYpe, profilerDataType);
|C=mdProfilerAddColumn(profiler,columnNameStr,profilerColumntype,profilerDataType);
|.Net=profiler.AddColumn(columnNameStr, profilerColumntype, profilerDataType);
}}

==SetColumnCustomPattern==
'''Optional'''. This function adds a regular expression validator for a specified column. This can be called multiple times to evaluate different patterns.

This function accepts two parameters.

===Parameters===
{{Object Parameters2
|Name=ColumnNameString
|Data Type=String
|Description=Column Name to set the custom pattern.
|Name2=RegularExpressionString
|Data Type2=String
|Description2=This is the regular expression to validate the column.
}}

{{ Object Syntax
|Syntax=profiler->SetColumnCustomPattern(ColumnNameString, RegularExpressionString);
|C=integer = mdProfilerAddColumn(profiler, ColumnNameString, RegularExpressionString);
|.Net=integer = profiler.SetColumnCustomPattern(ColumnNameString, RegularExpressionString);
}}

==SetColumnValueRange==
'''Optional'''. This SetColumnValueRange function sets the upper and lower bound for the specified column.

This function accepts three parameters.

===Parameters===
{{Object Parameters3
|Name=columnNameStr
|Data Type=String
|Description=Column Name to set the value range.
|Name2=fromStr
|Data Type2=String
|Description2=Lower bound value.
|Name3=toStr
|Data Type3=String
|Description3=Upper bound value.
}}

{{ Object Syntax
|Syntax=profiler->SetColumnValueRange(columnNameStr, fromStr, toStr);
|C=integer = mdProfilerSetColumnValueRange(profiler, columnNameStr, fromStr, toStr);
|.Net=integer = profiler.SetColumnValueRange(columnNameStr, fromStr, toStr);
}}

==SetColumnDefaultValue==
'''Optional'''. This function sets the default value to the specified column.

This function takes two parameters

===Parameters===
{{Object Parameters2
|Name=ColumnName
|Data Type=String
|Description=Column Name to set the default value.
|Name2=DefaultValue
|Data Type2=String
|Description2=This is the default value of the column.
}}

{{ Object Syntax
|Syntax=profiler->SetColumnDefaultValue(columnNameStr, defaultValueStr);
|C=integer = mdProfilerSetColumnDefaultValue(profiler,columnNameStr,defaultValueStr);
|.Net=integer = profiler.SetColumnCustomPattern(columnNameStr, defaultValueStr);
}}

==SetColumnSize==
'''Optional'''. This function sets the column size for the specified column.

This function takes two parameters

===Parameters===
{{Object Parameters2
|Name=ColumnName
|Data Type=String
|Description=Column Name to set the size.
|Name2=ColumnSize
|Data Type2=Integer
|Description2=This is the size of the column.
}}

{{ Object Syntax
|Syntax=profiler->SetColumnSize(ColumnNameStr, sizeValue);
|C=mdProfilerSetColumnSize(profiler, columnNameStr, sizeValue);
|.Net=profiler.SetColumnSize(columnNameStr, sizeValue);
}}

==SetColumnPrecision==
This function sets the precision for a specified column. This is '''Optional'''. This applies to only ColumnTypeNumeric, ColumnTypeDecimal, ColumnTypeCurrency. Precision is the number of digits maximum allowed for that number. This function takes two parameters.

===Parameters===
{{Object Parameters2
|Name=ColumnName
|Data Type=String
|Description=Column Name to set the precision Value
|Name2=PrecisionValue
|Data Type2=Integer
|Description2=This is the precision value for a specified column.
}}

{{ Object Syntax
|Syntax=profiler->SetColumnPrecision(columnNameStr, previsionValue);
|C=mdProfilerSetColumnPrecision(profiler, ColumnNameStr, PrecisionValue);
|.Net=profiler.SetColumnPrecision(ColumnNameStr, PrecisionValue);
}}

==SetColumnScale==
'''Optional'''. This function sets the scale for a specified column. Scale is the number of decimal places (number of digits on the right hand side of the decimal point.) This applies to only ColumnTypeNumeric, ColumnTypeDecimal, ColumnTypeCurrency.

This function takes two parameters.

===Parameters===
{{Object Parameters2
|Name=ColumnName
|Data Type=String
|Description=This is the name of the column to be added
|Name2=PrecisionValue
|Data Type2=Integer
|Description2=This is the precision value for a specified column
}}

{{ Object Syntax
|Syntax=profiler->SetColumnScale(columnNameStr, scaleValue);
|C=mdProfilerSetColumnScale(profiler, columnNameStr, scaleValue);
|.Net=profiler.SetColumnScale(columnNameStr, scaleValue);
}}

[[Category:Profiler Object]]