# AshR2RML v26.8.29 - Table of Contents

> W3C R2RML and RDF semantic mapping compiler for Ash Framework

## Pages

- [Home](readme.md)
- [License](mit.md)
- [AshR2RML Livebook](ash_r2rml.md)

- About AshR2RML
  - [Change Log](changelog.md)

## Modules

- AshR2RML
  - [AshR2RML](AshR2RML.md): Semantic mapping compiler between Ash resources and W3C R2RML.
  - [AshR2RML.Compiler](AshR2RML.Compiler.md): Ontology-first compiler for the admitted closed operational profile.
  - [AshR2RML.Ggen](AshR2RML.Ggen.md): ggen-facing deterministic compilation bundle.
  - [AshR2RML.Ingestion](AshR2RML.Ingestion.md): RDF/Turtle + SHACL ingestion adapter for the ontology-first compiler.
  - [AshR2RML.Mapping](AshR2RML.Mapping.md): Canonical public semantic mapping IR.
  - [AshR2RML.Policy](AshR2RML.Policy.md): Policy-aware semantic projection filter.
  - [AshR2RML.Resource](AshR2RML.Resource.md): Spark extension for Ash-first semantic mapping.

- Reactor
  - [AshR2RML.Reactor.CompileR2RML](AshR2RML.Reactor.CompileR2RML.md): Reactor Step for compiling Ash resources or semantic profiles into R2RML Turtle.
  - [AshR2RML.Reactor.Middleware.TelemetryLogger](AshR2RML.Reactor.Middleware.TelemetryLogger.md): Reactor middleware: structured lifecycle and step telemetry logging for the
AshR2RML pipeline. Emits real `:telemetry` events for OCEL v2 event capture.

  - [AshR2RML.Reactor.Pipeline](AshR2RML.Reactor.Pipeline.md): Full end-to-end Zach Daniel–style `Reactor` pipeline exercising every public
facet of AshR2RML through 6 named, module-backed steps
  - [AshR2RML.Reactor.Steps.ApplyPolicy](AshR2RML.Reactor.Steps.ApplyPolicy.md): Reactor step: apply actor-scoped Ash policy filtering to the mapping bundle.
  - [AshR2RML.Reactor.Steps.AttachProvenance](AshR2RML.Reactor.Steps.AttachProvenance.md): Reactor step: attach W3C PROV-O provenance predicate-object maps.
  - [AshR2RML.Reactor.Steps.CompileResources](AshR2RML.Reactor.Steps.CompileResources.md): Reactor step: compile a list of Ash resource modules into a normalized
`AshR2RML.Mapping.Bundle` via `AshR2RML.Compiler.compile_resources/1`.
  - [AshR2RML.Reactor.Steps.EvaluateDifferential](AshR2RML.Reactor.Steps.EvaluateDifferential.md): Reactor step: SPARQL behavioral differential evaluation.
  - [AshR2RML.Reactor.Steps.RenderTurtle](AshR2RML.Reactor.Steps.RenderTurtle.md): Reactor step: render the normalized mapping bundle into W3C R2RML Turtle.
  - [AshR2RML.Reactor.Steps.VerifyAlignment](AshR2RML.Reactor.Steps.VerifyAlignment.md): Reactor step: fail-closed schema alignment verification.

- Telemetry
  - [AshR2RML.Telemetry.FlyClient](AshR2RML.Telemetry.FlyClient.md): Telemetry and Fly Control Plane Client for AshR2RML.
  - [AshR2RML.Telemetry.OCEL2](AshR2RML.Telemetry.OCEL2.md): Formal IEEE/W3C Object-Centric Event Log (OCEL 2.0) Model, Serializer, Validator,
