This file contains parameter descriptions that are reused
by all of the common SQL API reference topics.
- major_version
- An input and output argument of type INTEGER
that indicates the major document version. On input, this argument
indicates the major document version that the caller supports for
the XML documents passed as parameters in the procedure (see the parameter
descriptions for xml_input, xml_output, and xml_message). The procedure processes all
XML documents in the specified version, or returns an error (+20458)
if the version is not valid. On output, this parameter specifies the
highest major document version that is supported by the procedure.
To determine the highest supported document version, specify NULL
for this input parameter and all other required parameters.
- If the XML document in the xml_input parameter specifies a Document Type Major Version
key, the value for that key must be equal to the value provided in
the major_version parameter, or an error (+20458)
is raised.
- minor_version
- An input and output argument of type INTEGER
that indicates the minor document version. On input, this argument
specifies the minor document version that the caller supports for
the XML documents passed as parameters for this procedure (see the
parameter descriptions for xml_input, xml_output, and xml_message). The procedure
processes all XML documents in the specified version, or returns an
error if the version is not valid. On output, this parameter indicates
the highest minor document version that is supported for the highest
supported major version. To determine the highest supported document
version, specify NULL for this input parameter and all other required
parameters.
- If the XML document in the xml_input parameter specifies a Document Type Minor Version key, the value
for that key must be equal to the value provided in the minor_version parameter, or an error (+20458) is raised.
- requested_locale
- An input argument of type VARCHAR(33)
that specifies a locale. If the specified language is supported on
the server, translated content is returned in the xml_output and xml_message parameters. Otherwise, content
is returned in the default language. Only the language and possibly
the territory information is used from the locale. The locale is not
used to format numbers or influence the document encoding. For example,
key names and values are not translated. The only translated portion
of the XML output and XML message documents are the text for hint,
display name, and display unit of each entry. The caller should always
compare the requested language to the language that is used in the
XML output document (see the document locale entry in the XML output
document).
Currently, the only supported value for requested_locale is en_US.
- xml_input
- An input argument of type BLOB(32MB) that specifies
an XML input document (encoded in UTF-8) that contains input values
for the procedure.
- Currently, this procedure accepts no input.
You must specify NULL for this parameter, or an error (+20458) is
raised to indicate that the input is not valid.
- xml_filter
- An input argument of type BLOB(4K) that specifies
a valid XPath query string. Use a filter when you want to retrieve
a single value from an XML output document. For more information,
see the topic that describes XPath filtering.
- xml_output
- An output parameter of type BLOB(32MB) that
returns a complete XML output document in UTF-8. If a filter is specified,
this parameter returns a string value. If the stored procedure is
unable to return a complete output document (for example, if a processing
error occurs that results in an SQL warning or error), this parameter
is set to NULL.
- 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. For more information, see the topic about complete
mode.
- xml_message
- An output parameter of type BLOB(64K) that
returns a complete XML output document of type Data Server Message
in UTF-8 that provides detailed information about a SQL warning condition.
This document is returned when a call to the procedure results in
a SQL warning, and the warning message indicates that additional information
is returned in the XML message output document. If the warning message
does not indicate that additional information is returned, then this
parameter is set to NULL.
DB2 Version 10.1 for Linux, UNIX, and Windows