dam_describeJoinCond
- Last Updated: May 12, 2026
- 1 minute read
- OpenAccess SDK
- Version 9.0
- Documentation
This function is used by the IP when building pushdown join result set. This function returns the description of the join condition. Use this function to find out what the join condition is innertable.col = outertable.col. The join condition is returned as a condition on a column of the inner table, the condition type (=, NOT =, > and so on), and the outer table column. The outer table column is identified by the outer table process order number and the schema column number.
int dam_describeJoinCond(
DAM_HSTMT hstmt,
int * piInnerTableColNum,
int * piOpType,
int * piOuterTableProcessOrder,
int * piOuterTableColNum)
Parameters for dam_describeJoinCond
| Parameter | Type | Description |
| IN | ||
| hstmt | DAM_HSTMT | The statement handle of the inner table being processed for building the pushdown join results. |
| OUT | ||
| piInnerTableColNum | int * | The schema column number of a column of the inner table. |
| piOpType | int * | The operator type, as described in Table Operator Types for Conditions, and the same as those returned in dam_describeCondEx. BETWEEN type conditions are not considered valid join conditions. |
| piOuterTableProcessOrder | int * | The table process order of the outer table whose column is used in join condition. |
| piOuterTableColNum | int * | The schema column number of the outer table column. |
| RETURN | ||
| int | DAM_SUCCESS - valid join condition returned DAM_NOT_AVAILABLE - no clear join condition can be returned DAM_FAILURE - error |