and Conformance Checking Engine.
Conforms to the formal OCEL 2.0 specification by Farhang, Park, and van der Aalst (2023).
  - [AshR2RML.Telemetry.OCEL2.ConformanceReport](AshR2RML.Telemetry.OCEL2.ConformanceReport.md): Comprehensive process conformance report evaluating trace fitness and anomaly detections.
  - [AshR2RML.Telemetry.OCEL2.Event](AshR2RML.Telemetry.OCEL2.Event.md): An Event in the OCEL 2.0 event log with qualified E2O and lifecycle state.
  - [AshR2RML.Telemetry.OCEL2.Log](AshR2RML.Telemetry.OCEL2.Log.md): A complete OCEL 2.0 Container holding events, objects, object types, and relationships.
  - [AshR2RML.Telemetry.OCEL2.Object](AshR2RML.Telemetry.OCEL2.Object.md): An Object instance in the OCEL 2.0 object catalog with static and time-varying attributes.
  - [AshR2RML.Telemetry.OCEL2.Relationship](AshR2RML.Telemetry.OCEL2.Relationship.md): An Object-to-Object (O2O) relationship in OCEL 2.0.
  - [AshR2RML.Telemetry.OcelAshEmitter](AshR2RML.Telemetry.OcelAshEmitter.md): Real Object-Centric Event Log (OCEL v2) event emission for every real Ash action,
Ash notification, and AshR2RML Reactor workflow execution step.

- Internals
  - [AshR2RML.Admission](AshR2RML.Admission.md): Admits a closed operational application profile into `AshR2RML.SemanticIR`.
  - [AshR2RML.CheatSheet](AshR2RML.CheatSheet.md): Generates cheat sheets and Markdown documentation for the `r2rml` Spark DSL extension.

  - [AshR2RML.Compilation](AshR2RML.Compilation.md): Evidence-bounded result of ontology-first semantic compilation.
  - [AshR2RML.CompilationReceipt](AshR2RML.CompilationReceipt.md): Identity and standing record for one deterministic semantic compilation.
  - [AshR2RML.DataLayer](AshR2RML.DataLayer.md): Automatic Data Layer Introspection helper for Ash resources.
  - [AshR2RML.Datatype.Registry](AshR2RML.Datatype.Registry.md): Loss-aware built-in and custom datatype correspondence.
  - [AshR2RML.DfCM](AshR2RML.DfCM.md): Degree-of-Freedom Calculus for Relationship Storage Topology Selection.
  - [AshR2RML.Formatter](AshR2RML.Formatter.md): Spark.Formatter plugin helper for AshR2RML DSL sections (`r2rml` and `sparql`).

  - [AshR2RML.Functions.GeofDistance](AshR2RML.Functions.GeofDistance.md): GeoSPARQL geof:distance spatial distance expression.
  - [AshR2RML.Functions.GeofSfIntersects](AshR2RML.Functions.GeofSfIntersects.md): GeoSPARQL geof:sfIntersects spatial intersection boolean expression.
  - [AshR2RML.Functions.VecCosineSimilarity](AshR2RML.Functions.VecCosineSimilarity.md): Vector similarity expression compiling to pgvector cosine distance.
  - [AshR2RML.Ggen.TTL](AshR2RML.Ggen.TTL.md): Deterministic ggen TTL projection manufactured from canonical AshR2RML mappings.
  - [AshR2RML.GgenRuntime](AshR2RML.GgenRuntime.md): Manufactures deterministic runtime-integration input for GGen without actuation.
  - [AshR2RML.GgenRuntime.Audit](AshR2RML.GgenRuntime.Audit.md): Audit contract binding actor, exact subject, action, and receipt.
  - [AshR2RML.GgenRuntime.Authority](AshR2RML.GgenRuntime.Authority.md): Fail-closed authority admission for generated runtime seams.
  - [AshR2RML.GgenRuntime.CacheContract](AshR2RML.GgenRuntime.CacheContract.md): Cache admission that makes consistency and invalidation explicit.
  - [AshR2RML.GgenRuntime.Concurrency](AshR2RML.GgenRuntime.Concurrency.md): Version-precondition and optimistic-lock contract admission.
  - [AshR2RML.GgenRuntime.Config](AshR2RML.GgenRuntime.Config.md): Content-addressed dependency and runtime configuration admission.
  - [AshR2RML.GgenRuntime.DataContract](AshR2RML.GgenRuntime.DataContract.md): Input/output schema and sanitization contract for generated runtime boundaries.
  - [AshR2RML.GgenRuntime.Deadline](AshR2RML.GgenRuntime.Deadline.md): Deadline/cancellation admission for bounded runtime work.
  - [AshR2RML.GgenRuntime.DomainError](AshR2RML.GgenRuntime.DomainError.md): Typed domain-error projection preserving refusal and retry semantics.
  - [AshR2RML.GgenRuntime.Eventing](AshR2RML.GgenRuntime.Eventing.md): Event-envelope admission with causation, correlation, OCEL, and receipt identity.
  - [AshR2RML.GgenRuntime.FaultIsolation](AshR2RML.GgenRuntime.FaultIsolation.md): Bounded circuit-breaker and bulkhead contracts for generated runtime seams.
  - [AshR2RML.GgenRuntime.FullIntegration](AshR2RML.GgenRuntime.FullIntegration.md): Full consumer admission for the Marketplace Ash runtime integration contract pack.
  - [AshR2RML.GgenRuntime.Idempotency](AshR2RML.GgenRuntime.Idempotency.md): Idempotency admission bound to an exact receipt namespace.
  - [AshR2RML.GgenRuntime.Integration](AshR2RML.GgenRuntime.Integration.md): Strict composition of the GGen runtime integration contract surfaces.
  - [AshR2RML.GgenRuntime.Isolation](AshR2RML.GgenRuntime.Isolation.md): Explicit tenant and transaction isolation contract.
  - [AshR2RML.GgenRuntime.Lifecycle](AshR2RML.GgenRuntime.Lifecycle.md): Feature-flag and deprecation admission for generated runtime interfaces.
  - [AshR2RML.GgenRuntime.Observability](AshR2RML.GgenRuntime.Observability.md): Content-addressed observability contract for runtime integrations.
  - [AshR2RML.GgenRuntime.Persistence](AshR2RML.GgenRuntime.Persistence.md): Persistence contract that keeps Ash data-layer ownership explicit.
  - [AshR2RML.GgenRuntime.RateLimit](AshR2RML.GgenRuntime.RateLimit.md): Bounded rate-limit contract with an explicit partition key.
  - [AshR2RML.GgenRuntime.ReactorContract](AshR2RML.GgenRuntime.ReactorContract.md): Ash.Reactor step and compensation admission without inventing actuation authority.
  - [AshR2RML.GgenRuntime.Replay](AshR2RML.GgenRuntime.Replay.md): Replay admission requiring exact contract and receipt identities.
  - [AshR2RML.GgenRuntime.Resilience](AshR2RML.GgenRuntime.Resilience.md): Bounded retry/timeout/cancellation policy for generated runtime integrations.
  - [AshR2RML.GgenRuntime.Security](AshR2RML.GgenRuntime.Security.md): Explicit actor, tenant, and policy context required by generated runtime seams.
  - [AshR2RML.GgenRuntime.Subject](AshR2RML.GgenRuntime.Subject.md): Exact repository subject admission for GGen-manufactured runtime contracts.
  - [AshR2RML.GgenRuntime.Transport](AshR2RML.GgenRuntime.Transport.md): API/CLI transport contract with bounded pagination, batching, and streaming.
  - [AshR2RML.Introspection](AshR2RML.Introspection.md): Data-layer-aware Ash introspection used before semantic mapping serialization.
  - [AshR2RML.Introspection.Manifest](AshR2RML.Introspection.Manifest.md): Thin, real wrapper around `Ash.Info.manifest/1` (Ash >= 3.25) for tooling
