Skip to main content

What you’re building

A version is a recoverable checkpoint of a saved diagram, conceptual model or artifact. Certifying one version marks it as the snapshot teammates should generate from. Three things stay distinct: Use versions when you want to freeze a known-good model, recover after an edit, or generate a data model or DDL from a specific snapshot instead of the live draft.

Open Versions

  1. Open a saved diagram, conceptual model or artifact.
  2. Click Versions in the header.
You can also hover the diagram or artifact in Diagrams and choose Versions from its ⋯ menu. For a conceptual model, open Concepts in the sidebar and choose Versions from the model’s ⋯ menu under Conceptual models. Either way, the item opens with Versions beside it. Versions lists Working draft at the top, then saved versions newest first. Use Filter versions… to search by name, author, or date. If you see No version history here (Switch to a diagram, conceptual model, document, or code file to browse its versions), open a tab that holds one of those. A new diagram or artifact shows its versions once it has been saved.

Save a version

  1. Open Versions.
  2. Click New version. If you see No versions yet, click Create your first version instead.
  3. Optionally type a name in Name this version. Leave it blank to number the version automatically (Version 1, Version 2, and so on).
  4. Click Save version, or press Enter. Cancel or Esc discards the name field without saving.
You see Version saved. Working draft then shows Matches Version 1 (the name of the version it matches), and New version stays unavailable until the draft changes again (The draft already matches the latest version). After you edit, the draft shows Active changes since Version 1. If the item is not saved yet, you see Save this artifact before saving a version.

Preview a version

  1. Click a version in the list. Its row shows Viewing.
  2. The tab shows that version read-only, with a bar at the bottom naming the version and reading Read-only preview.
  3. Click Back to draft, or click Working draft in the list, to return to the editable copy.
Preview does not change the draft. Diagrams, conceptual models and artifacts each open as a read-only snapshot.

Compare with your working draft

Diagrams and conceptual models can show a version beside the draft.
  1. Preview a version.
  2. Click Compare in the bottom bar.
  3. Working draft appears on the left and the version on the right, each with its own layout. The bar reads Read-only · Comparing with your working draft.
  4. Click Exit compare to go back to the single preview, or Back to draft to leave the preview.
Neither side can be edited while you compare.

Certify a version

Certification tells others which snapshot to build from. Only one version can be certified at a time.
  1. Open the version’s ⋯ menu.
  2. Click Mark as certified.
  3. In Certify that version, confirm: Certification marks the version teammates should build from. Only one version can hold it, so it moves off whichever version has it now.
  4. Click Mark as certified.
You see that the version is now the certified version. It gains a Certified badge and a line such as Certified by You with the date and time. To clear the mark without choosing a replacement, open the certified version’s ⋯ menu and click Remove certification. You see Certification removed from that version.

Restore a version

Restore copies a snapshot back into Working draft. The version you restore stays in history.
  1. Open the version’s ⋯ menu and click Restore as current, or click Restore as current while previewing.
  2. In Restore that version, confirm: This version’s content becomes your current draft. Every version stays in history, including this one.
  3. Click Restore as current.
If the draft has changes no version captured, the window also shows Save current edits in ‘Working draft’ as ‘Version 3’ before restoring (with the next version number), ticked, so those edits are saved as a new version first. Untick it to discard them instead; the window then warns Your edits will be discarded. After the restore you see that the restored version is now current. When your edits were saved first, the message goes on to name the version that holds them, for example Version 1 is now current. Your edits were kept as Version 3.

Versions of a conceptual model

A conceptual model version freezes the model as it was when you saved it:
  • Layout: which concepts are on the model, where each one sits, and how relationship lines and their cardinality labels are drawn.
  • Concept definitions: for every concept on the model, its name, description, whether it is an event, synonyms, identifying attributes, domain, and attributes with their value types.
  • Relationships between two concepts that are both on the model.
  • Domains the model’s concepts belong to, with their colours.
Concepts that are not on the model, and relationships that lead to them, are not part of its versions. Linked warehouse tables are not captured either. Previewing a version shows the model exactly as it was frozen, so a description edited since then shows its earlier wording. Compare shows the current model on the left and the version on the right, both as read-only canvases.

Shared concepts change every model that shows them

Concepts belong to the project, and the same concept can sit on several models. Editing a concept, its attributes or a relationship between concepts on a model changes the draft of every model that shows them, wherever you made the edit. Each of those models reads Active changes since its version the next time you open its Versions. Moving, adding or removing concepts changes only the model you are working on.

Restore a conceptual model

