docs: add backup command to documentation. #302
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
🚀 Build success! Latest successful preview: https://preview-302--questdb-documentation.netlify.app/docs/ Commit SHA: 82f94ad
|
- Add BACKUP SQL reference page with syntax, return values, and examples - Add ER007 error code documentation for Data ID mismatch - Add "Starting fresh with a new Data ID" guide - Add performance characteristics section (pressure-sensitive, batch uploads) - Add backup retention configuration (backup.cleanup.keep.latest.n) - Add filesystem backup option (fs:: object store) - Add restore failure recovery documentation - Add instance name discovery guide - Add AWS EBS lazy loading warning with FSR and fio workarounds - Fix trigger file confusion (Enterprise _backup_restore vs OSS _restore) - Fix configuration defaults from source (retention=5, compression=5) - Clarify that replicas can be backed up (separate backup_instance_name) - Improve document flow for humans and LLMs - Various grammar and consistency fixes Co-Authored-By: Claude Opus 4.5 <[email protected]>
Resolved conflicts: - Updated replication link to /docs/high-availability/setup/ - Updated SQL reference links to /docs/query/sql/ paths - Added BACKUP to sidebars with query/sql path - Kept OSS backup section focused (no Enterprise replication context) Co-Authored-By: Claude Opus 4.5 <[email protected]>
Updated replication links to new high-availability paths: - /docs/operations/replication/#setup-object-storage -> /docs/high-availability/setup/#1-configure-object-storage - /docs/operations/replication/ -> /docs/high-availability/setup/ Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Align BACKUP SQL syntax with other SQL docs (use questdb-sql code block) - Remove Enterprise tag from sidebar - Clarify that Enterprise supports both backup methods - Simplify intro to focus on user benefits, not implementation details Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Add IANA timezone reference with examples - Document hot-reload via SELECT reload_config() - Add jump link for OSS users in overview - External links open in new tab Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Rewrite overview to clarify Enterprise vs OSS backup differences - Fix backup path: _backup/ -> backup/<backup_instance_name>/ - Fix restore table: Yes* -> Sometimes for backup.object.store - Fix "object store URLs" -> "Configure object storage" Co-Authored-By: Claude Opus 4.5 <[email protected]>
Co-Authored-By: Claude Opus 4.5 <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR documents the backup and restore functionality for QuestDB Enterprise (from https://github.com/questdb/questdb-enterprise/pull/647).
Changes
New Pages
reference/sql/backup.md- SQL reference forBACKUP DATABASEandBACKUP ABORTcommandsEnhanced Documentation
Enterprise Backup (
operations/backup.md)fs::object store option for air-gapped environmentsbackup_instance_name.restore_failed/artifacts and recovery stepsError Codes (
troubleshooting/error-codes.md)OSS Checkpoint Restore
Fixes
_backup_restorevs_restore)backup_instance_name)backups()column names and status valuesbackup_schedule()functionFiles Changed
documentation/operations/backup.md- Major enhancementsdocumentation/reference/sql/backup.md- New filedocumentation/troubleshooting/error-codes.md- Added ER007documentation/sidebars.js- Added BACKUP to SQL reference nav