and ggen-pack generation that needs a resource/field/relationship lookup
keyed by module, rather than re-deriving that shape via ad hoc
`Ash.Resource.Info.*` calls.
  - [AshR2RML.JSONLD](AshR2RML.JSONLD.md): JSON-LD 1.1 projection and ingestion through JSON-LD.ex.
  - [AshR2RML.Mapping.Bundle](AshR2RML.Mapping.Bundle.md): Dependency-closed set of normalized resource mappings.
  - [AshR2RML.Mapping.Changeset](AshR2RML.Mapping.Changeset.md): Structured `add`/`update`/`replace`/`remove` diff between two `RDF.Graph`
snapshots of a rendered mapping (e.g. two successive R2RML Turtle renders of
the same `AshR2RML.Mapping.Resource`, or two successive
`AshR2RML.OBDA.InMemory.materialize/3` snapshots).
  - [AshR2RML.Mapping.Datatype](AshR2RML.Mapping.Datatype.md): Loss-aware correspondence between Ash, relational storage, and RDF datatypes.
  - [AshR2RML.Mapping.GraphMap](AshR2RML.Mapping.GraphMap.md): Named-graph placement for a subject or predicate-object mapping.
  - [AshR2RML.Mapping.JoinCondition](AshR2RML.Mapping.JoinCondition.md): Explicit child/parent join used by an R2RML reference object map.
  - [AshR2RML.Mapping.LogicalTable](AshR2RML.Mapping.LogicalTable.md): Exactly one relational logical source: table/view name or deterministic SQL query.
  - [AshR2RML.Mapping.ObjectMap](AshR2RML.Mapping.ObjectMap.md): Scalar RDF object manufacture for one predicate-object mapping.
  - [AshR2RML.Mapping.PredicateObjectMap](AshR2RML.Mapping.PredicateObjectMap.md): RDF datatype-property mapping normalized before R2RML serialization.
  - [AshR2RML.Mapping.Provenance](AshR2RML.Mapping.Provenance.md): Pure semantic plumbing helper for W3C PROV-O provenance assertions.
  - [AshR2RML.Mapping.ReferenceObjectMap](AshR2RML.Mapping.ReferenceObjectMap.md): RDF object-property mapping to a parent triples map through explicit joins.
  - [AshR2RML.Mapping.Resource](AshR2RML.Mapping.Resource.md): Canonical normalized mapping for one Ash resource / R2RML triples map.
  - [AshR2RML.Mapping.SubjectMap](AshR2RML.Mapping.SubjectMap.md): Semantic RDF subject manufacture, independent of database identity.
  - [AshR2RML.OBDA.Adapter](AshR2RML.OBDA.Adapter.md): Behaviour for OBDA query engines, so a caller can dispatch to whichever
