Saxon.Api

 

 

Saxon.Api

Class XQueryExecutable


public class XQueryExecutable

An XQueryExecutable represents the compiled form of a query. To execute the query, it must first be loaded to form an XQueryEvaluator.

An XQueryExecutable is immutable, and therefore thread-safe. It is simplest to load a new XQueryEvaluator each time the query is to be run. However, the XQueryEvaluator is serially reusable within a single thread.

An XQueryExecutable is created by using one of the Compile methods on the XQueryCompiler class.

Property Summary

 bool IsUpdateQuery

Ask whether this is an updating query (that is, one that returns a pending update list rather than a conventional value).

 Processor Processor

Get the Processor from which this XQueryExecutable was constructed

 

Method Summary

 IDictionary<QNameParameterDetails> GetExternalVariables ()

Get information about the external variables declared in the query

 XQueryEvaluator Load ()

Load the query to prepare it for execution.

 

Property Detail

IsUpdateQuery

public bool IsUpdateQuery {get; }

Ask whether this is an updating query (that is, one that returns a pending update list rather than a conventional value).

Processor

public Processor Processor {get; }

Get the Processor from which this XQueryExecutable was constructed

Method Detail

GetExternalVariables

public IDictionary<QNameParameterDetails> GetExternalVariables()

Get information about the external variables declared in the query

Load

public XQueryEvaluator Load()

Load the query to prepare it for execution.

Returns:

An XQueryEvaluator. The returned XQueryEvaluator can be used to set up the dynamic context for query evaluation, and to run the query.