skip to main content
OpenAccess SDK SQL Engine core methods for Java : Exchanging data : dam_describeJoinTable
 

dam_describeJoinTable

This method returns the attributes of the table with the given TableProcessOrder in the join query being processed. This method is called from ipExecute to get the details about each of the tables in the join query. Pass in NULL for any attribute in which you have no interest.
int dam_describeJoinTable(
long         hstmt,
int          iTableProcessOrder,
StringBuffer pCatalog,
StringBuffer pSchema,
StringBuffer pTableName,
StringBuffer pTablePath,
StringBuffer pUserData)
Table 149. Parameters for dam_describeJoinTable
Parameter
Type
Description
INPUT
hstmt
long
The statement handle.
iTableProcessOrder
int
The process order of the table. Numbers start at 0.
OUTPUT
pCatalog
StringBuffer
The table qualifier as entered in the OA_TABLES table.
pSchema
StringBuffer
The table owner as entered in the OA_TABLES table.
pTableName
StringBuffer
The name of the table.
pTablePath
StringBuffer
The path of the table that is specified in the path column of the OA_TABLES table. This is an IP specific field.
pUserData
StringBuffer
The Table_Userdata as entered in the OA_TABLES table. This can be any string that the IP wants to associate with a table.
RETURN
int
DAM_SUCCESS - found table with matching iTableProcessOrder.
DAM_NOT_AVAILABLE - invalid iTableProcessOrder. Matching table not found.DAM_FAILURE - The query that is being processed is not a join query.