The Version History feature allows users to view and compare visual differences between two Notebook versions. It provides a Git-like experience directly within the Notebook interface. This feature displays a chronological list of all saved versions with timestamps, which makes it easy to track a Notebook's evolution. By visually highlighting changes, Version History reduces the risk of data loss and eliminates the need for manual version management, such as duplicating Notebooks at various stages. It streamlines version tracking and simplifies understanding the Notebook's development over time.
View the Notebook Version History
To view the version history in the Notebook, select the Version History button.
Compare Versions
By default, the Compare Versions toggle is on. To compare two versions, toggle on Compare Versions and select the versions you want to compare. When you toggle off Compare Versions, you can view the selected version on the right side of the panel in its complete Notebook format, including the outputs.
The side-by-side visual differences are displayed between the two versions. You can also view the versions with timestamps in the Version History (right navigation) pane. In the version selection list, the Current option shows the last saved Notebook contents, while the Version History pane shows the most recently created version from the version history. These versions are not the same, as new versions are created every 2 minutes.
Version Retention Policy
A new version is created when changes are made and two minutes have passed since the previous version was created.
All versions created on the current day are retained.
For versions created on previous days, only the oldest version for each day is retained, up to a maximum of 30 days.
Versions older than 30 days are not retained.
To preserve a specific version, SingleStore recommends adding it to your favorites list on the day you create the version.
Note
New versions are auto-created only when changes occur.
Manage Versions
You can view details, edit details, add to favorites, remove from favorites, duplicate, restore, and delete a version of the Notebook in the Version History pane.
View Version Details
To view the details of a version of the Notebook, select the version name/timestamp of the version in the Version History pane. Alternatively, you can select the ellipsis (three dots) in the selected version, and select View Details. You can view the version name, the name of the user who created it, the timestamp of its creation, and the description.
Edit Version Details
To edit the details of a Notebook version, select a version in the Version History pane. Select the ellipsis (three dots) in the selected version, and select Edit Details. Alternatively, you can select the version name/timestamp of the selected version, and then select the Edit Details button in the upper right of the View Details dialog.
In the Edit Version Details dialog, enter the Version Name and Description.
Add a Version to Favorites
To bookmark a Notebook version, select a version in the Version History pane. Select the ellipsis (three dots) in the selected version, and select Add to Favorites. After adding a version to favorites, a list of bookmarks (favorite versions) is displayed under Favorites, above Version History, in the Version History pane. To permanently keep a version, transfer it to the Favorites list, which has a limit of 10 versions. However, versions in Favorites are always retained. To add an 11th version to Favorites, you must delete or remove an existing version.
Remove a Version from Favorites
To remove a version of the Notebook from Favorites, select a version in the Version History pane. Select the ellipsis (three dots) in the selected version, and select Remove from Favorites.
Duplicate a Version
To duplicate a version of the Notebook, select a version in the Version History pane. Select the ellipsis (three dots) in the selected version, and select Duplicate version. In the Duplicate from <version_name> dialog, enter the name in Notebook Name, and select Duplicate Notebook.
Restore a Version
To restore a version of the Notebook, select a version in the Version History pane. Select the ellipsis (three dots) next to the selected version, and select Restore version. Alternatively, you can restore a version by selecting the Restore Version button at the bottom.
Note
Restoring a version replaces the current contents of the Notebook with the version you selected.
Delete a Version
To delete a version of the Notebook, select a version in the Version History pane. Select the ellipsis (three dots) in the selected version, and select Delete version.