Difference between revisions of "Index Module"
Jump to navigation
Jump to search
(Created page with "This module is introduced with BaseX {{Mark|Version 7.1}} and contains XQuery functions for handling informations coming directly from the indexes within X...") |
|||
Line 10: | Line 10: | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Returns information about possible facets and facet values on a database in document structure format. {{Mono|$db}} may either be | + | |Returns information about possible facets and facet values on a database in document structure format. {{Mono|$db}} may either be an <code>xs:string</code>, denoting the database name, or a node stored in the database.<br/>If {{Mono|$type}} is specified as {{Mono|flat}}, the function returns this information in a flat summarized version. |
|- | |- | ||
| valign='top' | '''Errors''' | | valign='top' | '''Errors''' | ||
− | |< | + | |'''[[XQuery Errors#BaseX Errors|BASX0002]]''' is raised if {{Mono|$db}} is a node that is not stored in a database.<br/>'''[[XQuery Errors#BaseX Errors|BASX0003]]''' is raised if the addressed database {{Mono|$db}} cannot be opened.<br/>'''[[XQuery Errors#BaseX Errors|BASX0021]]''' is raised if the index is not available or doesn't have the needed information.<br/> |
|- | |- | ||
| valign='top' | '''Examples''' | | valign='top' | '''Examples''' |
Revision as of 16:00, 27 December 2011
This module is introduced with BaseX Template:Mark and contains XQuery functions for handling informations coming directly from the indexes within XQuery. All functions are introduced with the index:
prefix, which is linked to the http://www.basex.org/modules/index
namespace.
General Functions
index:facets
Signatures | index:facets($db as item()) as xs:string index:facets($db as item(), $type as xs:string) as xs:string
|
Summary | Returns information about possible facets and facet values on a database in document structure format. $db may either be an xs:string , denoting the database name, or a node stored in the database.If $type is specified as flat , the function returns this information in a flat summarized version.
|
Errors | BASX0002 is raised if $db is a node that is not stored in a database.BASX0003 is raised if the addressed database $db cannot be opened.BASX0021 is raised if the index is not available or doesn't have the needed information. |
Examples |
|