PhoenixmlDb.XQuery

XdmDocumentStore

An in-memory XDM document store that manages parsed XML documents, node resolution, and namespace interning. Implements both and so it can be passed directly to .

#XdmDocumentStore

Namespace: PhoenixmlDb.XQuery

An in-memory XDM document store that manages parsed XML documents, node resolution, and namespace interning. Implements both

and

so it can be passed directly to

.

This is the recommended way to set up standalone XQuery execution against in-memory XML. Load documents via XdmDocumentStore.LoadFromString or XdmDocumentStore.LoadFile, then pass this store as both the nodeProvider and documentResolver to QueryEngine.

#Example

var store = new XdmDocumentStore();
store.LoadFromString("<root><item/></root>", "urn:my:doc");

var engine = new QueryEngine(nodeProvider: store, documentResolver: store);
await foreach (var item in engine.ExecuteAsync("doc('urn:my:doc')//item"))
{
    Console.WriteLine(item);
}
            

#Properties

#Methods

#AllocateDocumentId

#AllocateNodeId

Allocates a new unique

for constructed nodes (e.g., XQuery element/text constructors).

Returns: A fresh node ID that does not collide with any existing node.

#ClearCollections(Boolean)

Removes every registered collection. For a host that reuses one store across independent evaluations whose collections must not carry over (the QT3 harness runs a test set's cases in one store).

Parameters:

• explicitOnly — True to keep collections explicitly managed: only collections registered afterwards exist, and there is no default collection unless one is registered. False to return to the default rules, where the default collection is every loaded document.

#ConstructionEpoch

Returns this store's construction epoch, allocating it on first use. All constructed nodes in the store share this single ordinal (tie-broken by

), and its high bit places it above every parse-time ordinal.

#ExpandXInclude(Xml.XmlReader,String,PhoenixmlDb.Core.Xml.XIncludeOptions)

Loads

into an intermediate DOM, expands its

xi:include

s against the absolute

, and returns the serialized result for re-parsing into XDM. The reader is encoding-aware (it honors the document's XML declaration / BOM), unlike pre-decoding a stream with a bare

StreamReader

. DTD handling matches the normal load path (

): internal entities expand, external DTD/entities are not fetched (no XXE).

#GetNode(PhoenixmlDb.Core.NodeId)

#IsDocumentAvailable(String)

#IsDocumentAvailable(String,Func<Uri,Boolean>)

with every HTTP redirect target passed to

first, as

does.

#LoadFile(String)

Loads an XML document from a file path.

Parameters:

• filePath — The path to the XML file.

Returns: The parsed XDM document node.

#LoadFromStream(IO.Stream,String)

Loads an XML document from a stream.

Parameters:

• stream — The stream containing XML content.

• documentUri — Optional URI that identifies this document.

Returns: The parsed XDM document node.

#LoadFromString(String,String)

Loads an XML document from a string.

Parameters:

• xml — The XML content to parse.

• documentUri — Optional URI that identifies this document. When set, the document can be retrieved via fn:doc() using this URI.

Returns: The parsed XDM document node.

#LoadFromStringWithSchema(String,String,Xml.Schema.XmlSchemaSet)

Loads an XML document from a string with XSD schema validation. Schema type annotations (xs:ID, xs:IDREF, etc.) are populated from the schema.

Parameters:

• xml — The XML content to parse.

• documentUri — Optional URI that identifies this document.

• schemas — The XSD schema set to validate against.

Returns: The parsed XDM document node.

#MaybeExpandXInclude(String,String)

When

is enabled, expands

xi:include

elements in

(resolved against the absolute

) before it is handed to

. Returns

unchanged when XInclude is off.

#RegisterCollection(String,Collections.Generic.List<Object>)

Registers a named collection of items (nodes or atomic values).

Parameters:

• uri — The collection URI. Use empty string for the default collection.

• items — The items in the collection.

#RegisterNamespace(String,PhoenixmlDb.Core.NamespaceId)

Registers a specific

for a URI, so that elements constructed with IDs from the static analyzer can be serialized back to their namespace URIs. If the URI is already registered, this is a no-op (the existing ID is kept).

#RegisterNode(PhoenixmlDb.Xdm.Nodes.XdmNode)

Registers a constructed node (created by XQuery node constructors) in the store, making it resolvable via

.

Parameters:

• node — The node to register.

Stamps the node with this store's construction epoch (issue #188) so it participates in cross-store document order and sorts after any parsed document. Nodes that already carry a (parse-time or copied) ordinal are left untouched.

#RegisterParsedNodes(Collections.Generic.IEnumerable<PhoenixmlDb.Xdm.Nodes.XdmNode>)

Stamps a batch of freshly-parsed nodes with a single, store-global parse-time tree ordinal (issue #188) and registers them. All nodes of one loaded document share the ordinal, so intra-document order is decided by

exactly as before; documents loaded later receive higher ordinals, preserving multi-document order within the store.

#ResolveCollection(String)

#ResolveCollection(String,Func<Uri,Boolean>,Boolean)

under a resource policy. A collection that is one document read by its URI passes every HTTP redirect target to

first; with

false no document is read by its URI at all, and only what the host registered or loaded is served.

#ResolveDocument(String)

#ResolveDocument(String,Func<Uri,Boolean>)

with every HTTP redirect target passed to

first (see

).

#ResolveNamespace(String)

Resolves a namespace URI string to an interned

.

Parameters:

• namespaceUri — The namespace URI to intern.

Returns: The interned namespace identifier.

#ResolveNamespaceUri(PhoenixmlDb.Core.NamespaceId)

Resolves an interned

back to its URI string. Used by

for XML serialization.

Parameters:

• id — The namespace identifier.

Returns: The namespace URI, or null if the identifier is not known.

#ToLocalPath(String)

Converts a file:// URI to a local file path. Returns the original string for non-file URIs.

#TryResolveCollectionItems(String,Collections.Generic.List<Object>@)

Tries to resolve a collection by URI, returning the items if found. Supports both node and non-node (atomic value) collections per XQuery 3.1.

Parameters:

• uri — The collection URI, or null / empty string for the default collection.

• items — The resolved items, or null if the collection is not found.

Returns: true if the collection was found; false otherwise.

#Fields