http://git-wip-us.apache.org/repos/asf/incubator-trafodion-site/blob/02a9fa60/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ComparisonPredicateInfo.html ---------------------------------------------------------------------- diff --git a/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ComparisonPredicateInfo.html b/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ComparisonPredicateInfo.html new file mode 100644 index 0000000..418cdea --- /dev/null +++ b/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ComparisonPredicateInfo.html @@ -0,0 +1,164 @@ + + + + + +tmudr: tmudr::ComparisonPredicateInfo Class Reference + + + + + + + + + +
+

tmudr::ComparisonPredicateInfo Class Reference

+

A comparison predicate to be evaluated on a table. +More...

+ +

#include <sqludr.h>

+
+Inheritance diagram for tmudr::ComparisonPredicateInfo:
+
+
+ + +tmudr::PredicateInfo + +
+
+ + + + + +

Public Member Functions

int getColumnNumber () const
bool hasAConstantValue () const
std::string getConstValue () const
+

Detailed Description

+

A comparison predicate to be evaluated on a table.

+

A predicate that compares a column value to a constant or another value that evaluates to a constant at runtime, like an SQL query parameter.

+

Member Function Documentation

+ +
+
+ + + + + + + + +
int ComparisonPredicateInfo::getColumnNumber ( )  const
+
+
+

Get the column number of the column in this comparison predicate.

+
Returns:
Column number.
+ +
+
+ +
+
+ + + + + + + + +
std::string ComparisonPredicateInfo::getConstValue ( )  const
+
+
+

Return the value, as a string, of the constant in this predicate.

+

This returns the value, using SQL syntax, of the constant involved in the comparison predicate. It throws an exception if method hasAConstantValue() would return false.

+
See also:
hasAConstantValue()
+
Returns:
Value of the constant in this comparison predicate.
+
Exceptions:
+ + +
UDRException 
+
+
+ +
+
+ +
+
+ + + + + + + + +
bool ComparisonPredicateInfo::hasAConstantValue ( )  const
+
+
+

Return whether this comparison value involves a constant.

+

The method returns whether the comparison predicate is of the form "column" "op" "constant". If it returns false, the predicate compares the column with a parameter or some other value not available to the UDR. Predicates that do not involve a constant cannot be evaluated in the UDR itself, since the comparison value is not available to the UDR. They can be evaluated on a table-valued input, however.

+
Returns:
true if the comparison is with a constant, false otherwise
+ +
+
+
The documentation for this class was generated from the following files: +
+ +
+ All Data Structures Functions Enumerations Enumerator
+ + +
+ +
+ +
Generated on 31 Aug 2016 for tmudr by  + +doxygen 1.6.1
+ + http://git-wip-us.apache.org/repos/asf/incubator-trafodion-site/blob/02a9fa60/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ConstraintInfo.gif ---------------------------------------------------------------------- diff --git a/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ConstraintInfo.gif b/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ConstraintInfo.gif new file mode 100644 index 0000000..ad556ad Binary files /dev/null and b/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ConstraintInfo.gif differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion-site/blob/02a9fa60/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ConstraintInfo.html ---------------------------------------------------------------------- diff --git a/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ConstraintInfo.html b/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ConstraintInfo.html new file mode 100644 index 0000000..d51bd83 --- /dev/null +++ b/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ConstraintInfo.html @@ -0,0 +1,146 @@ + + + + + +tmudr: tmudr::ConstraintInfo Class Reference + + + + + + + + + +
+

tmudr::ConstraintInfo Class Reference

+

A constraint on a table-valued input or output table. +More...

+ +

#include <sqludr.h>

+
+Inheritance diagram for tmudr::ConstraintInfo:
+
+
+ + +tmudr::CardinalityConstraintInfo +tmudr::UniqueConstraintInfo + +
+
+ + + + + +

Public Types

enum  ConstraintTypeCode { CARDINALITY, +UNIQUE + }

