- All Modules
- All Functions
-
www.w3.org
- 2005
- XDM
- store
- introspection
- reflection
- external
-
xqdoc
-
xqdoc
(E)
-
project_xqdoc
- xqdoc2xhtml
-
xqdoc
(E)
- data processing
- expath.org
- www.functx.com
- debugger
- error
- jsoniq.org
- www.zorba-xquery.com
http://www.zorba-xquery.com/modules/store/static/indexes/ddl
import module namespace iddl = "http://www.zorba-xquery.com/modules/store/static/indexes/ddl";
This modules defines a set of functions for managing indexes which are declared in the prolog of a module.
This module is part of Zorba's XQuery Data Definition Facility. All the indexes managed by this module have to be pre-declared in the prolog of a module. Please refer to the general documentation for more information and examples.
Nicolae Brinza, Matthias Brantner, David Graf, Till Westmann, Markos Zaharioudakis
xquery version "3.0" encoding "utf-8";
The latest version of this module is 2.0. For more information about module versioning in Zorba please check out this resource.
- the XQuery module can be found here.
For more details please also see:
- Data Lifecycle
- XQuery Data Definition Facility
- http://www.zorba-xquery.com/modules/store/static/indexes/dml
- http://www.zorba-xquery.com/modules/store/static/collections/dml
- http://www.zorba-xquery.com/modules/store/static/collections/ddl
- http://www.zorba-xquery.com/modules/store/static/integrity_constraints/ddl
- http://www.zorba-xquery.com/modules/store/static/integrity_constraints/dml
- http://www.zorba-xquery.com/errors
iddl | http://www.zorba-xquery.com/modules/store/static/indexes/ddl |
ver | http://www.zorba-xquery.com/options/versioning |
zerr | http://www.zorba-xquery.com/errors |
![]() |
available-indexes
(
) as xs:QName* The function returns a sequence of QNames representing the indexes that are available. |
![]() ![]() |
create
(
$name as xs:QName
) as The create function is an updating function which creates the index with the given expanded QName and populates the index with its values. |
![]() |
declared-indexes
(
) as xs:QName* The function returns a sequence of QNames representing the indexes that have been declared in the prolog of the static context. |
![]() ![]() |
delete
(
$name as xs:QName
) as The delete function is an updating function that deletes the index with the given expanded QName. |
![]() |
is-available-index
(
$name as xs:QName
) as xs:boolean The function returns true if an index with the given QName is available. |
![]() |
is-declared-index
(
$name as xs:QName
) as xs:boolean The function returns true if a index with the given QName is declared in the prolog of the static context. |
declare function iddl:available-indexes ( ) as xs:QName*
The function returns a sequence of QNames representing the indexes that are available. The sequence will be empty if there are no indexes.
- A sequence of QNames, one for each available index, or an empty sequence if none are.
declare function iddl:create ( $name as xs:QName ) as
The create function is an updating function which creates the index with the given expanded QName and populates the index with its values.
- $name The QName of the index to create.
- The result of the function is an empty XDM instance and a pending update list which, once applied, creates the index with the given name.
- zerr:ZDDY0021 if the expanded QName of $name is not equal to the name of any resource in the statically known indexes.
- zerr:ZDDY0022 if the index with the given name is already created.
declare function iddl:declared-indexes ( ) as xs:QName*
The function returns a sequence of QNames representing the indexes that have been declared in the prolog of the static context.
- A sequence of QNames, one for each created collection, or an emtpy sequence.
declare function iddl:delete ( $name as xs:QName ) as
The delete function is an updating function that deletes the index with the given expanded QName.
- $name The QName of the index to delete.
- The result of the function is an empty XDM instance and a pending update list which, once applied, deletes the index with the given name.
- zerr:ZDDY0009 If available indexes does not provide a mapping for the expanded QName $name.
declare function iddl:is-available-index ( $name as xs:QName ) as xs:boolean
The function returns true if an index with the given QName is available. (i.e. has been created).
- $name The QName of the index that is being checked.
- true if the index is available and false otherwise.
declare function iddl:is-declared-index ( $name as xs:QName ) as xs:boolean
The function returns true if a index with the given QName is declared in the prolog of the static context.
- $name The QName of the index that is being checked.
- true if the index is declared or false otherwise.