HTTP Functions <request> Element

---

You use attributes of the <request> element to specify optional parameters when submitting a query to the origin server. Examples of <request> element attributes include connection and socket timeout values, the number of retries, and HTTP version.

The following table summarizes the available parameters for HTTP function <request> elements. See Specifying HTTP Client-Server Options for more information for more information on using the <request> element.

Table 12-8. Function Request Parameters

Parameter Name	Description	Valid Values
cookie-policy	Allows you to specify how to manage cookies. See Managing Cookies.	RFC2109 (default) RFC2965 netscape ingore-cookies
connection-timeout	Connection timeout value, in milliseconds.	Positive integer
http-version	The HTTP version expected by the origin server.	http_1_0 http_1_1 (default)
password	Password associated with username when the origin server requires authentication.	String; origin server dependent
protocol-head-body-timeout	The wait time, in milliseconds, for the response body after a ddtek:http-head call. Not all servers adhere to the HTTP protocol when replying to a head request.	Positive integer
protocol-reject-head-body	Reject response returned after ddtek:head-call. Not all servers adhere to the HTTP protocol when replying to a head request.	yes no
proxy-host	URI of a proxy server to which DDXQ can be configured to route all requests.	String
proxy-password	Password associated with the proxy-username required by the proxy server.	String; proxy server dependent
proxy-port	Port on the proxy server that is configured to listen for DataDirect XQuery requests.	Integer; proxy server dependent
proxy-username	Username associated with the proxy-password required by the proxy server.	String; proxy server dependent
response-data-type	Allows you to override the origin server’s default encoding behavior. See Response Encoding.	text xml base64
retries	The number of times DataDirect XQuery retries an HTTP call after a failure. Not every failure is subject to a retry.	Positive integer
serialize	Specifies how the payload has to be serialized before sending to the origin server.	String. See ddtek:serialize for possible values.
socket-linger	The delay, in milliseconds, before a reset is sent to the origin server, allowing more time for data to be read or sent, possibly at the expense of performance.	Positive integer. See Managing Connections and Sockets.
socket-receivebuffer	Size, in bytes, of the socket receive buffer. The socket receive buffer is an input buffer used by the networking implementation.	Positive integer. See Managing Connections and Sockets.
socket-sendbuffer	Size, in bytes, of the socket send buffer. The socket send buffer is an output buffer used by the networking implementation.	Positive integer. See Managing Connections and Sockets.
socket-timeout	The interval, in milliseconds, to wait for data from the origin server.	Positive integer. See Managing Connections and Sockets.
streaming	Whether or not to allow streaming on the response from the origin server.	yes (default) no
tcp-nodelay	Whether to enable or disable an algorithm that trades bandwidth conservation for network latency.	yes (default) no
username	Username associated with password when the origin server requires authentication.	String; origin server dependent
wrap-execution	When set to yes, prevents runtime errors from halting query execution.	yes no (default)