Public Member Functions

ConstraintTypeCode getType () const
+

Detailed Description

+

A constraint on a table-valued input or output table.

+

This could be a uniqueness constraint, a cardinality constraint or some other constraint

+

Member Enumeration Documentation

+ +
+ +
+

Type of a constraint

+
Enumerator:
+ + +
CARDINALITY  +

Cardinality constraint.

+
UNIQUE  +

Uniqueness constraint.

+
+
+
+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + + +
ConstraintInfo::ConstraintTypeCode ConstraintInfo::getType ( )  const
+
+
+

Get the type of the constraint.

+

This allows safe casting to derived classes, based on the type.

+
Returns:
Type of the constraint.
+ +
+
+
The documentation for this class was generated from the following files: +
+ +
+ All Data Structures Functions Enumerations Enumerator
+ + +
+ +
+ +
Generated on 31 Aug 2016 for tmudr by  + +doxygen 1.6.1
+ + http://git-wip-us.apache.org/repos/asf/incubator-trafodion-site/blob/02a9fa60/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1OrderInfo.html ---------------------------------------------------------------------- diff --git a/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1OrderInfo.html b/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1OrderInfo.html new file mode 100644 index 0000000..82df825 --- /dev/null +++ b/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1OrderInfo.html @@ -0,0 +1,318 @@ + + + + + +tmudr: tmudr::OrderInfo Class Reference + + + + + + + + + +
+

tmudr::OrderInfo Class Reference

+

Ordering of a table by some ascending or descending columns. +More...

+ +

#include <sqludr.h>

+ + + + + + + + + + + +

Public Types

enum  OrderTypeCode { NO_ORDER, +ASCENDING, +DESCENDING + }
 

Ascending/descending order of columns.

+ More...

Public Member Functions

int getNumEntries () const
int getColumnNum (int i) const
OrderTypeCode getOrderType (int i) const
void addEntry (int colNum, OrderTypeCode orderType=ASCENDING)
void addEntryAt (int pos, int colNum, OrderTypeCode orderType=ASCENDING)
void clear ()
+

Detailed Description

+

Ordering of a table by some ascending or descending columns.

+

A list of columns, represented by column numbers, with an ascending/descending indicator for each column.

+

Member Enumeration Documentation

+ +
+ +
+ +

Ascending/descending order of columns.

+

For outputs, the ordering of values from the first row out to the last. Note that this ordering applies within a parallel instance of the UDF at runtime, but it does not guarantee a total order. For example, two parallel instances may get these ordered values: instance 0 gets 1,3,5,7 instance 1 gets 2,4,6,8

+
Enumerator:
+ + + +
NO_ORDER  +

Unspecified order.

+
ASCENDING  +

Ascending order.

+
DESCENDING  +

Descending order.

+
+
+
+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
void OrderInfo::addEntry (int  colNum,
OrderTypeCode  orderType = ASCENDING 
)
+
+
+

Append an entry to the ordering.

+
Parameters:
+ + + +
colNum Column number to append to the ordering.
orderType Order type (ascending or descending) to use.
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void OrderInfo::addEntryAt (int  pos,
int  colNum,
OrderTypeCode  orderType = ASCENDING 
)
+
+
+

Insert an entry at any position of the ordering.

+

A quick example to illustrate this: Let's say we have a table with columns (a,b,c). Their column numbers are 0, 1, and 2. We produce an ordering (C ASCENDING):

+
 OrderInfo myorder;
+  
+  myorder.addEntryAt(0, 2); 
+

Next, we want to make this into (B DESCENDING, C ASCENDING):

+
 myorder.addEntryAt(0, 1, DESCENDING); 
+
Parameters:
+ + + + +
pos Position (0-based) at which we want to insert. The new entry will be position "pos" after the insertion, any existing entries will be moved up.
colNum Number of the column by which we want to order
orderType Order type (ascending or descending) to use
+
+
+
Exceptions:
+ + +
UDRException 
+
+
+ +
+
+ +
+
+ + + + + + + + +
void OrderInfo::clear ( ) 
+
+
+

