Browse Source

docs: snapshot (#9886)

* docs: snapshot

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

* docs: corrections

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

* docs: shared base info

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

---------

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>
pull/9920/head
Raju Udava 1 month ago committed by GitHub
parent
commit
8ca2e7ee79
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
  1. 58
      packages/noco-docs/docs/040.bases/065.snapshots.md
  2. BIN
      packages/noco-docs/static/img/v2/base/snapshot-access.png
  3. BIN
      packages/noco-docs/static/img/v2/base/snapshot-create-1.png
  4. BIN
      packages/noco-docs/static/img/v2/base/snapshot-create-2.png
  5. BIN
      packages/noco-docs/static/img/v2/base/snapshot-restore-1.png
  6. BIN
      packages/noco-docs/static/img/v2/base/snapshot-restore-2.png

58
packages/noco-docs/docs/040.bases/065.snapshots.md

@ -0,0 +1,58 @@
---
title: "Snapshots"
description: "Procedures to create and manage snapshots"
tags: ["Bases", "Snapshots", "Collaboration"]
keywords: ["NocoDB base", "Snapshots", "base collaboration"]
---
:::note
- Snapshots are available only in Cloud-hosted plans currently.
:::
Snapshots are a powerful feature that allows users to create a point-in-time backup of their base. Whether you’re preparing for major changes or safeguarding against accidental data loss, this feature ensures your data is secure and retrievable.
Please note the following:
- Snapshots does not include audit log data (revision history)
- Restoring a snapshot will not have any impact on the existing base
- Restoring a snapshot will create a new base with-in the same workspace
- Restoring a snapshot will not restore base specific user permissions. A restored base will have default workspace permissions applied. Any custom permissions required at base level will need to be re-applied.
- Restoring a snapshot will not restore any shared base or shared view related configurations originally present in the source base. These will need to be re-configured.
- A maximum of 2 snapshots are allowed per base currently
- There should be a gap of at least 3 hours between two snapshots
- One can still delete all existing snapshots and create a new one immediately
Snapshot menu is accessible only for Base Owners.
## Access Snapshots
To access snapshots, follow the steps below:
1. Click on the base name in project tree to access the base home page.
2. Select `Settings` tab
3. Select `Snapshots` tab
![Snapshots](/img/v2/base/snapshot-access.png)
## Create Snapshot
To create a snapshot, access the `Snapshots` tab and follow the steps below:
1. Click on the `New Snapshot` button.
2. Enter a name for the snapshot (Optional). By default, the snapshot name will be the current date and time.
3. Click on the `Save` button.
![Create Snapshot](/img/v2/base/snapshot-create-1.png)
![Create Snapshot](/img/v2/base/snapshot-create-2.png)
The snapshot will be created and displayed in the `Snapshots` tab.
## Restore Snapshot
To restore a snapshot, access the `Snapshots` tab and follow the steps below:
1. Click on the `Restore` button next to the snapshot you wish to restore.
2. A confirmation dialog will appear. Click on the `Restore` button to proceed.
![Restore Snapshot](/img/v2/base/snapshot-restore-1.png)
![Restore Snapshot](/img/v2/base/snapshot-restore-2.png)
Note that, currently restore snapshot will create another base in the same workspace. Allowing users to choose new workspace is not supported currently.

BIN
packages/noco-docs/static/img/v2/base/snapshot-access.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 188 KiB

BIN
packages/noco-docs/static/img/v2/base/snapshot-create-1.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 181 KiB

BIN
packages/noco-docs/static/img/v2/base/snapshot-create-2.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 188 KiB

BIN
packages/noco-docs/static/img/v2/base/snapshot-restore-1.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 177 KiB

BIN
packages/noco-docs/static/img/v2/base/snapshot-restore-2.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 222 KiB

Loading…
Cancel
Save