PhoenixmlDb.Core

ContainerOptions

Configuration options for an , controlling indexing, namespace bindings, validation, and whitespace handling.

#ContainerOptions

Namespace: PhoenixmlDb.Core

Configuration options for an

, controlling indexing, namespace bindings, validation, and whitespace handling.

ContainerOptions is passed to IDocumentDatabase.CreateContainerAsync or IDocumentDatabase.OpenOrCreateContainerAsync via a configuration action. The options are applied at container creation time and govern how documents are stored, validated, and indexed.

The most important property is ContainerOptions.Indexes, which provides a fluent API for defining the indexes that accelerate XQuery queries. Indexes should be configured before documents are added — existing documents are not retroactively indexed when new index definitions are added later.

#Example

var container = await db.CreateContainerAsync("products", opts =>
{
    // Index product IDs for fast lookup
    opts.Indexes
        .AddPathIndex("//product/@id")
        .AddValueIndex("//product/price", XdmValueType.XdmDecimal)
        .AddFullTextIndex("//product/description")
        .AddMetadataIndex("category", XdmValueType.XdmString);

    // Register namespaces so queries don't need to declare them
    opts.DefaultNamespaces.Add("p", "http://example.com/products");

    // Validate all incoming documents
    opts.ValidationMode = ValidationMode.WellFormed;
});
                                  

#Properties