Clear the contents of the object

+ +
+
+ +
+
+ + + + + + + + + +
int OrderInfo::getColumnNum (int  i )  const
+
+
+

Get the column number of an entry of the ordering.

+
Parameters:
+ + +
i the position (0-based) of the ordering, 0 meaning the leading position.
+
+
+
Returns:
The column number of the n-th entry of the ordering (both are 0-based).
+
Exceptions:
+ + +
UDRException 
+
+
+ +
+
+ +
+
+ + + + + + + + +
int OrderInfo::getNumEntries ( )  const
+
+
+

Get the number of entries (columns) in the ordering.

+
Returns:
Number of entries/columns that make up the ordering.
+ +
+
+ +
+
+ + + + + + + + + +
OrderInfo::OrderTypeCode OrderInfo::getOrderType (int  i )  const
+
+
+

Get the order type of an entry of the ordering.

+
Parameters:
+ + +
i the position (0-based) of the ordering, 0 meaning the leading position.
+
+
+
Returns:
The order type of the n-th entry of the ordering (0-based).
+
Exceptions:
+ + +
UDRException 
+
+
+ +
+
+
The documentation for this class was generated from the following files: +
+ +
+ All Data Structures Functions Enumerations Enumerator
+ + +
+ +
+ +
Generated on 31 Aug 2016 for tmudr by  + +doxygen 1.6.1
+ + http://git-wip-us.apache.org/repos/asf/incubator-trafodion-site/blob/02a9fa60/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ParameterListInfo.gif ---------------------------------------------------------------------- diff --git a/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ParameterListInfo.gif b/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ParameterListInfo.gif new file mode 100644 index 0000000..a2426a2 Binary files /dev/null and b/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ParameterListInfo.gif differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion-site/blob/02a9fa60/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ParameterListInfo.html ---------------------------------------------------------------------- diff --git a/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ParameterListInfo.html b/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ParameterListInfo.html new file mode 100644 index 0000000..7a7a009 --- /dev/null +++ b/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ParameterListInfo.html @@ -0,0 +1,94 @@ + + + + + +tmudr: tmudr::ParameterListInfo Class Reference + + + + + + + + + +
+

tmudr::ParameterListInfo Class Reference

+

Describes the parameters of a UDR. +More...

+ +

#include <sqludr.h>

+
+Inheritance diagram for tmudr::ParameterListInfo:
+
+
+ + +tmudr::TupleInfo + +
+
+ +
+

Detailed Description

+

Describes the parameters of a UDR.

+

This method currently has no methods relevant to the UDR writer, but the base class, TupleInfo, has a variety of methods.

+
See also:
TupleInfo
+
The documentation for this class was generated from the following files: +
+ +
+ All Data Structures Functions Enumerations Enumerator
+ + +
+ +
+ +
Generated on 31 Aug 2016 for tmudr by  + +doxygen 1.6.1
+ + http://git-wip-us.apache.org/repos/asf/incubator-trafodion-site/blob/02a9fa60/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1PartitionInfo.html ---------------------------------------------------------------------- diff --git a/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1PartitionInfo.html b/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1PartitionInfo.html new file mode 100644 index 0000000..c0cacba --- /dev/null +++ b/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1PartitionInfo.html @@ -0,0 +1,296 @@ + + + + + +tmudr: tmudr::PartitionInfo Class Reference + + + + + + + + + +
+

tmudr::PartitionInfo Class Reference

+

Partitioning key of an input table or result table. +More...

+ +

#include <sqludr.h>

+ + + + + + + + + + + +

Public Types

enum  PartitionTypeCode {
+  UNKNOWN, +ANY, +SERIAL, +PARTITION, +
+  REPLICATE +
+ }

Public Member Functions

 PartitionInfo ()
