DEFINITION:
DynamicSqlTransaction is a message type which can be used in
the 'trans' field of a 'HemsInfo' message. It is a sequence
of dynamic sql statements which will be processed as a single
transaction in the SQLSERV Tuxedo service.
DEFINITION:
This is the basic structure used to define a SQL statement to be
executed by the SQLSERV Tuxedo service. This structure also
supports the return of data to the caller.
OTHER NOTES:
If sqlId = 1450582 (Magic_NCID) then the text of the SQL
statement must be supplied in the 'sqlStatement' field and
can have bind variable place holders. If sqlId is set to
Procedure_NCID then the name of the stored procedure to be
called must be supplied in the 'procName' field and all parameters
must be supplied as bind variables. For all other values of
sqlId the context 2000 representation of the NCID will be retrieved
as the SQL statement's text, which will support bind variable place
holders. This SQL statement can be any DML, query, or PL/SQL block.
OTHER NOTES:
On input 'sqlStatement' must contain the text of the SQL statement
to be executed if 'sqlId' = 1450582 (Magic_NCID). Otherwise this
field will be ignored as input. For output purposes, this field
will not be present unless a configuration parameter is set in
SQLSERV for debug purposes.
OTHER NOTES:
On input, 'procName' must contain the the name of the stored
procedure to be called if 'sqlId' = Procedure_NCID. Otherwise it
should be empty on input. This field will never be present in
the output from the SQLSERV Tuxedo service.
OTHER NOTES:
The 'statementFlags' field contains some messaging related flags
On input, the 'rowsReturned' field can be used to indicate the
maximum number of rows which should be returned. On output,
the 'rowsReturned' field indicates the total number of rows
returned and the 'moreRows' field indicates if the number of
rows returned is less than what was actually available because
the maximum number of rows was reached.
OTHER NOTES:
The 'columnNames' field returns the names of the
columns corresponding to the rows returned in
the 'rows' field. The first column name
in the 'columnNames' sequence matches the first
value in each member of the 'rows' sequence, etc.
OTHER NOTES:
The 'rows' field is used to return a result set
if the SQL statement was either a query or a
stored procedure call with a parameter which is
a cursor variable.
OTHER NOTES:
The 'bindVars' field on input must contain as many
instances as there are bind variable placeholders in
the SQL statement to be executed. The first instance
in the bindVars sequence corresponds to the first bind
variable place holder in the SQL statement, etc. All
'inBindVars' will be set to a zero length string on
output unless a configuration parameter is set in the
SQLSERV Tuxedo service for debug purposes. All 'inOutBindVars'
will be set to the value of the bind variable after the
SQL statement is executed.
DEFINITION:
The DynamicSqlText type is simply equated to a BasicString.
DEFINITION:
The DynamicSqlProcName type is simply equated to a BasicString.
DEFINITION:
The DynamicSqlFlags type is used for messaging related flags.
On input, the 'rowsReturned' field can be used to indicate the
maximum number of rows which should be returned. On output,
the 'rowsReturned' field indicates the total number of rows
returned and the 'moreRows' field indicates if the number of
rows returned is less than what was actually available because
the maximum number of rows was reached.
DEFINITION:
The DynamicSqlColumnNames type is an ordered list of
column names associated with the result set.
DEFINITION:
The DynamicSqlColumnName type is simply equated to a BasicString.
DEFINITION:
The DynamicSqlRows type is an ordered list of the rows
returned in a result set.
DEFINITION:
The DynamicSqlColumns type is an ordered list of the values which
comprise a row of data in a result set. The order of the values
corresponds to the order of the column names in a sequence of type
DynamicSqlColumnNames.
DEFINITION:
The DynamicSqlValue type represents a single value representing either
a value for a bind varaible or a column in a
row of a result set. Numeric values will be returned as ASCII
strings which can be converted to their binary form in the
receiving application. All dates and date/times will be represented
in the 'date' field in UTC format. It is the responsibility of the
calling application to convert the UTC formatted string as needed.
DEFINITION:
The DynamicSqlBindVars type is an ordered sequence of bind variable
parameters.
DEFINITION:
The DynamicSqlBindVar type provides a way to both provide a value
and indicate whether the value is for input only, or for output also
(i.e. returned to the caller). The 'cursorVar' option is simply a
flag indicating that the bind variable should be handled as a cursor
variable and that the result set returned in the SQL statement
execution should be fetched and returned separately as rows of
values.