Interface ArchiveRecordResult

Result of archiving a single record.

interface ArchiveRecordResult {
    BytesArchived: number;
    ErrorMessage?: string;
    Skipped?: boolean;
    StoragePath: string;
    Success: boolean;
}

Properties

BytesArchived: number

Number of bytes written to storage

ErrorMessage?: string

Error message if Success is false

Skipped?: boolean

True if the record was intentionally skipped (e.g., all fields already null)

StoragePath: string

Storage path where the archive document was written, or null on failure

Success: boolean

Whether the archive operation succeeded