EXCSQLSET command (X'2014')

The distributed data management (DDM) architecture Execute SQL SET command (EXCSQLSET) executes one or more SET statements to establish the application environment.

Format

Read syntax diagramSkip visual syntax diagramDSSHDRLLCPPKGNAMCSN RTNSETSTTMONITOR

Parameters

DSSHDR
The 6-byte header field containing information about the DSS.
LL
A 2-byte field that has the length of the EXCSQLSET command.
CP(X'2014')
The 2-byte codepoint of the EXCSQLSET command.
PKGNAMCSN(X'2113')
Specifies the fully qualified package name, consistency token, and section number within the package that is used to execute the SQL. The PKGNAMCSN can have one of the following formats, depending on the length of the RDBNAM, RDBCOLID, and PKGID contained therein:
  • RDBNAM, RDBCOLID, and PKGID each have a length of 18. This format of the PKGNAMCSN is identical to the sole format used before DDM Level 7, where the length is fixed at 68. The use of the SCLDTALEN is disallowed with this format.
  • At least one of RDBNAM, RDBCOLID, or PKGID has a length > 18. This format of the PKGNAMCSN requires the SCLDTALEN precedes each of the RDBNAM, RDBCOLID, and PKGID. With this format, the PKGNAMCSN has a minimum length of 75 and a maximum length of 785.

Format:

Read syntax diagramSkip visual syntax diagramLLCPSCLDTALEN RDBNAMSCLDTALENPKGID PKGNAM PKGCNSTKNPKGSN SCLDTALENRDBCOLID

Parameters:

RDBNAM
An 18- to 255-byte character field that represents the relational database name.
PKGID
An 18- to 255-byte character field that represents the relational database package identifier.
PKGNAM
An 18- to 255-byte character field that specifies the fully qualified name of a relational database package.
PKGCNSTKN
An 8-byte character field that verifies that the requester’s application and the relational database package are synchronized. Mutually exclusive with PKGSN.
PKGSN
A 2-byte short field that represents the Section Number. Mutually exclusive with PKGCNSTKN.
SCLDTALEN
Specifies the length of the instance variable that immediately follows:
  • RDB collection identifier (RDBCOLID)
  • Relational database name (RDBNAM)
  • RDB package identifier (PKGID)
This token is allowed only when the length of one or more of the parameters listed is greater than 18 bytes.
RDBCOLID
An 18- to 255-byte character field that identifies a unique collection of objects that are contained in a relational database. It is used for user-defined grouping.
Note: If the length of any one of RDBNAM, RDBCOLID, or PKGID exceeds 18 bytes, the SCLDTALEN is mandatory and must precede the RDBCOLID. Otherwise, the SCLDTALEN is disallowed.
RTNSETSTT(X'210E')
Return SET statement controls whether the target server must return one or more SQLSTT reply data objects, each containing an SQL SET statement for a special register whose setting has been modified on the current connection, upon successful processing of the command, if any special register had its setting modified during execution of the command. NO SQLSTT reply data object is returned if no special register has had its setting modified, regardless of RTNSETSTT setting.

Format:

Read syntax diagramSkip visual syntax diagramLLCPVALUE

Parameters:

VALUE
X'00' – Target server must not return any SQL SET statements.
X'01' – Target server must return one or more SQL SET statements for special registers whose settings have been modified.
Note: IMS will always send a 0x'01' from the Universal Driver.
MONITOR(X'1900')
Read syntax diagramSkip visual syntax diagramLLCPFLAGS
FLAGS
A 4-byte flag value.

EXCSQLSET examples

The following example shows EXCSQLSET that is part of the request to an OPNQRY call.

[ibm][ims][drda][t4]        SEND BUFFER: EXCSQLSET              (ASCII)           (EBCDIC)
[ibm][ims][drda][t4]        0 1 2 3 4 5 6 7   8 9 A B C D E F   0123456789ABCDEF  0123456789ABCDEF
[ibm][ims][drda][t4] 0000   004ED05100010048  2014004421134BC9  .N.Q...H ..D!.K.  .+}............I
[ibm][ims][drda][t4] 0010   D4E2F14040404040  4040404040404040  ...@@@@@@@@@@@@@  MS1             
[ibm][ims][drda][t4] 0020   D5E4D3D3C9C44040  4040404040404040  ......@@@@@@@@@@  NULLID          
[ibm][ims][drda][t4] 0030   4040E2E8E2E2D5F2  F0F0404040404040  @@........@@@@@@    SYSSN200      
[ibm][ims][drda][t4] 0040   404040405359534C  564C30310041      @@@@SYSLVL01.A        ...<.<....  
Note: RTNSETSTT & MONITOR are not in the example.