PartitionTypeCode getType () const
int getNumEntries () const
int getColumnNum (int i) const
void setType (PartitionTypeCode type)
void addEntry (int colNum)
void clear ()
+

Detailed Description

+

Partitioning key of an input table or result table.

+

Describes the partitioning key of a table-valued input or result. When executing a UDR in parallel, if a table is partitioned on some columns, e.g. (a,b), this means that a rows with particular values for (a,b), e.g. (10, 20) will all go to the same parallel instance and will be seen as a contiguous group. This is similar to the key of a reducer in MapReduce, except that in this case we process a group of rows with the same key, not a single key and a list of values.

+

Member Enumeration Documentation

+ +
+ +
+

Type of partitioning

+
Enumerator:
+ + + + + +
UNKNOWN  +

Partitioning type not yet determined.

+
ANY  +

No limitations on parallel execution, typical for mappers, any row can be evaluated by any parallel instance of the UDF.

+
SERIAL  +

No partitioning is allowed, execute serially in a single instance.

+
PARTITION  +

Allow parallelism with partitioning key, if specified, serial execution otherwise.

+
REPLICATE  +

Replicate the data to each parallel instance.

+
+
+
+ +
+
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + +
PartitionInfo::PartitionInfo ( ) 
+
+
+

Default constructor

+

Use this constructor to generate an object to be passed to UDRInvocationInfo::setChildPartitioning().

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + + + +
void PartitionInfo::addEntry (int  colNum ) 
+
+
+

Add a new column to the list of partitioning columns

+

Add a new column to the list of column numbers that form the partitioning key. Use this only if the type of the partitioning is set to PARTITION.

+
Parameters:
+ + +
colNum Number of the column (ordinal, 0-based) of the associated table.
+
+
+
Exceptions:
+ + +
UDRException 
+
+
+ +
+
+ +
+
+ + + + + + + + +
void PartitionInfo::clear ( ) 
+
+
+

Clear the contents of the object

+ +
+
+ +
+
+ + + + + + + + + +
int PartitionInfo::getColumnNum (int  i )  const
+
+
+

Get the number/ordinal of the ith partitioning column.

+
Returns:
Number/ordinal (0-based) of the ith partitioning column in the list of partitioning columns.
+
Exceptions:
+ + +
UDRException 
+
+
+ +
+
+ +
+
+ + + + + + + + +
int PartitionInfo::getNumEntries ( )  const
+
+
+

Get the number of columns that form the partitioning key

+

Returns the number of columns in the list of partitioning keys or zero if there are no such columns.

+
Returns:
Number of partitioning key columns (could be zero)
+ +
+
+ +
+
+ + + + + + + + +
PartitionInfo::PartitionTypeCode PartitionInfo::getType ( )  const
+
+
+

Get the partitioning type.

+
Returns:
Partition type enum.
+ +
+
+ +
+
+ + + + + + + + + +
void PartitionInfo::setType (PartitionTypeCode  type ) 
+
+
+

Set the partitioning type.

+
Parameters:
+ + +
type Partition type enum.
+
+
+ +
+
+
The documentation for this class was generated from the following files: +
+ +
+ All Data Structures Functions Enumerations Enumerator
+ + +
+ +
+ +
Generated on 31 Aug 2016 for tmudr by  + +doxygen 1.6.1
+ + http://git-wip-us.apache.org/repos/asf/incubator-trafodion-site/blob/02a9fa60/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1PredicateInfo.gif ---------------------------------------------------------------------- diff --git a/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1PredicateInfo.gif b/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1PredicateInfo.gif new file mode 100644 index 0000000..c8c90bb Binary files /dev/null and b/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1PredicateInfo.gif differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion-site/blob/02a9fa60/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1PredicateInfo.html ---------------------------------------------------------------------- diff --git a/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1PredicateInfo.html b/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1PredicateInfo.html new file mode 100644 index 0000000..ee6e267 --- /dev/null +++ b/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1PredicateInfo.html @@ -0,0 +1,268 @@ + + + + + +tmudr: tmudr::PredicateInfo Class Reference + + + + + + + + + +
+