engine a given mapping/resource actually needs without hand-checking which
concrete module to call.
  - [AshR2RML.OBDA.Adapter.InMemoryConfig](AshR2RML.OBDA.Adapter.InMemoryConfig.md): `AshR2RML.OBDA.Adapter` config for the in-process `AshR2RML.OBDA.InMemory`
adapter. Wraps one or more `{ash_resource, mapping_resource}` specs so
`AshR2RML.OBDA.Adapter.dispatch/3` can route to `query/4` (single resource)
or `query_many/3` (multiple resources with relationships) uniformly.

  - [AshR2RML.OBDA.Adapter.OntopConfig](AshR2RML.OBDA.Adapter.OntopConfig.md): `AshR2RML.OBDA.Adapter` config for the real Ontop CLI adapter. Wraps the
keyword/map options `AshR2RML.OBDA.Ontop.query/1` already accepts
(`:mapping_path`, `:query_path`, `:properties_path`, etc.) in a typed struct
so `AshR2RML.OBDA.Adapter.dispatch/3` can pattern-match on it.

  - [AshR2RML.OBDA.InMemory](AshR2RML.OBDA.InMemory.md): In-process OBDA counterpart to `AshR2RML.OBDA.Ontop`, for any Ash data layer Ontop
cannot reach.
  - [AshR2RML.OBDA.Observation](AshR2RML.OBDA.Observation.md): Operator-invoked observation of one external OBDA query execution.
  - [AshR2RML.OBDA.Ontop](AshR2RML.OBDA.Ontop.md): Operator-invoked adapter for Ontop's `query` CLI.
  - [AshR2RML.Parity](AshR2RML.Parity.md): Deterministic semantic-result comparator for side-by-side cutover evidence.
  - [AshR2RML.ParityReceipt](AshR2RML.ParityReceipt.md): Receipt for an observed result-equivalence comparison.
  - [AshR2RML.R2RML](AshR2RML.R2RML.md): Deterministic W3C R2RML renderer over `AshR2RML.Mapping.Bundle`.
  - [AshR2RML.RDF.GraphAlgebra](AshR2RML.RDF.GraphAlgebra.md): Pure `RDF.Graph` algebra: add/delete/cleanup/intersection over triple sets.
  - [AshR2RML.Refusal](AshR2RML.Refusal.md): Typed fail-closed result for expected semantic mapping failures.
  - [AshR2RML.Resource.Info](AshR2RML.Resource.Info.md): Public introspection over the normalized mapping IR.
  - [AshR2RML.SHACL](AshR2RML.SHACL.md): SHACL shapes renderer.
  - [AshR2RML.SPARQL](AshR2RML.SPARQL.md): DfCM SPARQL execution calculus.
  - [AshR2RML.SPARQL.Differential](AshR2RML.SPARQL.Differential.md): Compares multiple observed SPARQL execution topologies without privileging one.
  - [AshR2RML.SPARQL.DifferentialReceipt](AshR2RML.SPARQL.DifferentialReceipt.md): Stable multi-engine SPARQL semantic-differential receipt.
  - [AshR2RML.SPARQL.Local](AshR2RML.SPARQL.Local.md): Explicit SPARQL.ex execution against an RDF.ex data structure.
  - [AshR2RML.SPARQL.Observation](AshR2RML.SPARQL.Observation.md): Evidence-bounded observation from one selected SPARQL execution strategy.
  - [AshR2RML.SPARQL.Plan](AshR2RML.SPARQL.Plan.md): DfCM execution plan preserving all currently lawful SPARQL execution candidates.
  - [AshR2RML.SPARQL.Protocol](AshR2RML.SPARQL.Protocol.md): Read-only W3C SPARQL Protocol execution through SPARQL.Client.
  - [AshR2RML.SPARQL.Query](AshR2RML.SPARQL.Query.md): Admitted SPARQL query identity.
  - [AshR2RML.SPARQL.Result](AshR2RML.SPARQL.Result.md): Normalizes RDF-Elixir SPARQL results into deterministic parity rows.
  - [AshR2RML.Security](AshR2RML.Security.md): Closes a specific, demonstrated gap structurally rather than only documenting it: Ash field
