Skip to content

docs: BYOB restore — document restore_access_entities_with_current_grants (26.4+) #6455

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
garrettthomaskth wants to merge 5 commits into
base: main
Choose a base branch
from
+15 −1
Draft

docs: BYOB restore — document restore_access_entities_with_current_grants (26.4+) #6455

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
713ed22
docs: BYOB restore — document restore_access_entities_with_current_gr…
garrettthomaskth Jun 26, 2026
8d79349
docs: drop redundant pre-26.4 RESTORE ALL EXCEPT example, keep inline…
garrettthomaskth Jun 26, 2026
7e43eb0
docs: remove pre-26.4 EXCEPT fallback sentence from BYOB restore note
garrettthomaskth Jun 26, 2026
70271a3
docs: un-admonition the version note and re-add short pre-26.4 line
garrettthomaskth Jun 26, 2026
41bcad6
docs: name the setting explicitly in the 'when enabled' sentence
garrettthomaskth Jun 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion ...oud/guides/backups/03_bring_your_own_backup/03_backup_restore_using_commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,13 +178,27 @@ where `uuid` is a unique identifier, used to identify the backup.
<TabItem value="Restore" label="RESTORE" default>

```sql
RESTORE ALL EXCEPT TABLES system.users, system.roles
RESTORE ALL
FROM S3(
'https://testchbackups.s3.amazonaws.com/<uuid>',
'<key id>',
'<key secret>'
)
SETTINGS restore_access_entities_with_current_grants = 1
```

The `restore_access_entities_with_current_grants` setting is available from ClickHouse Cloud version **26.4** (build **26.4.1.1942** or later).
You can check the version your service is running with:

```sql
SELECT version()
```

When `restore_access_entities_with_current_grants` is enabled, restored users and roles have their grants limited to what the restoring user is allowed to grant
(the same semantics as [`GRANT CURRENT GRANTS`](/sql-reference/statements/grant)), instead of the `RESTORE`
failing with `ACCESS_DENIED` when the backup contains more permissions than the restoring user can grant.

On versions earlier than 26.4, omit the setting.
</TabItem>
</Tabs>

Expand Down
Loading