DB2 10.5 for Linux, UNIX, and Windows

Common input and output parameters

The common SQL API stored procedures share a set of input and output parameters.

The following table provides a brief description of these parameters. For more detailed information, see the reference topics about the common SQL API stored procedures.

Table 1. Common SQL API shared input and output parameters
Parameter	Description
`major_version`	Indicates the document type major version that the caller supports for the XML documents passed as parameters in the procedure.
`minor_version`	Indicates the document type minor version that the caller supports for the XML documents passed as parameters in the procedure. The parameters `major_version` and `minor_version` are used together to ensure that the caller does not use an XML input document of an incorrect version. The procedure processes all XML documents in the specified `major_version` and `minor_version`, or returns an error if a version is not valid. This design supports extensibility in future releases because newer document type versions can be added without affecting existing applications.
`requested_locale`	Specifies the locale to use to return translated content in the XML documents returned in the `xml_output` and `xml_message` parameters. Only values are translated, not key names.
`xml_input`	Specifies an XML input document that contains input values for the procedure.
`xml_filter`	Specifies a valid XPath query string that is used to retrieve a single value from an output parameter document.
`xml_output`	Returns a complete XML output document encoded in UTF-8. Depending on the procedure that is being called, this document might contain configuration parameters and their values, system information, or message text. When the procedure operates in complete mode, this parameter returns an XML document that you can modify and pass back to the procedure as the `xml_input` parameter. This approach provides a programmatic way to create valid XML input documents.
`xml_message`	Returns a complete XML output document of type Data Server Message in UTF-8 that provides detailed information about a SQL warning condition.