policies are enforced only on Ash-mediated reads (`AshR2RML.OBDA.InMemory` calling
`Ash.read!/2`). Ontop connects to a relational data layer directly over JDBC and has no
concept of an Ash actor at all, so a `field_policy`-protected attribute mapped into R2RML
would be returned in full to any SPARQL caller once deployed -- confirmed against a live
Postgres + Ontop stack, not assumed.
  - [AshR2RML.Semantic.Ash](AshR2RML.Semantic.Ash.md): Manufactures Ash resource source from the admitted semantic IR.
  - [AshR2RML.Semantic.Ecto](AshR2RML.Semantic.Ecto.md): Manufactures an Ecto migration source projection from `AshR2RML.SemanticIR`.
  - [AshR2RML.Semantic.R2RML](AshR2RML.Semantic.R2RML.md): R2RML renderer whose sole source is the ontology-first semantic IR.
  - [AshR2RML.Semantic.SHACL](AshR2RML.Semantic.SHACL.md): Canonical closed operational SHACL projection from semantic IR.
  - [AshR2RML.Semantic.SQL](AshR2RML.Semantic.SQL.md): Manufactures deterministic PostgreSQL DDL from the admitted semantic IR.
  - [AshR2RML.SemanticAdapter](AshR2RML.SemanticAdapter.md): Lowers ontology-first SemanticIR into the canonical public mapping IR.
  - [AshR2RML.SemanticIR](AshR2RML.SemanticIR.md): Canonical ontology-first compilation object.
  - [AshR2RML.SemanticIR.Action](AshR2RML.SemanticIR.Action.md): Verb projection. Actions are not manufactured as RDF classes by default.
  - [AshR2RML.SemanticIR.Attribute](AshR2RML.SemanticIR.Attribute.md): One admitted datatype-property projection across semantic, Ash, and SQL worlds.
  - [AshR2RML.SemanticIR.Identity](AshR2RML.SemanticIR.Identity.md): Semantic identity used by Ash, SQL uniqueness, and rr:template admission.
  - [AshR2RML.SemanticIR.Policy](AshR2RML.SemanticIR.Policy.md): Authorization/governance projection aligned separately from ontology classes.
  - [AshR2RML.SemanticIR.Relationship](AshR2RML.SemanticIR.Relationship.md): Admitted object-property projection.
  - [AshR2RML.SemanticIR.Resource](AshR2RML.SemanticIR.Resource.md): Closed operational projection of an admitted class/shape pair.
  - [AshR2RML.SemanticType](AshR2RML.SemanticType.md): Canonical admitted value-space projection.
  - [AshR2RML.SemanticType.DfCM](AshR2RML.SemanticType.DfCM.md): DfCM representation calculus for semantic values.
  - [AshR2RML.SemanticType.Diff](AshR2RML.SemanticType.Diff.md): Observed-vs-admitted semantic type drift without implicit repair.
  - [AshR2RML.SemanticType.Plan](AshR2RML.SemanticType.Plan.md): Content-addressed SELECT/CONSTRUCT plan over admitted semantic types.
  - [AshR2RML.SemanticType.Provider](AshR2RML.SemanticType.Provider.md): Extension point for public ontology/application-profile value spaces.
  - [AshR2RML.SemanticTypes](AshR2RML.SemanticTypes.md): Pure SELECT/CONSTRUCT compiler for public-ontology semantic value spaces.
  - [AshR2RML.SemanticTypes.Generator](AshR2RML.SemanticTypes.Generator.md): Deterministic projection renderer for semantic type plans.
  - [AshR2RML.SemanticTypes.GeoSPARQL](AshR2RML.SemanticTypes.GeoSPARQL.md): OGC GeoSPARQL datatype provider.
  - [AshR2RML.SemanticTypes.OWLTime](AshR2RML.SemanticTypes.OWLTime.md): OWL-Time temporal entity provider preserving literal/resource alternatives.
  - [AshR2RML.SemanticTypes.QUDT](AshR2RML.SemanticTypes.QUDT.md): QUDT quantity/unit provider.
  - [AshR2RML.SemanticTypes.RDF](AshR2RML.SemanticTypes.RDF.md): RDF core datatype/value provider.
  - [AshR2RML.SemanticTypes.Resource](AshR2RML.SemanticTypes.Resource.md): Optional Spark extension for application-profile semantic type selections.
  - [AshR2RML.SemanticTypes.Resource.Info](AshR2RML.SemanticTypes.Resource.Info.md): Read-only Spark introspection for a resource's admitted semantic type plan.
  - [AshR2RML.SemanticTypes.SKOS](AshR2RML.SemanticTypes.SKOS.md): SKOS controlled-concept provider.
  - [AshR2RML.SemanticTypes.XSD](AshR2RML.SemanticTypes.XSD.md): XML Schema datatype provider.
  - [AshR2RML.Type](AshR2RML.Type.md): Semantic contract layered on top of `Ash.Type`.
  - [AshR2RML.Types.Concept](AshR2RML.Types.Concept.md): SKOS concept identity represented by canonical IRI plus optional scheme IRI.
  - [AshR2RML.Types.IRI](AshR2RML.Types.IRI.md): Ash type for an RDF IRI value.
  - [AshR2RML.Types.LangString](AshR2RML.Types.LangString.md): RDF language-tagged string preserving lexical value and BCP47-like tag.
  - [AshR2RML.Types.Quantity](AshR2RML.Types.Quantity.md): QUDT quantity value preserving numeric value, unit IRI, and optional quantity-kind IRI.
  - [AshR2RML.Types.TemporalInterval](AshR2RML.Types.TemporalInterval.md): OWL-Time interval value with explicit beginning/end projections.
  - [AshR2RML.VerifyMapping.Alignment](AshR2RML.VerifyMapping.Alignment.md): Fail-closed schema alignment verifier plumbing.

