Bureaucrats, editor, reviewer, Administrators
13,554
edits
Changes
Jump to navigation
Jump to search
Created page with "This XQuery Module contains functions for handling ''streamable'' items. In contrast to conventional XQuery items, streamable items may take up much less spac..."
This [[Module Library|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 not be retrieved until the item is required, e.g. if data needs to be serialized or processed by another expression.
=Conventions=
All functions in this module are assigned to the {{Code|http://basex.org/modules/stream}} namespace, which is statically bound to the {{Code|stream}} prefix.<br/>
All errors are assigned to the {{Code|http://basex.org/errors}} namespace, which is statically bound to the {{Code|bxerr}} prefix.
=Functions=
==stream:materialize==
{| width='100%'
|-
| width='90' | '''Signatures'''
|{{Func|stream:materialize|$item as item()|item()}}
|-
| '''Summary'''
|Returns a materialized instance of the specified {{Code|$item}}.<br />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==
{| width='100%'
|-
| width='90' | '''Signatures'''
|{{Func|stream:is-streamable|$item as item()|item()}}
|-
| '''Summary'''
|Checks if the specified {{Code|$item}} is streamable.
|}
=Changelog=
This module was introduced with Version 7.7.
[[Category:XQuery]]
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 not be retrieved until the item is required, e.g. if data needs to be serialized or processed by another expression.
=Conventions=
All functions in this module are assigned to the {{Code|http://basex.org/modules/stream}} namespace, which is statically bound to the {{Code|stream}} prefix.<br/>
All errors are assigned to the {{Code|http://basex.org/errors}} namespace, which is statically bound to the {{Code|bxerr}} prefix.
=Functions=
==stream:materialize==
{| width='100%'
|-
| width='90' | '''Signatures'''
|{{Func|stream:materialize|$item as item()|item()}}
|-
| '''Summary'''
|Returns a materialized instance of the specified {{Code|$item}}.<br />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==
{| width='100%'
|-
| width='90' | '''Signatures'''
|{{Func|stream:is-streamable|$item as item()|item()}}
|-
| '''Summary'''
|Checks if the specified {{Code|$item}} is streamable.
|}
=Changelog=
This module was introduced with Version 7.7.
[[Category:XQuery]]
