Loading TOC...

cts functions (cts:query Constructors)

These functions enable you to build arbitrarily complex cts queries. Each constructor function has corresponding accessor functions, which you can use to retrieve the parts of a constructed query.

Included in these functions is the cts.registeredQuery function, which provides a mechanism to precompute and store in the cache unfiltered cts query result primitives.

219 functions
Function name Description
cts.afterQuery Returns a query matching fragments committed after a specified timestamp.
cts.afterQueryTimestamp Returns the timestamp with which a specified query was constructed.
cts.andNotQuery Returns a query specifying the set difference of the matches specified by two sub-queries.
cts.andNotQueryNegativeQuery Returns the negative (second parameter) query used to construct the specified query.
cts.andNotQueryPositiveQuery Returns the positive (first parameter) query used to construct the specified query.
cts.andQuery Returns a query specifying the intersection of the matches specified by the sub-queries.
cts.andQueryOptions Returns the options for the specified query.
cts.andQueryQueries Returns a sequence of the queries that were used to construct the specified query.
cts.beforeQuery Returns a query matching fragments committed before or at a specified timestamp.
cts.beforeQueryTimestamp Returns the timestamp with which a specified query was constructed.
cts.boostQuery Returns a query specifying that matches to $matching-query should have their search relevance scores boosted if they also match $boosting-query.
cts.boostQueryBoostingQuery Returns the boosting (second parameter) query used to construct the specified boost query.
cts.boostQueryMatchingQuery Returns the matching (first parameter) query used to construct the specified boost query.
cts.collectionQuery Match documents in at least one of the specified collections.
cts.collectionQueryUris Returns the URIs used to construct the specified query.
cts.directoryQuery Returns a query matching documents in the directories with the given URIs.
cts.directoryQueryDepth Returns the depth used to construct the specified query.
cts.directoryQueryUris Returns the URIs used to construct the specified query.
cts.documentFragmentQuery Returns a query that matches all documents where $query matches any document fragment.
cts.documentFragmentQueryQuery Returns the query used to construct the specified query.
cts.documentQuery Returns a query matching documents with the given URIs.
cts.documentQueryUris Returns the URIs used to construct the specified query.
cts.elementAttributePairGeospatialQuery Returns a query matching elements by name which has specific attributes representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
cts.elementAttributePairGeospatialQueryElementName Returns the QNames used to construct the specified query.
cts.elementAttributePairGeospatialQueryLatitudeName Returns the QNames used to construct the specified query.
cts.elementAttributePairGeospatialQueryLongitudeName Returns the QNames used to construct the specified query.
cts.elementAttributePairGeospatialQueryOptions Returns the options for the specified query.
cts.elementAttributePairGeospatialQueryRegion Returns the geographical regions with which the specified query was constructed.
cts.elementAttributePairGeospatialQueryWeight Returns the weight with which the specified query was constructed.
cts.elementAttributeRangeQuery Constructs a query that matches element-attributes by name with a range-index entry equal to a given value.
cts.elementAttributeRangeQueryAttributeName Returns the QNames used to construct the specified query.
cts.elementAttributeRangeQueryElementName Returns the QNames used to construct the specified query.
cts.elementAttributeRangeQueryOperator Returns the operator used to construct the specified query.
cts.elementAttributeRangeQueryOptions Returns the options for the specified query.
cts.elementAttributeRangeQueryValue Returns the value used to construct the specified query.
cts.elementAttributeRangeQueryWeight Returns the weight with which the specified query was constructed.
cts.elementAttributeValueQuery Returns a query matching elements by name with attributes by name with text content equal a given phrase.
cts.elementAttributeValueQueryAttributeName Returns the attribute QNames used to construct the specified query.
cts.elementAttributeValueQueryElementName Returns the element QNames used to construct the specified query.
cts.elementAttributeValueQueryOptions Returns the options for the specified query.
cts.elementAttributeValueQueryText Returns the text used to construct the specified query.
cts.elementAttributeValueQueryWeight Returns the weight with which the specified query was constructed.
cts.elementAttributeWordQuery Returns a query matching elements by name with attributes by name with text content containing a given phrase.
cts.elementAttributeWordQueryAttributeName Returns the attribute QNames used to construct the specified query.
cts.elementAttributeWordQueryElementName Returns the element QNames used to construct the specified query.
cts.elementAttributeWordQueryOptions Returns the options for the specified query.
cts.elementAttributeWordQueryText Returns the text used to construct the specified query.
cts.elementAttributeWordQueryWeight Returns the weight with which the specified query was constructed.
cts.elementChildGeospatialQuery Returns a query matching elements by name which has specific element children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
cts.elementChildGeospatialQueryChildName Returns the QNames used to construct the specified query.
cts.elementChildGeospatialQueryElementName Returns the QNames used to construct the specified query.
cts.elementChildGeospatialQueryOptions Returns the options for the specified query.
cts.elementChildGeospatialQueryRegion Returns the geographical regions with which the specified query was constructed.
cts.elementChildGeospatialQueryWeight Returns the weight with which the specified query was constructed.
cts.elementGeospatialQuery Returns a query matching elements by name whose content represents a point contained within the given geographic box, circle, or polygon, or equal to the given point.
cts.elementGeospatialQueryElementName Returns the QNames used to construct the specified query.
cts.elementGeospatialQueryOptions Returns the options for the specified query.
cts.elementGeospatialQueryRegion Returns the geographical regions with which the specified query was constructed.
cts.elementGeospatialQueryWeight Returns the weight with which the specified query was constructed.
cts.elementPairGeospatialQuery Returns a query matching elements by name which has specific element children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
cts.elementPairGeospatialQueryElementName Returns the QNames used to construct the specified query.
cts.elementPairGeospatialQueryLatitudeName Returns the QNames used to construct the specified query.
cts.elementPairGeospatialQueryLongitudeName Returns the QNames used to construct the specified query.
cts.elementPairGeospatialQueryOptions Returns the options for the specified query.
cts.elementPairGeospatialQueryRegion Returns the geographical regions with which the specified query was constructed.
cts.elementPairGeospatialQueryWeight Returns the weight with which the specified query was constructed.
cts.elementQuery Constructs a query that matches elements by name with the content constrained by the query given in the second parameter.
cts.elementQueryElementName Returns the QNames used to construct the specified query.
cts.elementQueryQuery Returns the query used to construct the element query.
cts.elementRangeQuery Constructs a query that matches elements by name with range index entry equal to a given value.
cts.elementRangeQueryElementName Returns the QNames used to construct the specified query.
cts.elementRangeQueryOperator Returns the operator used to construct the specified query.
cts.elementRangeQueryOptions Returns the options for the specified query.
cts.elementRangeQueryValue Returns the value used to construct the specified query.
cts.elementRangeQueryWeight Returns the weight with which the specified query was constructed.
cts.elementValueQuery Returns a query matching elements by name with text content equal a given phrase.
cts.elementValueQueryElementName Returns the QNames used to construct the specified query.
cts.elementValueQueryOptions Returns the options for the specified query.
cts.elementValueQueryText Returns the text used to construct the specified query.
cts.elementValueQueryWeight Returns the weight with which the specified query was constructed.
cts.elementWordQuery Returns a query matching elements by name with text content containing a given phrase.
cts.elementWordQueryElementName Returns the QNames used to construct the specified query.
cts.elementWordQueryOptions Returns the options for the specified query.
cts.elementWordQueryText Returns the text used to construct the specified query.
cts.elementWordQueryWeight Returns the weight with which the specified query was constructed.
cts.falseQuery Returns a query that matches no fragments.
cts.fieldRangeQuery Returns a cts:query matching fields by name with a range-index entry equal to a given value.
cts.fieldRangeQueryFieldName Returns the fieldname used to construct the specified query.
cts.fieldRangeQueryOperator Returns the operator used to construct the specified query.
cts.fieldRangeQueryOptions Returns the options for the specified query.
cts.fieldRangeQueryValue Returns the value used to construct the specified query.
cts.fieldRangeQueryWeight Returns the weight with which the specified query was constructed.
cts.fieldValueQuery Returns a query matching text content containing a given value in the specified field.
cts.fieldValueQueryFieldName Returns the names used to construct the specified cts:field-value-query.
cts.fieldValueQueryOptions Returns the options for the specified cts:field-value-query.
cts.fieldValueQueryText Returns the values used to construct the specified cts:field-value-query.
cts.fieldValueQueryWeight Returns the weight with which the specified query was constructed.
cts.fieldWordQuery Returns a query matching fields with text content containing a given phrase.
cts.fieldWordQueryFieldName Returns the names used to construct the specified cts:field-word-query.
cts.fieldWordQueryOptions Returns the options for the specified cts:field-word-query.
cts.fieldWordQueryText Returns the text used to construct the specified cts:field-word-query.
cts.fieldWordQueryWeight Returns the weight with which the specified query was constructed.
cts.geospatialRegionQuery Construct a query to match regions in documents that satisfy a specified relationship relative to other regions.
cts.geospatialRegionQueryOperation Returns the comparison operation specified when constructing the input query.
cts.geospatialRegionQueryOptions Returns the options specified when constructing the input query.
cts.geospatialRegionQueryReference Returns the geospatial region path index reference(s) specified when constructing the input query.
cts.geospatialRegionQueryRegion Returns the region criteria specified when constructing the input query.
cts.geospatialRegionQueryWeight Returns the weight specified when constructing the input query.
cts.jsonPropertyChildGeospatialQuery Returns a query matching json properties by name which has specific children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
cts.jsonPropertyChildGeospatialQueryChildName Returns the names used to construct the specified query.
cts.jsonPropertyChildGeospatialQueryOptions Returns the options for the specified query.
cts.jsonPropertyChildGeospatialQueryPropertyName Returns the names used to construct the specified query.
cts.jsonPropertyChildGeospatialQueryRegion Returns the geographical regions with which the specified query was constructed.
cts.jsonPropertyChildGeospatialQueryWeight Returns the weight with which the specified query was constructed.
cts.jsonPropertyGeospatialQuery Returns a query matching json properties by name whose content represents a point contained within the given geographic box, circle, or polygon, or equal to the given point.
cts.jsonPropertyGeospatialQueryOptions Returns the options for the specified query.
cts.jsonPropertyGeospatialQueryPropertyName Returns the json property names used to construct the specified query.
cts.jsonPropertyGeospatialQueryRegion Returns the geographical regions with which the specified query was constructed.
cts.jsonPropertyGeospatialQueryWeight Returns the weight with which the specified query was constructed.
cts.jsonPropertyPairGeospatialQuery Returns a query matching json properties by name which has specific property children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
cts.jsonPropertyPairGeospatialQueryLatitudeName Returns the property names used to construct the specified query.
cts.jsonPropertyPairGeospatialQueryLongitudeName Returns the property names used to construct the specified query.
cts.jsonPropertyPairGeospatialQueryOptions Returns the options for the specified query.
cts.jsonPropertyPairGeospatialQueryPropertyName Returns the property names used to construct the specified query.
cts.jsonPropertyPairGeospatialQueryRegion Returns the geographical regions with which the specified query was constructed.
cts.jsonPropertyPairGeospatialQueryWeight Returns the weight with which the specified query was constructed.
cts.jsonPropertyRangeQuery Returns a cts:query matching JSON properties by name with a range-index entry equal to a given value.
cts.jsonPropertyRangeQueryOperator Returns the operator used to construct the specified query.
cts.jsonPropertyRangeQueryOptions Returns the options for the specified query.
cts.jsonPropertyRangeQueryPropertyName Returns the JSON property name used to construct the specified query.
cts.jsonPropertyRangeQueryValue Returns the value used to construct the specified query.
cts.jsonPropertyRangeQueryWeight Returns the weight with which the specified query was constructed.
cts.jsonPropertyScopeQuery Returns a cts:query matching JSON properties by name with the content constrained by the given cts:query in the second parameter.
cts.jsonPropertyScopeQueryPropertyName Returns the JSON property name used to construct the specified query.
cts.jsonPropertyScopeQueryQuery Returns the query used to construct the property scope query.
cts.jsonPropertyValueQuery Returns a query matching JSON properties by name with value equal the given value.
cts.jsonPropertyValueQueryOptions Returns the options for the specified query.
cts.jsonPropertyValueQueryPropertyName Returns the JSON property name used to construct the specified query.
cts.jsonPropertyValueQueryText Returns the text used to construct the specified query.
cts.jsonPropertyValueQueryValue Returns the value used to construct the specified query.
cts.jsonPropertyValueQueryWeight Returns the weight with which the specified query was constructed.
cts.jsonPropertyWordQuery Returns a query matching JSON properties by name with text content containing a given phrase.
cts.jsonPropertyWordQueryOptions Returns the options for the specified query.
cts.jsonPropertyWordQueryPropertyName Returns the name used to construct the specified query.
cts.jsonPropertyWordQueryText Returns the text used to construct the specified query.
cts.jsonPropertyWordQueryWeight Returns the weight with which the specified query was constructed.
cts.locksFragmentQuery Returns a query that matches all documents where $query matches document-locks.
cts.locksFragmentQueryQuery Returns the query used to construct the specified query.
cts.lsqtQuery Returns only documents before LSQT or a timestamp before LSQT for stable query results.
cts.lsqtQueryOptions Returns the options for the specified query.
cts.lsqtQueryTemporalCollection Returns the name of the temporal collection used to construct specified query.
cts.lsqtQueryTimestamp Returns timestamp used to construct the specified query.
cts.lsqtQueryWeight Returns the weight with which the specified query was constructed.
cts.nearQuery Returns a query matching all of the specified queries, where the matches occur within the specified distance from each other.
cts.nearQueryDistance Returns the distance used to construct the near query.
cts.nearQueryOptions Returns the options for the specified query.
cts.nearQueryQueries Returns the query sequence used to construct the near query.
cts.nearQueryWeight Returns the weight with which the specified query was constructed.
cts.notInQuery Returns a query matching the first subquery, where those matches do not occur within 0 distance of the other query.
cts.notInQueryNegativeQuery Returns the negative (second parameter) query used to construct the specified query.
cts.notInQueryPositiveQuery Returns the positive (first parameter) query used to construct the specified query.
cts.notQuery Returns a query specifying the matches not specified by its sub-query.
cts.notQueryQuery Returns the query used to construct the specified query.
cts.notQueryWeight Returns the weight with which the specified query was constructed.
cts.orQuery Returns a query specifying the union of the matches specified by the sub-queries.
cts.orQueryOptions Returns the options for the specified query.
cts.orQueryQueries Returns a sequence of the queries that were used to construct the specified query.
cts.pathGeospatialQuery Returns a query matching path expressions whose content represents a point contained within the given geographic box, circle, or polygon, or equal to the given point.
cts.pathGeospatialQueryOptions Returns the options for the specified query.
cts.pathGeospatialQueryPathExpression Returns the path expressions used to construct the specified query.
cts.pathGeospatialQueryRegion Returns the geographical regions with which the specified query was constructed.
cts.pathGeospatialQueryWeight Returns the weight with which the specified query was constructed.
cts.pathRangeQuery Returns a cts:query matching documents where the content addressed by an XPath expression satisfies the specified relationship (=, <, >, etc.) with respect to the input criteria values.
cts.pathRangeQueryOperator Returns the operator used to construct the specified query.
cts.pathRangeQueryOptions Returns the options for the specified query.
cts.pathRangeQueryPathName Returns the path expression used to construct the specified query.
cts.pathRangeQueryValue Returns the value used to construct the specified query.
cts.pathRangeQueryWeight Returns the weight with which the specified query was constructed.
cts.periodCompareQuery Returns a cts:query matching documents that have relevant pair of period values.
cts.periodCompareQueryAxis1 Returns the name of the first axis used to construct the specified query.
cts.periodCompareQueryAxis2 Returns the name of the second axis used to construct the specified query.
cts.periodCompareQueryOperator Returns the operator used to construct the specified query.
cts.periodCompareQueryOptions Returns the options for the specified query.
cts.periodRangeQuery Returns a cts:query matching axis by name with a period value with an operator.
cts.periodRangeQueryAxis Returns the axis name used to construct the specified query.
cts.periodRangeQueryOperator Returns the operator used to construct the specified query.
cts.periodRangeQueryOptions Returns the options for the specified query.
cts.periodRangeQueryPeriod Returns the period used to construct the specified query.
cts.propertiesFragmentQuery Returns a query that matches all documents where $query matches document-properties.
cts.propertiesFragmentQueryQuery Returns the query used to construct the specified query.
cts.query Creates a query.
cts.rangeQuery Returns a cts:query matching specified nodes with a range-index entry compared to a given value.
cts.rangeQueryIndex Returns the range index used to construct the specified query.
cts.rangeQueryOperator Returns the operator used to construct the specified query.
cts.rangeQueryOptions Returns the options for the specified query.
cts.rangeQueryValue Returns the value used to construct the specified query.
cts.rangeQueryWeight Returns the weight with which the specified query was constructed.
cts.registeredQuery Returns a query matching fragments specified by previously registered queries (see cts:register).
cts.registeredQueryIds Returns the registered query identifiers used to construct the specified query.
cts.registeredQueryOptions Returns the options for the specified query.
cts.registeredQueryWeight Returns the weight with which the specified query was constructed.
cts.reverseQuery Construct a query that matches serialized cts queries, based on a set of model input nodes.
cts.reverseQueryNodes Returns the nodes used to construct the specified query.
cts.reverseQueryWeight Returns the weight with which the specified query was constructed.
cts.similarQuery Returns a query matching nodes similar to the model nodes.
cts.similarQueryNodes Returns the nodes used to construct the specified query.
cts.similarQueryWeight Returns the weight with which the specified query was constructed.
cts.tripleRangeQuery Returns a cts.query matching triples with a triple index entry equal to the given values.
cts.tripleRangeQueryObject Returns the object value used to construct the specified query.
cts.tripleRangeQueryOperator Returns the operators used to construct the specified query.
cts.tripleRangeQueryOptions Returns the options for the specified query.
cts.tripleRangeQueryPredicate Returns the predicate value used to construct the specified query.
cts.tripleRangeQuerySubject Returns the subject value used to construct the specified query.
cts.tripleRangeQueryWeight Returns the weight with which the specified query was constructed.
cts.trueQuery Returns a query that matches all fragments.
cts.wordQuery Returns a query matching text content containing a given phrase.
cts.wordQueryOptions Returns the options for the specified query.
cts.wordQueryText Returns the text used to construct the specified query.
cts.wordQueryWeight Returns the weight with which the specified query was constructed.