PhoenixmlDb.Core 1.5.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package PhoenixmlDb.Core --version 1.5.0
                    
NuGet\Install-Package PhoenixmlDb.Core -Version 1.5.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="PhoenixmlDb.Core" Version="1.5.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="PhoenixmlDb.Core" Version="1.5.0" />
                    
Directory.Packages.props
<PackageReference Include="PhoenixmlDb.Core" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add PhoenixmlDb.Core --version 1.5.0
                    
#r "nuget: PhoenixmlDb.Core, 1.5.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package PhoenixmlDb.Core@1.5.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=PhoenixmlDb.Core&version=1.5.0
                    
Install as a Cake Addin
#tool nuget:?package=PhoenixmlDb.Core&version=1.5.0
                    
Install as a Cake Tool

PhoenixmlDb.Core

Core types, interfaces, and XDM (XQuery Data Model) implementation for PhoenixmlDb — a modern embedded XML/JSON document database for .NET.

What's in this package

  • Database interfaces — IDocumentDatabase, IContainer, IDocument for storing and retrieving XML/JSON documents
  • XDM node types — XdmElement, XdmAttribute, XdmDocument, etc. — the W3C XQuery Data Model
  • Transaction model — IReadTransaction, IWriteTransaction with MVCC snapshot isolation
  • Index configuration — path, value, full-text, and metadata indexes for fast queries
  • XML parser and serializer — parse XML into XDM trees and serialize back
  • Atomic value types — dates, times, durations, and other XSD types with correct semantics

When to use this package

Directly: If you're building a storage provider, query engine integration, or tooling that works with XDM types.

Indirectly: This package is a dependency of PhoenixmlDb.XQuery, PhoenixmlDb.Xslt, and the CLI tools. You typically don't reference it alone unless you need the core types without query/transform capabilities.

Quick example

using PhoenixmlDb.Core;
using PhoenixmlDb.Xdm.Parsing;

// Parse XML into an XDM tree
var parser = new XmlDocumentParser();
var result = parser.Parse("<order><item>Widget</item></order>");
var doc = result.Document;

// Navigate the tree
var root = doc.Children[0]; // <order> element
Console.WriteLine(root.StringValue); // "Widget"
Package Description
PhoenixmlDb.XQuery XQuery 4.0 query engine
PhoenixmlDb.Xslt XSLT 4.0 transformation engine
PhoenixmlDb.XQuery.Cli xquery command-line tool
PhoenixmlDb.Xslt.Cli xslt command-line tool

Documentation

Full documentation at phoenixml.dev

License

Apache 2.0

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net10.0

    • No dependencies.
  • net8.0

    • No dependencies.

NuGet packages (3)

Showing the top 3 NuGet packages that depend on PhoenixmlDb.Core:

Package Downloads
PhoenixmlDb.XQuery

XQuery 4.0 query engine for PhoenixmlDb

PhoenixmlDb.Xslt

XSLT 4.0 transformation engine for PhoenixmlDb

Phoenixml.Platform.Editor.Xml

XML/XSD vocabulary binding for Phoenixml.Platform — concrete IDocument and ITreeNodeProvider implementations against PhoenixmlDb.Core's XDM, XSD schema validation pipeline.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2.6.0 128 10/20/2026
2.5.0 301 10/13/2026
2.4.0 228 10/9/2026
2.3.0 106 10/8/2026
2.2.0 184 10/6/2026
2.1.0 185 10/5/2026
2.0.0 1,669 9/15/2026
1.7.0 953 9/11/2026
1.6.7 994 8/24/2026
1.6.6 203 8/23/2026
1.6.5 202 8/21/2026
1.6.0 179 8/7/2026
1.5.0 133 8/6/2026
1.4.0 123 8/4/2026
1.3.0 380 7/27/2026
1.2.2 313 7/9/2026
1.2.1 179 7/8/2026
1.2.0 346 6/28/2026
1.1.9 345 6/17/2026
1.1.8 226 6/14/2026
Loading failed

Metadata becomes namespace-qualified end to end. **Breaking**: the metadata surfaces on
`IContainer`, `IWriteTransaction` and `IDocument` change shape, as does `AddMetadataIndex` and the
persisted index-config format.

### Why this is breaking rather than additive

The old surface keyed metadata by a bare string and valued it as `object`. Two applications sharing
a database could not both use a name as ordinary as `status`, and — more seriously — the engine had
no single answer for what a metadata value *was*. A stored value was JSON; an indexed value was
typed XDM. Those are different comparisons, so adding an index could change which documents a query
returned, not merely how quickly it found them. That is not a defect an additive API can fix: the
two encodings had to stop existing, which means the surface that produced them had to go.

### The three-tier surface

Metadata names are now `XdmQName` and values `XdmValue`, exposed at three levels of explicitness:

```csharp
// local name, resolved against the container's default namespace
await container.SetMetadataAsync("invoice.xml", "status", "pending");

// typed descriptor — namespace and CLR type come from the property
await container.SetMetadataAsync("invoice.xml", DcTerms.Creator, "lucas");

// fully explicit
await container.SetMetadataAsync("invoice.xml", qname, XdmValue.From("application/xml"));
```

`ContainerOptions.DefaultMetadataNamespace` sets what unqualified names resolve to, defaulting to
`https://schemas.phoenixml.dev/2026/meta`. Set it to your own application namespace and a common
name such as `status` can no longer collide with another application's.

`GetAllMetadataAsync` returns a `MetadataCollection` rather than
`IReadOnlyDictionary<string, object>`, so a caller can finally separate a namespace from a local
name — the old shape handed back `"ns:name"` as one unsplittable string. `GetMetadataByNamespaceAsync`
is new, and is served by a cursor range over the namespace key prefix rather than by fetching all of
a document's metadata and filtering it.

`DocumentOptions.Metadata` is now `IReadOnlyDictionary<XdmQName, XdmValue>?`.

### Indexes are qualified too

`AddMetadataIndex` takes an `XdmQName`. An index that cannot say *which* `status` it covers is the
same collision in a different place, and — because the store keys by qualified name — a bare-named
index would answer for documents it does not describe. With one key model on both sides, declaring
an index is a pure performance decision.

The persisted index configuration records the namespace alongside the local name. A configuration
written by an earlier version is rejected with an explanatory error rather than reinterpreted:
defaulting the namespace would silently point an index at a different key than the store writes.

### Removed

`IContainer.SetIndexedValuesAsync` is deleted rather than ported. Its default interface
implementation returned a completed task for any implementation without indexing, so a caller could
not distinguish a successful write from a no-op; it also stored its values as a single JSON array
while indexing each element separately. Multi-valued metadata returns as a deliberate feature or
not at all.

### Notes

Two parameter names could not be used as intended: CA1716 rejects `property` and `namespace` on
virtual and interface members because they collide with reserved keywords in other .NET languages.
They are `descriptor` and `namespaceId`. Positional call sites are unaffected.