The properties of the RequestOptions class are listed below. For a complete list of RequestOptions class members, see the RequestOptions Members topic.
Public Instance Properties
 AutoRetryDelayMillis |
The number of milliseconds to delay between each automatic query retry attempt. Zero means no delay, -1 means use the default. |
| CacheResult |
Indicates whether the ResultSequence should be cached when read from the server. Set to true to cause the ResultSequence to be cached, false if it should be streamed. The default is true. |
| EffectivePointInTime |
The point-in-time timestamp value for this object. If a point-in-time value is associated with a Request it will affect the view of the content the query will run against. When a non-zero point-in-time is in effect, only read-only requests are allowed. Updates, which modify the state of the contentbase, are not allowed. Point-in-time queries are effectively running in the past and updates are always applied to the current state of the contentbase. Note that some queries with an effective point-in-time may throw an XQueryException if deleted fragments needed to recreate the effective state have been dropped by a subsequent merge. The MarkLogic Server administrative interface contains controls to retain fragments newer than a specified timestamp. Note that a parameter with the value zero is equivalent to null. |
| Locale |
The (possibly null) CultureInfo object associated with this instance. A value of null indicates that the default locale should be associated with the request. |
| MaxAutoRetry |
The maximum number of times a retryable request will be automatically retried before throwing an exception. Setting a value of -1 indicates that the default value should be used. A value of zero indicates that no retries should be attempted. Note that this is the number of retries, not the total number of tries. Setting this value to 4, for example, means that the request will be attempted 5 times before giving up. |
| RequestName |
A user-defined name value to be associated with the Request. The value provided must be an alphanumeric string (letters and numbers only, must start with a letter). It will be logged as the HTTP Referer header in the access log and may be set as the name of the request while running in the server. This name may (eventually) be visible in the MarkLogic Server admin interface. |
| RequestTimeLimit |
The "soft" time limit to apply to the submitted request, in seconds. The time limit may be set on a per-request basis to a value less than or equal the the hard time limit configured on the appserver. A value of -1 indicates the XCC programmatic default, possibly inherited from the Session. A value of zero indicates that the appserver default should be used. Any other non-zero value is considered to be a number of seconds to set as the request time limit. |
| ResultBufferSize |
The suggested (or default if never set) ResultSequence buffer size. A size of zero indicates that the implementation default will be used. This is a hint to the implementation. If the requested size is not reasonable (too big or too small) or not appropriate for the result, this hint may be ignored or constrained. In most cases, the default setting should work well. |
| TimeoutMillis |
The timeout value (in milliseconds) to wait for connection to the server. A value of zero indicates no timeout, -1 means to use the default (usually zero). This is a hint to the implementation. It may not always be possible to reliably timeout a request within the suggested time. Server settings may also interact with or override this value. |
| TimeZone |
The (possibly null) TimeZone object associated with this instance. A value of null indicates that the default timezone should be associated with the request. |
See Also
RequestOptions Class | Marklogic.Xcc Namespace