PhoenixmlDb.XQuery

PhoenixmlDb.XQuery API Reference

API documentation for the PhoenixmlDb.XQuery library

#PhoenixmlDb.XQuery API Reference

This reference is auto-generated from the .NET XML documentation for the PhoenixmlDb.XQuery assembly.

#PhoenixmlDb.XQuery

Type Description
DelegateMetadataProvider Adapter that wraps delegate-based metadata resolution into the IMetadataProvider interface.
HttpDocumentClient Shared HttpClient for fetching XML documents referenced by fn:doc() / xsl:source-document / fn:doc-available() when the resolved URI is http:// or https://.
IDocumentResolver Resolves document URIs to XDM documents for the XQuery fn:doc() and fn:collection() functions.
IMetadataProvider Provides document-level metadata resolution for the XQuery execution engine.
INodeBuilder Extended node store with node creation capabilities. Adds ID allocation, node registration, and namespace interning for functions that construct new XDM trees (e.g., fn:parse-xml, fn:json-to-xml).
INodeProvider Provides node resolution for the XQuery execution engine.
INodeStore Adapter that wraps a Func`2 delegate into the INodeProvider interface. Extended node provider with read-only tree navigation capabilities. Adds namespace resolution and attribute access beyond basic node lookup.
ISchemaProvider Provides schema awareness to the XQuery and XSLT engines. Public extension point — callers can substitute their own implementation (RelaxNG, Schematron-derived, in-memory, dynamic) by passing it to the QueryEngine constructor.
JsonDuplicateKeys What JsonXmlConverter does with an object that has the same key twice.
JsonToXmlOptions The options of fn:json-to-xml (XPath and XQuery Functions and Operators 3.1 §17.4.3).
JsonXmlConverter The one mapping of JSON to XML: the XML representation of JSON that fn:json-to-xml defines (XPath and XQuery Functions and Operators 3.1 §17.4.2), as an API. It is the code the function itself runs, so a host that stores or exchanges JSON as XML gets the tree a query gets, and fn:xml-to-json turns it back.
NamespaceOutput Resolves the namespace ids of nodes being serialized. A node store resolves the ids it allocated; the well-known ids are permanent (NamespaceRegistry) and resolve even in a store that never registered them. Any other id that resolves nowhere is a defect upstream — an id from another store or compilation — and fails loudly: the serializers used to write it as "" or "urn:unresolved:p", silently putting the node in a different namespace (or printing xmlns:p="", which XML 1.0 forbids).
OutputMethod Output serialization method for XQueryResultSerializer.
SchemaException Thrown when a schema cannot be loaded or compiled. Maps to XQuery error code XQST0059.
SchemaSimpleType A schema-defined simple type, as ISchemaProvider.GetSchemaSimpleType reports it: its variety and, for a union, its member types in declaration order.
SchemaSimpleTypeVariety The variety of a schema-defined simple type (XSD Part 2 §2.5.1).
SchemaTypeReference A reference to a simple type: a built-in (XSD namespace) or one an imported schema declares.
SchemaValidationException Thrown when schema validation fails during a validate expression. Maps to XQuery error code XQDY0027. It is an XQueryException, so a query's try/catch can match it by code; it used to be a bare exception, which no XQuery catch clause could name.
SerializationOptions Serialization options for XQuery output, corresponding to the declare option output:* declarations in the XQuery prolog.
TreeOrdinalAllocator Allocates process-global, monotonic tree ordinals stamped onto XdmNode.TreeOrdinal so that XDM document order — the pair (TreeOrdinal, Id) — is total and consistent across nodes drawn from independently-constructed node stores (issue #188).
ValidationMode Validation mode for the validate expression.
XQueryFacade A simple string-in / string-out API for XQuery evaluation.
XQueryResultSerializer Serializes XQuery result items (nodes, atomic values, arrays, sequences) to strings.
XdmDocumentStore An in-memory XDM document store that manages parsed XML documents, node resolution, and namespace interning. Implements both INodeProvider and IDocumentResolver so it can be passed directly to QueryEngine.
XdmShape The one place that states how an XDM sequence and an XDM array are told apart at runtime, and the safe operations over that distinction.
XsdSchemaProvider ISchemaProvider implementation backed by XmlSchemaSet. Provides full XSD validation, type annotations, and schema-element/attribute matching.

#PhoenixmlDb.XQuery.FullText

Type Description
AnalyzedTerm A single analyzed term with position information.
FtIsStopWordFunction phx:is-stop-word($word as xs:string) as xs:boolean Tests if a word is a stop word in the default language.
FtScoreFunction phx:score($node as node()) as xs:double Returns the full-text relevance score of a node from the most recent contains-text evaluation. Score is 0.0 (no match) to 1.0 (perfect match), normalized from BM25.
FtStem2Function phx:stem($term as xs:string, $language as xs:string) as xs:string Returns the stemmed form using a language-specific stemmer.
FtStemFunction phx:stem($term as xs:string) as xs:string Returns the stemmed form of a word using the default analyzer.
FtThesaurusLookupFunction phx:thesaurus-lookup($term as xs:string, $relationship as xs:string?) as xs:string* Looks up synonyms/related terms in a thesaurus. Basic built-in thesaurus with common synonyms.
FtTokenize2Function phx:tokenize($text as xs:string?, $language as xs:string) as xs:string* Tokenizes text using a language-specific analyzer.
FtTokenizeFunction phx:tokenize($text as xs:string?) as xs:string* Tokenizes text using the default full-text analyzer. Useful for debugging and understanding how text is analyzed.
FullTextAnalysisOptions Options controlling full-text analysis behavior.
FullTextEngine Full-text search engine powered by Lucene.NET analyzers. Handles tokenization, stemming, and text analysis for XQuery Full-Text queries. Uses Lucene.NET for linguistic analysis (tokenizers, stemmers, stop words) while keeping index storage separate (for LMDB integration).
FullTextIndex Full-text inverted index stored in LMDB. Key format: [term_utf8][0x00][container_id:4][document_id:8] Value format: [frequency:2][position_count:2][positions:4*count] The null byte separator allows prefix scanning by term across all documents. Container ID scoping enables per-container full-text queries.
PostingEntry A single posting list entry — one term in one document.

#PhoenixmlDb.XQuery.Parser

Type Description
ParseError A single parse error with source location information.
XQueryAstBuilder Converts an ANTLR parse tree into the XQuery AST node types.
XQueryErrorListener ANTLR error listener that collects parse errors. Implements both lexer and parser error listener interfaces.
XQueryLexerAdapter An ITokenSource adapter that wraps XQueryLexer to manage lexer mode transitions for XQuery direct element constructors.
XQueryParseException Exception thrown when XQuery parsing fails due to syntax errors in the source text.
XQueryParserFacade Public API for parsing XQuery 3.1 source text into an abstract syntax tree (AST).

#PhoenixmlDb.XQuery.Parser.XQueryParserFacade

Type Description
DepthGuardListener A parse listener that tracks ANTLR rule-invocation nesting depth and aborts the parse with a catchable XQueryParseException once it exceeds XQueryParserFacade.MaxParseDepth. Fires as each rule is entered (before descending into its children) so the runaway recursion stops early. A plain exception is thrown deliberately: ANTLR's DefaultErrorStrategy only catches RecognitionException, so a non-recognition exception propagates straight out of module() rather than triggering error recovery that would resume the descent.

#PhoenixmlDb.XQuery.Security

Type Description
IHostDocumentBuilder A document store that can build a document from content a host supplied, in the store the query or transformation navigates. A document built anywhere else is not navigable there: its string value is right and its descendants are not found.
IResourceResolver Custom resource resolver for plugging in external storage backends (S3, database, HTTP, etc.). Return null from any method to fall through to the default resolver.
PolicyEnforcingResolver Wraps an IDocumentResolver and enforces ResourcePolicy rules before delegating to the inner resolver or a custom IResourceResolver.
PolicyXIncludeResolver Resolves what an xi:include names under a resource policy. The document that holds the include was read under the policy, and what it includes is read under it too: from the host's resolver first, and otherwise only a file the policy allows, at its canonical path. Without this the include was opened by Core's own resolver, which knows no policy.
PolicyXmlResolver An XmlResolver for System.Xml readers and schema sets that fetches only what a ResourcePolicy allows: external entities, external DTD subsets, and xs:include/xs:import schema locations. file: resources are opened at the canonical path the policy authorised; HTTP fetches re-authorise every redirect.
ResourceAccessDeniedException Thrown when a resource access is denied by the configured ResourcePolicy.
ResourceAccessKind Categorizes the type of resource access being requested.
ResourceCaller Who makes a request: the two things a ResourceRequest says about the caller.
ResourceContent A resource's content as supplied by the host, with the base URI it is to be known by: relative references inside it resolve against that URI and come back to the resolver.
ResourceGate The one check every function that dereferences a URI or path makes before opening it.
ResourcePolicy Immutable security policy controlling resource access for XSLT and XQuery engines.
ResourcePolicyBuilder Fluent builder for ResourcePolicy.
ResourceRequest What the engine is about to load, as put to IResourceResolver.ResolveContent.
ResourceResolverBase Convenience base class for IResourceResolver implementations that only need to handle a subset of resource types.
UriRule Defines a scoped access rule for resource URIs.

#PhoenixmlDb.XQuery.XQueryFacade

Type Description
PrologNameContext The prolog's namespace declarations and default element namespace, for expanding the element names in cdata-section-elements and suppress-indentation. The serializer matches an element by its expanded name, Q{uri}local, or by a bare local name when it is in no namespace; a raw p:b matched nothing, so a prefixed name never took effect (QT3 K2-Serialization-29, -30, Serialization-html-18, -19a, -19b, Serialization-xhtml-18, -19a, -19b, -19c), and an unprefixed name ignored the default element namespace (K2-Serialization-31).

#PhoenixmlDb.XQuery.XQueryResultSerializer

Type Description
Utf8StringWriter StringWriter that reports the desired encoding instead of UTF-16.

#PhoenixmlDb.XQuery.XdmDocumentStore

Type Description
ExactUri A URI wrapper that preserves the exact original string without normalization. Uri adds trailing slashes to scheme://host URIs which breaks namespace URI comparison in XML serialization.

#PhoenixmlDb.XQuery.XsdSchemaProvider

Type Description
PolicySchemaGate The schema layer's gate for this provider: a document is read where the resource policy of the load allows imports — from the host's resolver first — or, for the overloads that take no policy, wherever the process can read.
PrefixResolver Adapts a prefix lookup to System.Xml's resolver interface for ParseValue.

#System.Text.RegularExpressions.Generated

Type Description
Components_0 Custom Regex-derived type for the Components method.
DateRefusal_3 Custom Regex-derived type for the DateRefusal method.
DateRest_7 Custom Regex-derived type for the DateRest method.
DateTimeRest_8 Custom Regex-derived type for the DateTimeRest method.
ExtendedYear_4 Custom Regex-derived type for the ExtendedYear method.
GYearMonthRest_6 Custom Regex-derived type for the GYearMonthRest method.
SchemePrefix_1 Custom Regex-derived type for the SchemePrefix method.
Timezone_5 Custom Regex-derived type for the Timezone method.
UndeclaredEntity_2 Custom Regex-derived type for the UndeclaredEntity method.
Utilities Helper methods used by generated Regex-derived implementations.

#System.Text.RegularExpressions.Generated.Components_0

Type Description
RunnerFactory Provides a factory for creating RegexRunner instances to be used by methods on Regex.

#System.Text.RegularExpressions.Generated.Components_0.RunnerFactory

Type Description
Runner Provides the runner that contains the custom logic implementing the specified regular expression.

#System.Text.RegularExpressions.Generated.DateRefusal_3

Type Description
RunnerFactory Provides a factory for creating RegexRunner instances to be used by methods on Regex.

#System.Text.RegularExpressions.Generated.DateRefusal_3.RunnerFactory

Type Description
Runner Provides the runner that contains the custom logic implementing the specified regular expression.

#System.Text.RegularExpressions.Generated.DateRest_7

Type Description
RunnerFactory Provides a factory for creating RegexRunner instances to be used by methods on Regex.

#System.Text.RegularExpressions.Generated.DateRest_7.RunnerFactory

Type Description
Runner Provides the runner that contains the custom logic implementing the specified regular expression.

#System.Text.RegularExpressions.Generated.DateTimeRest_8

Type Description
RunnerFactory Provides a factory for creating RegexRunner instances to be used by methods on Regex.

#System.Text.RegularExpressions.Generated.DateTimeRest_8.RunnerFactory

Type Description
Runner Provides the runner that contains the custom logic implementing the specified regular expression.

#System.Text.RegularExpressions.Generated.ExtendedYear_4

Type Description
RunnerFactory Provides a factory for creating RegexRunner instances to be used by methods on Regex.

#System.Text.RegularExpressions.Generated.ExtendedYear_4.RunnerFactory

Type Description
Runner Provides the runner that contains the custom logic implementing the specified regular expression.

#System.Text.RegularExpressions.Generated.GYearMonthRest_6

Type Description
RunnerFactory Provides a factory for creating RegexRunner instances to be used by methods on Regex.

#System.Text.RegularExpressions.Generated.GYearMonthRest_6.RunnerFactory

Type Description
Runner Provides the runner that contains the custom logic implementing the specified regular expression.

#System.Text.RegularExpressions.Generated.SchemePrefix_1

Type Description
RunnerFactory Provides a factory for creating RegexRunner instances to be used by methods on Regex.

#System.Text.RegularExpressions.Generated.SchemePrefix_1.RunnerFactory

Type Description
Runner Provides the runner that contains the custom logic implementing the specified regular expression.

#System.Text.RegularExpressions.Generated.Timezone_5

Type Description
RunnerFactory Provides a factory for creating RegexRunner instances to be used by methods on Regex.

#System.Text.RegularExpressions.Generated.Timezone_5.RunnerFactory

Type Description
Runner Provides the runner that contains the custom logic implementing the specified regular expression.

#System.Text.RegularExpressions.Generated.UndeclaredEntity_2

Type Description
RunnerFactory Provides a factory for creating RegexRunner instances to be used by methods on Regex.

#System.Text.RegularExpressions.Generated.UndeclaredEntity_2.RunnerFactory

Type Description
Runner Provides the runner that contains the custom logic implementing the specified regular expression.