Difference between revisions of "Index Module"
Jump to navigation
Jump to search
m (Text replace - "| width='90' | '''Signatures'''" to "| width='120' | '''Signatures'''") |
|||
| Line 11: | Line 11: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
| − | | width=' | + | | width='120' | '''Signatures''' |
|{{Func|index:facets|$db as xs:string|xs:string}}<br/>{{Func|index:facets|$db as xs:string, $type as xs:string|xs:string}} | |{{Func|index:facets|$db as xs:string|xs:string}}<br/>{{Func|index:facets|$db as xs:string, $type as xs:string|xs:string}} | ||
|- | |- | ||
| Line 30: | Line 30: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
| − | | width=' | + | | width='120' | '''Signatures''' |
|{{Func|index:texts|$db as xs:string|element(value)*}}<br/>{{Func|index:texts|$db as xs:string, $prefix as xs:string|element(value)*}}<br/>{{Func|index:texts|$db as xs:string, $start as xs:string, $ascending as xs:boolean|element(value)*}} | |{{Func|index:texts|$db as xs:string|element(value)*}}<br/>{{Func|index:texts|$db as xs:string, $prefix as xs:string|element(value)*}}<br/>{{Func|index:texts|$db as xs:string, $start as xs:string, $ascending as xs:boolean|element(value)*}} | ||
|- | |- | ||
| Line 43: | Line 43: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
| − | | width=' | + | | width='120' | '''Signatures''' |
|{{Func|index:attributes|$db as xs:string|element(value)*}}<br/>{{Func|index:attributes|$db as xs:string, $prefix as xs:string|element(value)*}}<br/>{{Func|index:attributes|$db as xs:string, $start as xs:string, $ascending as xs:boolean|element(value)*}} | |{{Func|index:attributes|$db as xs:string|element(value)*}}<br/>{{Func|index:attributes|$db as xs:string, $prefix as xs:string|element(value)*}}<br/>{{Func|index:attributes|$db as xs:string, $start as xs:string, $ascending as xs:boolean|element(value)*}} | ||
|- | |- | ||
| Line 56: | Line 56: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
| − | | width=' | + | | width='120' | '''Signatures''' |
|{{Func|index:element-names|$db as xs:string|element(value)*}} | |{{Func|index:element-names|$db as xs:string|element(value)*}} | ||
|- | |- | ||
| Line 69: | Line 69: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
| − | | width=' | + | | width='120' | '''Signatures''' |
|{{Func|index:attribute-names|$db as xs:string|element(value)*}} | |{{Func|index:attribute-names|$db as xs:string|element(value)*}} | ||
|- | |- | ||
Revision as of 11:35, 14 June 2013
This XQuery Module provides functions for displaying information stored in the database index structures.
Contents
Conventions
All functions in this module are assigned to the http://basex.org/modules/index namespace, which is statically bound to the index prefix.
All errors are assigned to the http://basex.org/errors namespace, which is statically bound to the bxerr prefix.
Functions
index:facets
| Signatures | index:facets($db as xs:string) as xs:stringindex:facets($db as xs:string, $type as xs:string) as xs:string
|
| Summary | Returns information about possible facets and facet values of the database $db in document structure format.If $type is specified as flat, the function returns this information in a flat summarized version.
|
| Errors | BXDB0002: The addressed database does not exist or could not be opened.
|
| Examples |
|
index:texts
| Signatures | index:texts($db as xs:string) as element(value)*index:texts($db as xs:string, $prefix as xs:string) as element(value)*index:texts($db as xs:string, $start as xs:string, $ascending as xs:boolean) as element(value)*
|
| Summary | Returns all strings stored in the text index of the database $db, along with their number of occurrences.If $prefix is specified, the returned entries will be refined to the ones starting with that prefix.If $start and $ascending are specified, all nodes will be returned after or before the specified start entry.
|
| Errors | BXDB0002: The addressed database does not exist or could not be opened.BXDB0004: the text index is not available.
|
index:attributes
| Signatures | index:attributes($db as xs:string) as element(value)*index:attributes($db as xs:string, $prefix as xs:string) as element(value)*index:attributes($db as xs:string, $start as xs:string, $ascending as xs:boolean) as element(value)*
|
| Summary | Returns all strings stored in the attribute index of the database $db, along with their number of occurrences.If $prefix is specified, the returned entries will be refined to the ones starting with that prefix.If $start and $ascending are specified, all nodes will be returned after or before the specified start entry.
|
| Errors | BXDB0002: The addressed database does not exist or could not be opened.BXDB0004: the attribute index is not available.
|
index:element-names
| Signatures | index:element-names($db as xs:string) as element(value)*
|
| Summary | Returns all element names stored in the index of the database $db, along with their number of occurrences.
|
| Errors | BXDB0002: The addressed database does not exist or could not be opened.
|
index:attribute-names
| Signatures | index:attribute-names($db as xs:string) as element(value)*
|
| Summary | Returns all attribute names stored in the index of the database $db, along with their number of occurrences.
|
| Errors | BXDB0002: The addressed database does not exist or could not be opened.
|
Changelog
- Version 7.7
- Updated: the functions no longer accept Database Nodes as reference. Instead, the name of a database must now be specified.
- Version 7.3
- Updated: index:texts, index:attributes: signature with three arguments added.
The module was introduced with Version 7.1.