tmudr::PredicateInfo Class Reference

+

A predicate to be evaluated on a table. +More...

+ +

#include <sqludr.h>

+
+Inheritance diagram for tmudr::PredicateInfo:
+
+
+ + +tmudr::ComparisonPredicateInfo + +
+
+ + + + + + + + + +

Public Types

enum  EvaluationCode { UNKNOWN_EVAL = 0, +EVALUATE_ON_RESULT = 0x1, +EVALUATE_IN_UDF = 0x2, +EVALUATE_IN_CHILD = 0x4 + }
 

Info on whether a table-valued input or output column is used.

+ More...
enum  PredOperator {
+  UNKNOWN_OP, +EQUAL, +NOT_EQUAL, +LESS, +
+  LESS_EQUAL, +GREATER, +GREATER_EQUAL, +IN, +
+  NOT_IN +
+ }

Public Member Functions

EvaluationCode getEvaluationCode () const
PredOperator getOperator () const
bool isAComparisonPredicate () const
+

Detailed Description

+

A predicate to be evaluated on a table.

+

These could be different kinds of predicates, like an equals predicate, a non-equals predicate or more complex cases.

+

Member Enumeration Documentation

+ +
+ +
+ +

Info on whether a table-valued input or output column is used.

+

Note that these are not necessarily exclusive, a predicate might be evaluated in multiple places, although that should not be common and is not yet allowed.

+
Enumerator:
+ + + + +
UNKNOWN_EVAL  +

Not yet determined where predicate is evaluated.

+
EVALUATE_ON_RESULT  +

Predicate is evaluated on the UDF result, in Trafodion code. This is the default.

+
EVALUATE_IN_UDF  +

Predicate is evaluated inside the code provided by the UDR writer.

+
EVALUATE_IN_CHILD  +

Predicate should be evaluated in a table-valued input before the data reaches the UDF.

+
+
+
+ +
+
+ +
+ +
+

Operator of a relational (comparison) predicate

+
Enumerator:
+ + + + + + + + + +
UNKNOWN_OP  +

Operator not yet determined.

+
EQUAL  +

Equals predicate (col = val).

+
NOT_EQUAL  +

Not equals predicate (col <> val).

+
LESS  +

Less than predicate (col <).

+
LESS_EQUAL  +

Less or equals predicate (col <=).

+
GREATER  +

Greater predicate (col >).

+
GREATER_EQUAL  +

Greater or equals predicate (col >=).

+
IN  +

IN predicate (col IN).

+
NOT_IN  +

NOT IN predicate (col NOT IN).

+
+
+
+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + + +
PredicateInfo::EvaluationCode PredicateInfo::getEvaluationCode ( )  const
+
+
+

Get evaluation code for a predicate.

+
Returns:
Evaluation code.
+
Exceptions:
+ + +
UDRException 
+
+
+ +
+
+ +
+
+ + + + + + + + +
PredicateInfo::PredOperator PredicateInfo::getOperator ( )  const
+
+
+

Get operator code for a predicate.

+
Returns:
Operator code.
+
Exceptions:
+ + +
UDRException 
+
+
+ +
+
+ +
+
+ + + + + + + + +
bool PredicateInfo::isAComparisonPredicate ( )  const
+
+
+

Check whether this predicate is a comparison predicate.

+

Use this method to determine whether it is safe to cast the object to class ComparisonPredicateInfo.

+
Returns:
true if predcate i is a comparison predicate, false otherwise.
+ +
+
+
The documentation for this class was generated from the following files: +
+ +
+ All Data Structures Functions Enumerations Enumerator
+ + +
+ +
+ +
Generated on 31 Aug 2016 for tmudr by  + +doxygen 1.6.1
+ +