PhoenixmlDb.Core
DocumentId
A lightweight, strongly-typed identifier for a document within a container.
#DocumentId
Namespace: PhoenixmlDb.Core
A lightweight, strongly-typed identifier for a document within a container.
DocumentId is a readonly record struct wrapping an unsigned 64-bit integer, providing type safety so that document IDs cannot be accidentally passed where a ContainerId or NodeId is expected.
Document IDs are assigned by the database when a document is stored and are obtained from IDocument.Id or DocumentInfo.Id. They remain stable across updates to the same document name and are unique within a container.
The DocumentId.None value (0) serves as the null equivalent — it represents "no document" and is never assigned to a real document.
#Constructors
##ctor(UInt64)
A lightweight, strongly-typed identifier for a document within a container.
DocumentId is a readonly record struct wrapping an unsigned 64-bit integer, providing type safety so that document IDs cannot be accidentally passed where a ContainerId or NodeId is expected.
Document IDs are assigned by the database when a document is stored and are obtained from IDocument.Id or DocumentInfo.Id. They remain stable across updates to the same document name and are unique within a container.
The DocumentId.None value (0) serves as the null equivalent — it represents "no document" and is never assigned to a real document.
See also: IDocument.Id, ContainerId
#Properties
| Name | Description |
|---|---|
None
|
The null/empty document ID. Never assigned to a real document. |