liveBook · Manning

Export failure

As explained in API Design Patterns

An export failure is an unsuccessful attempt to read API resources or transport and write their data to external storage.

An export failure occurs when an API cannot read resources or cannot transport and write their data to external storage. Retrying is generally safe because each export attempt is independent. section 23.3.7

Handle export failures with these practical rules:

  • Expect a later attempt to produce different data, especially when users are changing a volatile dataset concurrently. section 23.3.7
  • Do not treat a failed export as a consistent snapshot; exported data may already be a smear of resources. section 23.3.7
  • Generally leave data from the failed attempt in place rather than deleting it automatically; manual cleanup can follow. section 23.3.7

Retrying a volatile export

An export reads API resources while concurrent users modify them, then fails while writing raw bytes to external storage. Retry the export, but expect different results and preserve the earlier partial data for later cleanup. section 23.3.7

How API Design Patterns covers it

How deep it goes
Explains retry safety, changing results, consistency limits, and cleanup decisions without detailing implementation mechanics.
Examples
Uses concurrent resource changes and a failed raw-byte write to external storage as the central scenario.
What it assumes
Assumes familiarity with API resources, exporting, external storage, and data consistency.
What you can do after
Operate exports by retrying failures, accepting changed results, and retaining failed-attempt data for cleanup.
How it connects
Connects exports with retries, external storage, API resources, consistency, and concurrent users.

Related concepts

This explainer was generated by Manning's knowledge graph from the text of API Design Patterns. The section links point to the parts of the book it draws on.