Parameter Types

  • Article

The following table lists the available parameter types and their valid operands and values. The SingleValue parameter type can appear anywhere in a query. The SelectOrder parameter type is used in the Select clause of the query. The remaining parameter types appear in the Where clause of the query.

Paramtype Operand1 Value1 Operand2 Value2
ParamType_DateRange DateRangeOpnd_All

DateRangeOpnd_From

DateRangeOpnd_OnOrBefore

DateRangeOpnd_Today

DateRangeOpnd_ThisWeek

DateRangeOpnd_ThisMonth

DateRangeOpnd_ThisQuarter

DateRangeOpnd_ThisYear

DateRangeOpnd_Yesterday

DateRangeOpnd_LastWeek

DateRangeOpnd_LastMonth

DateRangeOpnd_LastQuarter

DateRangeOpnd_LastYear

 Required for DateRangeOpnd_From or DateRangeOpnd_OnOrB4.

For DateRangeOpnd_From, the beginning date of a range to return.

For DateRangeOpnd_OnOrB4, the last date to include.

Not applicable for the other operand types.

Date format = MM/DD/YYYY

 Not applicable. Required for DateRangeOpnd_From.

The end date of a range to return.

Not applicable for the other operand types.
ParamType_Expression ExpOpnd_None

ExpOpnd_Equals

ExpOpnd_NotEquals

ExpOpnd_IsNull

ExpOpnd_IsNotNull

ExpOpnd_LessThan*

ExpOpnd_LessThanOrEquals*

ExpOpnd_GreaterThan*

ExpOpnd_GreaterThanOrEquals*

ExpOpnd_Like#

ExpOpnd_NotLike#

-------------------------

* - only used for numeric types.

# - only used for String types

 Not applicable for ExpOpnd_None.

Required for the other ParamTypes.

Valid types are:

  • Currency

  • Float

  • Integer

  • String
 Same operand types as Operand1.

Not applicable for ExpOpnd_None.

Optional for the other operand types.

 Required if Operand2 is specified.
ParamType_SelectOrder SelectOrderOpnd_All*

SelectOrderOpnd_Distinct*

SelectOrderOpnd_Top

SelectOrderOpnd_Bottom#

-------------------------

* - SQL only

# - MDX only

 Required for SelectOrderOpnd_Top or SelectOrderOpnd_Bottom.

An Integer specifying the number of rows to return.

Not applicable for SelectOrderOpnd_All.

 Not applicable. Not applicable.
ParamType_SingleValue Not applicable Required String value.

The value for this operand is a text field that can accommodate any type of entry. Two examples are: booleanVal = "True" and Time = "12:59:59".

 Not applicable. Not applicable.
ParamType_SiteName
(SQL query only)		 SiteNameOpnd_All

SiteNameOpnd_Equals

SiteNameOpnd_NotEquals

SiteNameOpnd_Like

SiteNameOpnd_NotLike

 Not applicable for SiteNameOpnd_All.

Required String value for the others.

 Not applicable. Not applicable.


All rights reserved.