skip to main content
SQL Engine Parse Tree API : SQL Engine Parse Tree functions reference : damex_describeInsertQuery
 

damex_describeInsertQuery

This function returns the INSERT query details.
int damex_describeInsertQuery(DAM_HQUERY hquery,
    DAM_HTABLE * phTable,
    DAM_HCOL_LIST * phColList,
    DAM_HROW_LIST * phInsertRowList,
    DAM_HQUERY * phInsertQuery);
Table 189. Parameters for damex_describeInsertQuery
Parameter
Type
Description
IN
hquery
DAM_HQUERY
The query handle.
OUT
phTable
DAM_HTABLE *
The handle to the insert table.
Use damex_describeTable/damex_describeTableW to get the table details.
phColList
DAM_HCOL_LIST *
The handle to the column list of the insert query.
Use damex_getFirstColInList, damex_getNextColInList to get the insert columns, and damex_describeCaseValExp to get each of the column details.
phInsertRowList
DAM_HROW_LIST *
The handle to the rows containing the values specified in the insert query.
Use damex_getFirstInsertRow, damex_getNextInsertRow to navigate the multiple insert value lists specified. If only one set of values are specified, the first call to damex_getNextInsertRow returns NULL.
Use damex_getFirstInsertValueExp and damex_getNextInsertValueExp to navigate each of the rows.
phInsertQuery
DAM_HQUERY *
The handle to the query whose result table rows are to be used as values to be inserted. The value of phInsertRowList is NULL when this value is returned. Use damex_describeSelectQuery to get query details.
RETURN
int
DAM_SUCCESS - on success
DAM_FAILURE - on failure

See also

*damex_describeTable/damex_describeTableW
*damex_getFirstColInList
*damex_getNextColInList
*damex_getFirstInsertValueExp
*damex_getNextInsertValueExp
*damex_describeSelectQuery