{ "ns" : "http://zorba.io/modules/store/static/indexes/dml", "description" : " This module defines a set of functions to probe and refresh indexes which are\n declared in the prolog of a module.\n
\n This module is part of\n Zorba's XQuery Data Definition Facility.\n All the indexes managed by this module have to be pre-declared in the prolog\n of a library module.\n Please refer to the\n general documentation\n for more information and examples.\n", "sees" : [ "
\n <key xmlns=\"http://zorba.io/modules/store/static/indexes/dml\">\n <attribute value=\"key1_value\"/>\n <attribute value=\"key2_value\"/>\n <attribute value=\"key3_value\"/>\n </key>\n\n Note that the order of the attribute elements reflects the order of\n the keys in the index specification. Also note that the values in\n these attributes have the type that is declared in the corresponding\n index specification.\n", "summary" : "
Gets a sequence of all keys contained in the index with the given name.
", "annotation_str" : "", "annotations" : [ ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurence" : null, "description" : "Gets from an index the domain nodes associated by general equality with a\n given search sequence .
", "annotation_str" : "", "annotations" : [ ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurence" : null, "description" : "$keys = $node/keyExprwhere keyExpr is the expression specified in the keyspec of the index (remember that for general indexes, there can be only one keyspec)." }, "errors" : [ "
probe-index-point-value()
function\n in that it allows index items to be skipped.\n", "summary" : "This is an extension of the probe-index-point-value() function\n in that it allows index items to be skipped.
", "annotation_str" : " %an:variadic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "variadic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurence" : null, "description" : "\n The search tuple consists of a number of search keys where each\n search key is either an atomic item or the empty sequence. The number of\n search keys given must be equal to the number of keys declared for the\n index. Since the number of keys differs from one index to another, this\n function is variadic.\n", "summary" : "
Gets the domain nodes from an index associated by value equality with a\n given search tuple .
", "annotation_str" : " %an:variadic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "variadic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurence" : null, "description" : "$key1 eq $node/keyExpr1 and ... and $keyM eq $node/keyExprMwhere keyExpri is the expression specified in the i-th keyspec of the index." }, "errors" : [ "
<=
, <
, >=
,\n >
) with one or two search sequences.\n \n Each search sequence consists of an arbitrary number of\n search keys where each search key is an atomic item.\n This method is supported by general range indexes only.\n Its result is either an error or the set of domain nodes for which the\n following XQuery expression returns true:\n
\n if ( $haveLowerBound and $haveUpperBound ) then\n $lowerBoundKeys lop $node/keyExpr and $node/keyExpr uop $upperBoundKeys\n else if ( $haveLowerBound ) then\n $lowerBoundKeys lop $node/keyExpr\n else if ( $haveUpperBound ) then\n $node/keyExpr uop $upperBoundKeys\n else\n fn:true()\n\n where keyExpr is the expression specified in the keyspec of the\n index, lop is either the
<=
or the <
\n operator depending on whether $lowerBoundsIncluded
is true or\n false, and uop is either the <=
or the\n <
operator depending on whether\n $upperBoundsIncluded
is true or false.\n", "summary" : "Gets the domain nodes associated by general order-comparison (operators\n <= , < , >= ,\n > ) with one or two search sequences .
", "annotation_str" : "", "annotations" : [ ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurence" : null, "description" : "<=
or the <
operator when comparing a search key from $lowerBound
with an index key.<=
or the <
operator when comparing an index key with a search key from $upperBound
.$haveLowerBound
is true and $lowerBoundKeys
contains an atomic item whose type does not match the sequence type specified by the index keyspec, or $haveUpperBound
is true and $upperBoundKeys
contains an atomic item whose type does not match the sequence type specified by the index keyspec.probe-index-range-value()
\n function that index items to be skipped.\n", "summary" : "This function is an extension of the probe-index-range-value() \n function that index items to be skipped.
", "annotation_str" : " %an:variadic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "variadic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurence" : null, "description" : "$lowerBound-i
value.$upperBound-i
value.$lowerBound-i
value is part of the range.$upperBound-i
value is part of the range.$haveLowerBound-i
is true and $lowerBound-i
is an atomic item whose type does not match the sequence type specified by the ith keyspec, or $haveUpperBound-i
is true and $upperBound-i
is an atomic item whose type does not match the sequence type specified by the ith keyspec.le
, lt
, ge
, gt
) with a\n given search box.\n \n The search box is specified as a number M of rangespecs\n where each rangespec consists of six values.\n The number M must be greater than 0 and less than or equal to the\n number N of keyspecs found in the index declaration.\n If M < N, then the \"missing\" rangespecs are assumed to have\n the following value: [(), (), false, false, false, false].\n As a result, we can assume that M = N.\n Remember that for general indexes, there can be only one IndexKeySpec and,\n as a result for general indexes, M = N = 1.\n Since the number of keys differs from one index to another,\n this function is variadic.\n
\n The ith rangespec corresponds to the ith keyspec, and\n specifies a search condition on the key values that are produced by\n evaluating that keyspec for every domain node.\n Specifically, we define the ith rangespec result as the\n set of domain nodes for which the following XQuery expression returns\n true:\n
\n if ( $haveLowerBound-i and $haveUpperBound-i ) then\n $lowerBound-i lop $node/keyExpr-i and $node/keyExpr-i uop $upperBound-i\n else if ( $haveLowerBound-i ) then\n $lowerBound-i lop $node/keyExpr-i\n else if ( $haveUpperBound-i ) then\n $node/keyExpr-i uop $upperBound-i\n else\n fn:true()\n\n where keyExpr-i is the expression specified by the ith\n keyspec of the index, lop is either the
le
or the\n lt
operator depending on whether\n $lowerBoundsIncluded-i
is true or false, and uop is\n either the le or the lt operator depending on whether\n $upperBoundsIncluded-i
is true or false.\n", "summary" : "Gets the domain nodes associated by value order-comparison (operators\n le , lt , ge , gt ) with a\n given search box .
", "annotation_str" : " %an:variadic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "variadic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurence" : null, "description" : "$lowerBound-i
value.$upperBound-i
value.$lowerBound-i
value is not considered part of the range. Otherwise, the range is closed from below, i.e., the $lowerBound-i
value is part of the range.$upperBound-i
value is not considered part of the range. Otherwise, the range is closed from above, i.e., the $upperBound-i
value is part of the range.$haveLowerBound-i
is true and $lowerBound-i
is an atomic item whose type does not match the sequence type specified by the ith keyspec, or $haveUpperBound-i
is true and $upperBound-i
is an atomic item whose type does not match the sequence type specified by the ith keyspec.Updates the index with the given name.
", "annotation_str" : "", "annotations" : [ ], "updating" : true, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurence" : null, "description" : "