Document Checkpointing

PSPDFKit automatically saves annotations at certain trigger events. This mechanism works well, however there's still the chance to lose data if the device restarts, runs out of battery of your application crashes before a save completes.

With Document Checkpointing, PSPDFKit offers a checkpointing mode that works in the background, offering an effective crash recovery mechanism to restore unsaved changes. This is an advanced feature and disabled by default, as it requires some configuration to work effectively.

ℹ️ Note: PSPDFKit Instant stores annotations in a database and synchronizes with your PSPDFKit Server as soon as a connection is available, which greatly reduces the chances of data loss if the app terminates suddenly. No checkpointing or other custom setup is needed. Read more in our Instant Offline Support guide.

Understanding Document Checkpoints

A checkpoint contains all the unsaved data of a document. Let's call this the "dirty" data. This data is temporary and persisted into the document when #saveIfModifiedAsync() is called. With document checkpoints, this dirty data can be continually saved to a separate checkpoint file, and in the event of a crash, be restored to the document.

Checkpoints are managed by the PdfDocumentCheckpointer instance of your PdfDocument. To retrieve the checkpointer, call #getCheckpointer() on your document. To control the frequency at which checkpoints are written, you can set a PdfDocumentCheckpointingStrategy on the checkpointer using #setStrategy().

Checkpointing strategies

The checkpointing strategy defines the frequency at which checkpoints are created. There are three different checkpointing strategies available:

For most use cases, PdfDocumentCheckpointingStrategy.TIMED is a good option and does not affect performance by any significant amount.

Loading A Saved Checkpoint

A previously saved checkpoint will be loaded automatically if found.

It is important to note that while the document will content any previously unsaved objects saved in the checkpoint, the loaded changes are not saved to the document. To do this, you must still call #saveIfModifiedAsync(). This will cause the data from the checkpoint file to be written into the document, after which the checkpoint will be deleted from disk by the PdfDocumentCheckpointer.

Additional Information

Supported Document Types

PdfDocuments that are backed by more than one provider are not supported by document checkpoints currently. Documents that are not backed by a file (custom data provider) work well checkpointing, as long as certain care is taken with regards to their UID. Having checkpoints enabled on a document that uses a custom UID, one must be sure that the UID is unique to that document, since the PdfDocumentCheckpointer uses the UID as a part of the checkpoint's file name. Opening multiple instances of a document with the same UID, and making changes to them while they have checkpointing enabled is not supported and will result in undefined behaviour.

Checkpoint Location

The checkpoints are stored in PSPDFDocumentCheckpoints folder in app internal storage (more info). You do not have to manage this manually since each PdfDocumentCheckpointer will always delete the document's previous checkpoint before saving the new one. Additionally, the directory in which the checkpoints are stored is cleaned up by removing any checkpoints that are longer than a week old. The checkpoints are not shared in any way and cannot be exported. Furthermore all the checkpoints can be deleted at any time by PdfDocumentCheckpointer#deleteAllCheckpoints().

Performance

There are two things to consider with Document Checkpointing in terms of performance:

  • Saving: Depending on the strategy, the PdfDocumentCheckpointer saves checkpoints to the location specified above on background thread. This should not affect your application's performance in any meaningful way.
  • Loading: When loading the checkpoints as specified above, the loading of a document may take a little longer than usual since that is when the document is parsed.