Lazy Module

From BaseX Documentation
Revision as of 14:06, 12 March 2013 by CG (talk | contribs)
Jump to navigation Jump to search

This XQuery Module contains functions for handling streamable items.

In contrast to conventional XQuery items, streamable items may take up much less space, because they only contain a reference to the actual data. The data will only be retrieved if it is required, e.g. if it needs to be serialized or processed by another expression.

Currently, the following BaseX functions return streamable items:

The following functions are capable of processing streamed input:

Conventions

All functions in this module are assigned to the http://basex.org/modules/stream namespace, which is statically bound to the stream prefix.
All errors are assigned to the http://basex.org/errors namespace, which is statically bound to the bxerr prefix.

Functions

stream:materialize

Signatures stream:materialize($item as item()) as item()
Summary Returns a materialized instance of the specified $item.
If an item is streamable, its content will be retrieved, and a new item containing its data will be returned. Other, non-streamable items will simply be returned.

stream:is-streamable

Signatures stream:is-streamable($item as item()) as item()
Summary Checks if the specified $item is streamable.

Changelog

This module was introduced with Version 7.7.