datagraphs.LoadResult

class documentation

class LoadResult:

The outcome of Gateway.load_data.

Instance Variable	`class_errors`	Per class, the error that stopped its file being loaded at all (e.g. invalid JSON or a malformed entity `id`).
Instance Variable	`failed`	Per class, the entities that were not written and why.
Instance Variable	`loaded`	The number of entities confirmed as written.
Instance Variable	`skipped`	The number of classes not loaded because they had no data file, an empty one, or (for a single requested class) no dataset.
Instance Variable	`timed_out`	Per class, the IDs of entities whose write timed out and may or may not have completed: verify with a read, or reload them.
Property	`failed_count`	The total number of entities that were not written.
Property	`ok`	True when every entity found was confirmed as written.
Property	`timed_out_count`	The total number of entities whose write timed out.

class_errors: dict[str, str] = ¶

Per class, the error that stopped its file being loaded at all (e.g. invalid JSON or a malformed entity id).

failed: dict[str, list[FailedWrite]] = ¶

Per class, the entities that were not written and why.

loaded: int = ¶

The number of entities confirmed as written.

skipped: int = ¶

The number of classes not loaded because they had no data file, an empty one, or (for a single requested class) no dataset.

timed_out: dict[str, list[str | None]] = ¶

Per class, the IDs of entities whose write timed out and may or may not have completed: verify with a read, or reload them.

@property

failed_count: int = ¶

The total number of entities that were not written.

@property

ok: bool = ¶

True when every entity found was confirmed as written.

@property

timed_out_count: int = ¶

The total number of entities whose write timed out.