xquery.RuntimeOptions

The xquery.RuntimeOptions class is used to initialize the dynamic context components for the execution of an xquery.Expression.

class xquery.RuntimeOptions(Session session, bool _report_unknown_args=True, *, **kwargs)

Attributes

xquery.RuntimeOptions.base_output_uri

The URI of the main output

xquery.RuntimeOptions.cancel_flag
xquery.RuntimeOptions.current_datetime

An xsd.dateTime value used for the current-dateTime component of the dynamic context. If absent, the system time will be used for the execution.

xquery.RuntimeOptions.debugger
xquery.RuntimeOptions.delivery_format

One of the enumeration values xpath.DeliveryFormat. When saving of result documents is selected, then the xquery.RuntimeOptions.output_stream_factory must be set as well.

xquery.RuntimeOptions.external_variables

A xpath.MapItem holding the values to be supplied for the external variables. The xpath.AtomicItem keys are created to match the xsd.QName of the corresponding parameter, while the values are provided as xpath.Sequence.

xquery.RuntimeOptions.initial_context

The initial context xpath.Item.

xquery.RuntimeOptions.initial_context_position

The initial-context position.

xquery.RuntimeOptions.initial_context_size

The initial-context size.

xquery.RuntimeOptions.output_stream_factory

This object is required to provides the output stream(s) for the final result(s), when saving of result documents is specified in xquery.RuntimeOptions.delivery_format. The factory member is invoked with the xpath.Result.uri of the currently constructed/processed result. The binary octets resulting from the serialization and encoding of the result are written to the provided output stream. See xquery.RuntimeOptions.base_output_uri and xquery.RuntimeOptions.serialization_params for further options.

xquery.RuntimeOptions.serialization_params

Overrides the serialization options.

xquery.RuntimeOptions.trace_target
xquery.RuntimeOptions.xml_document_options_provider

Special methods

__eq__, __ge__, __gt__, __le__, __lt__, __ne__