PhoenixmlDb.Core

IDocumentDatabase

Root entry point for XmlDb database operations.

#IDocumentDatabase

Namespace: PhoenixmlDb.Core

Root entry point for XmlDb database operations.

#Properties

Name Description
Path Gets the database path.
Statistics Gets database statistics.

#Methods

#BeginRead

Begins a read-only transaction.

#BeginWriteAsync(Threading.CancellationToken)

Begins a read-write transaction.

Only one write transaction can be active at a time. Additional calls will block until the current write transaction completes.

#BeginWriteAsync(TimeSpan,Threading.CancellationToken)

Begins a read-write transaction with a timeout.

#CreateContainerAsync(String,Action<PhoenixmlDb.Core.ContainerOptions>,Threading.CancellationToken)

Creates a new container with the specified configuration.

Parameters:

  • name — Container name (must be unique).

  • configure — Optional configuration action.

  • cancellationToken — Cancellation token.

Returns: The created container.

#DeleteContainerAsync(String,Threading.CancellationToken)

Deletes a container and all its contents.

#FlushAsync(Threading.CancellationToken)

Flushes any buffered data to disk.

#ListContainersAsync(Threading.CancellationToken)

Lists all containers.

#OpenContainerAsync(String,Threading.CancellationToken)

Opens an existing container.

Parameters:

  • name — Container name.

  • cancellationToken — Cancellation token.

Returns: The container, or null if not found.

#OpenOrCreateContainerAsync(String,Action<PhoenixmlDb.Core.ContainerOptions>,Threading.CancellationToken)

Opens a container, creating it if it doesn't exist.