Skip to main content
Rust4PM

Blueprint

A declarative mapping from relational rows to an OCEL.

Carries no connection details and no schema snapshot: both are supplied by the caller, which
keeps a blueprint portable, shareable and free of secrets.
Used as Input

5

functions accept this type

Used as Output

0

functions return this type

Type Definition

1298 nested items
Blueprint— A declarative mapping from relational rows to an OCEL.
id_rendering:IdRendering— How entity ids are rendered, for events and objects alike.
variant 1:"raw"— Use the id expression's value verbatim.
variant 2:"type-prefixed"— Prefix the id with its type name, so ids from different types cannot collide.
mappings*:Vec<MappingEntry>— The mappings.
nodes*:Vec<Node3>— The row graph.
on_duplicate_object:DuplicateObjectPolicy— What to do when an object id is produced more than once.
variant 1:"first-wins"— Keep the first, and count the rest as deduplicated rather than lost.
variant 2:"error"— Record an error.
on_missing_endpoint:MissingEndpointPolicy— What to do when a relation names an entity that does not exist.
variant 1:"drop"— Skip the relation.
variant 2:"create"— Create the object. Requires the endpoint to declare its type.
variant 3:"error"— Record an error.
version*:u32— Schema version. Checked against super::MODEL_VERSION during validation.

Example JSON Value

json
{
  "mappings": [
    {
      "type": "single"
    }
  ],
  "nodes": [
    {
      "id": "893f8ab9",
      "op": {
        "source_id": "example",
        "table": "example",
        "type": "source"
      }
    }
  ],
  "version": 1
}

Functions Accepting This Type(5)