Restoring a conceptual model works like restoring a diagram, with one more choice: bring back only where the model’s concepts sit, or also the shared definitions of those concepts.
  1. Open the version’s ⋯ menu and click Restore as current, or click Restore in the bottom bar while previewing.
  2. In Restore that version, choose what to restore:
    • Placement only (This model only.), selected when the window opens: the model gets back the concepts it showed, where each one sat, and how its lines were drawn. Concept definitions, relationships and every other model stay as they are. The window reads This version’s placement becomes your current layout. Every version stays in history, including this one.
    • Placement and shared definitions (Updates every model that shows the changed concepts.): the definitions of the concepts that are still on the model (name, description, synonyms, identifying attributes, domain and attributes) and the relationships between them also return to the version. A concept the version showed that has since been taken off the model is placed again as it is now. The window reminds you: Shared definitions change everywhere they are used.
  3. Read what the restore will change, then click Restore placement or Restore and update shared definitions.
Before you confirm, the window lists what the restore reaches beyond this model’s placement: If nothing would change beyond placement, no list appears and the window looks like any other restore. Switching between the two choices updates the list, and the restore button waits until it has. As with any restore, when the model holds changes no version captured, Save current edits in ‘Working draft’ as a new version before restoring is ticked, so the model as it is now, definitions included, stays in history. After a placement-only restore you see Version 1 placement restored. After a restore of shared definitions you see, for example, Version 1 is now current. 3 concepts changed, 1 revived, 2 relationships changed. When your edits were saved first, either message ends with the version that holds them, for example Your edits were kept as Version 4. The model reloads in place, Copilot keeps its conversation, and Concepts (including the rows of any domain you have open) and the model counts update.

If the project changes while the window is open

The list describes the project as it was when the window opened. If a teammate or Copilot changes a concept, relationship or domain the restore would touch before you confirm, the restore does not run. The window stays open and reads The project changed while you reviewed this restore. Review the updated impact before continuing., with the list refreshed. Read it again, then confirm. If the model changes while the restore itself is running, nothing changes and you see The model changed while this restore was running. Review the current model and try again.

What a restore never does

  • It never deletes a concept from the project. A concept added since the version is taken off this model only; it stays in the project and on every other model that shows it.
  • It never loses a deleted concept’s identity. A revived concept keeps its identity, its definition and attributes as the version froze them, and its relationships to the other concepts on the model, so other models and links that named it find it again.
  • It never loses an attribute’s links. An attribute that comes back brings back the warehouse columns it was linked to when it was removed.
  • It never places a deleted concept with Placement only. You see a note such as 1 deleted concept will not be placed: Address, and the concept stays deleted.

When a restore is refused

If restoring would break a project rule, nothing changes: not the model, not its concepts, not its history. You see Restore failed. The current draft is unchanged. with every problem listed, for example Client: a different concept already has this name, or a relationship that would make a concept its own ancestor. Rename or adjust the concept named, then restore again. If the window cannot work out what a restore would change, it closes and you see Couldn’t work out what restoring this version changes. Open it again.

Rename or delete a version

Rename

  1. Open the version’s ⋯ menu and click Rename.
  2. Type the new name and press Enter (Esc cancels).
Named versions keep that label. Unnamed versions keep automatic numbers; those numbers update if you delete an unnamed version earlier in the list.

Delete

  1. Open the version’s ⋯ menu and click Delete.
  2. In Delete that version, confirm: This version and its snapshot are removed from history. Your current draft is not affected.
  3. Click Delete version.
You see the version deleted. If you delete the certified version, you also see: This is the certified version. Deleting it leaves this artifact with no certified version.

Use a version when generating

Generate Model and Forward Engineer let you choose Working draft or a saved version of the source diagram, and Generate Model also of the conceptual model. The Certified version is selected when one exists; otherwise the latest version; if there are no versions yet, Working draft. Working draft stays available in every list (In-progress · Unversioned). Under Version, Snap Data Studio notes that Saved-version labels are included in generated output names.

Generate Model

  1. Open Generate Model with a diagram or a conceptual model active.
  2. On Source, open the ERD model card and select a source diagram, or open the Conceptual model card and choose a model.
  3. On the Version row, click Change and pick Working draft or a saved version.
  4. Click Generate Model.
A named source version is appended to the new diagram name, for example Sales Model - Dimensional (Approved v2). Generating from Working draft does not add that qualifier. When a diagram and a conceptual model are both sources, the diagram’s version names the output. A conceptual model version generates from the definitions it saved: names, descriptions, classifications, synonyms, domains, attributes and relationships. Warehouse links and attribute mappings are not part of a version, so they always come from the project as it is now.

Forward Engineer

  1. Open Forward Engineer from the diagram’s ⋯ menu.
  2. Under Version, pick Working draft or a saved version.
  3. Click Generate DDL.
A named source version is included in the artifact name, for example Sales_Model_snowflake__Approved_v2.sql. If version history cannot load, you see Version history failed to load. Only the current draft is available.

What’s next