`nexyron.snapshot_register`

Generic Description

nexyron.snapshot_register register or replace one snapshot definition

CALL nexyron.procedures()
YIELD name, description, parameters, output_columns
WHERE name = 'nexyron.snapshot_register'
RETURN name, description, parameters, output_columns

Abstraction-platform registry procedures create, list, read, and inspect named contracts such as abstractions, features, datasets, snapshots, models, policies, interventions, scenarios, and split policies.

Consumer-Level Explanation

This procedure is part of the abstraction catalog contract layer. Use it when you want to define or inspect named abstraction assets that other runtime procedures will consume later.

Parameters

• name: Snapshot definition name Required.
• cascade_refresh: When true, immediately refresh materialized snapshots with this name and dependent materialized datasets Optional.

Output Columns

• name
• subject_type
• subject_abstraction
• grain
• as_of_mode
• frequency
• features
• include_active_features
• tags

Example Contract Prerequisite

The executable Cypher blocks on this page query nexyron.procedures() so they work in an empty database and stay synchronized with the live procedure registry. A direct CALL nexyron.snapshot_register(...) requires the named abstraction contracts, artifacts, features, snapshots, datasets, models, or policies referenced by that call to exist first; otherwise the runtime correctly fails with an unknown-contract error rather than inventing state.

Conceptual Explanation

The important thing about nexyron.snapshot_register is that it stays inside the same Cypher and abstraction-contract runtime as the rest of Nexyron. That means it can compose with named abstractions, time-aware snapshot contracts, document-style payloads, graph-native identity, and later model or policy layers without forcing you to move into a separate tool first.

More Detailed Explanation

In practical queries, start by deciding the row grain you want after the call: one row per node, one row per path, one row per registry object, one row per artifact, or one row per summary. Then keep that grain explicit with YIELD and named projections. That is the difference between a useful planner-facing example and a vague call that downstream tooling cannot safely compose. For contract-driven abstraction procedures, the executable examples on these pages intentionally inspect procedure metadata unless the required named artifacts are created in the same example.

Advanced Example

CALL nexyron.procedures()
YIELD name, parameters, output_columns
WHERE name = 'nexyron.snapshot_register'
RETURN name,
       [p IN parameters | p.name] AS parameter_names,
       output_columns
ORDER BY name

Real Use Cases

• Register reusable member-retention snapshot contracts once, then let datasets, models, and policies reference those names instead of duplicating raw Cypher in every workflow.
• Keep a database-specific daily or hourly snapshot definition that includes every active feature attached to the selected subject abstraction by setting include_active_features: true.
• Keep admin and product teams aligned around one shared abstraction contract for members, households, facilities, interventions, and churn labels during quarterly retraining cycles.

Real Limitations And Tradeoffs

• This surface is contract-driven. If the registered feature, snapshot, dataset, model, or policy definition is weak, the procedure will faithfully execute that weak contract rather than silently repairing it.
• Catalog procedures define or expose metadata. Build and materialization procedures such as nexyron.snapshot_build and nexyron.snapshot_materialize perform the actual point-in-time feature assembly.
• include_active_features is intentionally broad. Draft or inactive features are excluded, but every active feature for the selected subject type and abstraction is eligible, so teams should mark experimental features inactive until they are safe for snapshot generation.