tmudr::ProvenanceInfo Class Reference

Describes where an output column is coming from. More...

#include <sqludr.h>

Public Member Functions
	ProvenanceInfo ()
	ProvenanceInfo (int inputTableNum, int inputColNum)
int	getInputTableNum () const
int	getInputColumnNum () const
bool	isFromInputTable (int inputTableNum=-1) const

---

Detailed Description

Describes where an output column is coming from.

Points to input table and input column number that is the source of a column. This must only be used if the result column always has the exact same value as the current value of the corresponding input column.

See also:

ColumnInfo::getProvenance()

ColumnInfo::setProvenance()

UDRInvocationInfo::addPassThruColumns()

---

Constructor & Destructor Documentation

ProvenanceInfo::ProvenanceInfo

(

)

Default constructor, generates unspecified provenance.

ProvenanceInfo::ProvenanceInfo	(	int	inputTableNum,
		int	inputColNum
	)

Constructor to link an output column to a specific input column

This constructor can be used to produce a "passthru column". An easier way to do this is the UDRInvocationInfo::addPassThruColumns() method.

Parameters:

	inputTableNum	Input table number (0 for a TMUDF with a single table-valued input, the most common case).
	inputColNum	Column number in intput table "inputTableNum" that is the source of the output column to be produced.

---

Member Function Documentation

int ProvenanceInfo::getInputColumnNum

(

)

const

Get the input column number.

Returns:

Input column number.

int ProvenanceInfo::getInputTableNum

(

)

const

Get the input table number.

Returns:

Input table number.

bool ProvenanceInfo::isFromInputTable

(

int

inputTableNum = -1

)

const

Test whether the column comes from any or from a specific table-valued input.

Parameters:

inputTableNum

-1 to test for any table-valued input, or a specific input table number.

Returns:

true if the provenance indicates a column that comes from the specified input table(s), false otherwise

---

The documentation for this class was generated from the following files:

• sqludr.h
• sqludr.cpp