## Mix Tasks

- Internals
  - [mix ash_r2rml.gen.semantic_types](Mix.Tasks.AshR2rml.Gen.SemanticTypes.md)
  - [mix ash_r2rml.generate_docs](Mix.Tasks.AshR2rml.GenerateDocs.md): Generates `documentation/reference/dsl_cheatsheet.md` using `Spark.CheatSheet`.
  - [mix ash_r2rml.install](Mix.Tasks.AshR2rml.Install.md): Automated Igniter installer task for AshR2RML.
  - [mix ash_r2rml.types.check](Mix.Tasks.AshR2rml.Types.Check.md)
  - [mix ash_r2rml.types.diff](Mix.Tasks.AshR2rml.Types.Diff.md)
  - [mix ash_r2rml.types.inspect](Mix.Tasks.AshR2rml.Types.Inspect.md)
  - [mix ash_r2rml.types.manifest](Mix.Tasks.AshR2rml.Types.Manifest.md)
  - [mix ash_r2rml.types.plan](Mix.Tasks.AshR2rml.Types.Plan.md)
  - [mix ash_r2rml.types.sync](Mix.Tasks.AshR2rml.Types.Sync.md)
  - [mix ash_r2rml.types.verify](Mix.Tasks.AshR2rml.Types.Verify.md)

