Backup and Restore Guide | Geode Database

<h2 id="backup-and-restore-guide" class="position-relative d-flex align-items-center group"> Backup and Restore Guide <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="backup-and-restore-guide" aria-haspopup="dialog" aria-label="Share link: Backup and Restore Guide"> Share link </button> </h2><div id="headingShareModal" class="heading-share-modal" role="dialog" aria-modal="true" aria-labelledby="headingShareTitle" hidden> <div class="hsm-dialog" role="document"> <div class="hsm-header"> <h2 id="headingShareTitle" class="h6 mb-0 fw-bold">Share this section</h2> <button type="button" class="hsm-close" aria-label="Close"> </button> </div> <div class="hsm-body"> <label for="headingShareInput" class="form-label small text-muted mb-1 text-uppercase fw-bold" style="font-size: 0.7rem; letter-spacing: 0.5px;">Permalink</label> <div class="input-group mb-4 hsm-url-group"> <input id="headingShareInput" type="text" class="form-control font-monospace" readonly aria-readonly="true" style="font-size: 0.85rem;" /> <button class="btn btn-primary hsm-copy" type="button" aria-label="Copy" title="Copy"> </button> </div> <div class="small fw-bold mb-2 text-muted text-uppercase" style="font-size: 0.7rem; letter-spacing: 0.5px;">Share via</div> <div class="hsm-share-grid"> <a id="share-twitter" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> Twitter </a> <a id="share-linkedin" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> LinkedIn </a> <a id="share-facebook" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> Facebook </a> </div> </div> </div> </div> <style> .heading-share-modal { position: fixed; inset: 0; display: flex; justify-content: center; align-items: center; background: rgba(0, 0, 0, 0.6); z-index: 1050; padding: 1rem; backdrop-filter: blur(4px); -webkit-backdrop-filter: blur(4px); } .heading-share-modal[hidden] { display: none !important; } .hsm-dialog { max-width: 420px; width: 100%; background: var(--bs-body-bg, #fff); color: var(--bs-body-color, #212529); border: 1px solid var(--bs-border-color, rgba(0,0,0,0.1)); border-radius: 1rem; box-shadow: 0 25px 50px -12px rgba(0, 0, 0, 0.25); overflow: hidden; animation: hsm-fade-in 0.2s ease-out; } @keyframes hsm-fade-in { from { opacity: 0; transform: scale(0.95); } to { opacity: 1; transform: scale(1); } } [data-bs-theme="dark"] .hsm-dialog { background: #1e293b; border-color: rgba(255,255,255,0.1); color: #f8f9fa; } .hsm-header { display: flex; justify-content: space-between; align-items: center; padding: 1rem 1.5rem; border-bottom: 1px solid var(--bs-border-color, rgba(0,0,0,0.1)); background: rgba(0,0,0,0.02); } [data-bs-theme="dark"] .hsm-header { background: rgba(255,255,255,0.02); border-color: rgba(255,255,255,0.1); } .hsm-close { background: transparent; border: none; color: inherit; opacity: 0.5; padding: 0.25rem 0.5rem; border-radius: 0.25rem; font-size: 1.2rem; line-height: 1; transition: opacity 0.2s; } .hsm-close:hover { opacity: 1; } .hsm-body { padding: 1.5rem; } .hsm-url-group { display: flex !important; align-items: stretch; } .hsm-url-group .form-control { flex: 1; min-width: 0; margin: 0; background: var(--bs-secondary-bg, #f8f9fa); border-color: var(--bs-border-color, #dee2e6); border-top-right-radius: 0; border-bottom-right-radius: 0; height: 42px; } .hsm-url-group .btn { flex: 0 0 auto; margin: 0; margin-left: -1px; border-top-left-radius: 0; border-bottom-left-radius: 0; height: 42px; display: flex; align-items: center; justify-content: center; padding: 0 1.25rem; z-index: 2; } [data-bs-theme="dark"] .hsm-url-group .form-control { background: #0f172a; border-color: #334155; color: #e2e8f0; } .hsm-share-grid { display: flex; flex-direction: column; gap: 0.5rem; } .hsm-share-grid .btn { display: flex; align-items: center; justify-content: center; font-size: 0.9rem; padding: 0.6rem; border-color: var(--bs-border-color); width: 100%; } [data-bs-theme="dark"] .hsm-share-grid .btn { color: #e2e8f0; border-color: #475569; } [data-bs-theme="dark"] .hsm-share-grid .btn:hover { background: #334155; border-color: #cbd5e1; } </style> <script> (function(){ const modal = document.getElementById('headingShareModal'); if(!modal) return; const input = modal.querySelector('#headingShareInput'); const copyBtn = modal.querySelector('.hsm-copy'); const twitter = modal.querySelector('#share-twitter'); const linkedin = modal.querySelector('#share-linkedin'); const facebook = modal.querySelector('#share-facebook'); const closeBtn = modal.querySelector('.hsm-close'); let lastFocus=null; let trapBound=false; function buildUrl(id){ return window.location.origin + window.location.pathname + '#' + id; } function isOpen(){ return !modal.hasAttribute('hidden'); } function hydrate(id){ const url=buildUrl(id); input.value=url; const enc=encodeURIComponent(url); const text=encodeURIComponent(document.title); if(twitter) twitter.href=`https://twitter.com/intent/tweet?url=${enc}&text=${text}`; if(linkedin) linkedin.href=`https://www.linkedin.com/sharing/share-offsite/?url=${enc}`; if(facebook) facebook.href=`https://www.facebook.com/sharer/sharer.php?u=${enc}`; } function openModal(id){ lastFocus=document.activeElement; hydrate(id); if(!isOpen()){ modal.removeAttribute('hidden'); } requestAnimationFrame(()=>{ input.focus(); }); trapFocus(); } function closeModal(){ if(!isOpen()) return; modal.setAttribute('hidden',''); if(lastFocus && typeof lastFocus.focus==='function') lastFocus.focus(); } function copyCurrent(){ try{ navigator.clipboard.writeText(input.value).then(()=>feedback(true),()=>fallback()); } catch(e){ fallback(); } } function fallback(){ input.select(); try{ document.execCommand('copy'); feedback(true);}catch(e){ feedback(false);} } function feedback(ok){ if(!copyBtn) return; const icon=copyBtn.querySelector('i'); if(!icon) return; const prev=copyBtn.getAttribute('data-prev')||icon.className; if(!copyBtn.getAttribute('data-prev')) copyBtn.setAttribute('data-prev',prev); icon.className= ok ? 'fa-duotone fa-clipboard-check':'fa-duotone fa-circle-exclamation'; setTimeout(()=>{ icon.className=prev; },1800); } function handleShareClick(e){ e.preventDefault(); const btn=e.currentTarget; const id=btn.getAttribute('data-share-target'); if(id) openModal(id); } function bindShareButtons(){ document.querySelectorAll('.h-share').forEach(btn=>{ if(!btn.dataset.hShareBound){ btn.addEventListener('click', handleShareClick); btn.dataset.hShareBound='1'; } }); } bindShareButtons(); if(document.readyState==='loading'){ document.addEventListener('DOMContentLoaded', bindShareButtons); } else { requestAnimationFrame(bindShareButtons); } document.addEventListener('click', function(e){ const shareBtn=e.target.closest && e.target.closest('.h-share'); if(shareBtn && !shareBtn.dataset.hShareBound){ handleShareClick.call(shareBtn, e); } }, true); document.addEventListener('click', e=>{ if(e.target===modal) closeModal(); if(e.target.closest && e.target.closest('.hsm-close')){ e.preventDefault(); closeModal(); } if(copyBtn && (e.target===copyBtn || (e.target.closest && e.target.closest('.hsm-copy')))) { e.preventDefault(); copyCurrent(); } }); document.addEventListener('keydown', e=>{ if(e.key==='Escape' && isOpen()) closeModal(); }); function trapFocus(){ if(trapBound) return; trapBound=true; modal.addEventListener('keydown', f=>{ if(f.key==='Tab' && isOpen()){ const focusable=[...modal.querySelectorAll('a[href],button,input,textarea,select,[tabindex]:not([tabindex="-1"])')].filter(el=>!el.hasAttribute('disabled')); if(!focusable.length) return; const first=focusable[0]; const last=focusable[focusable.length-1]; if(f.shiftKey && document.activeElement===first){ f.preventDefault(); last.focus(); } else if(!f.shiftKey && document.activeElement===last){ f.preventDefault(); first.focus(); } } }); } if(closeBtn) closeBtn.addEventListener('click', e=>{ e.preventDefault(); closeModal(); }); })(); </script>This guide covers comprehensive backup and restore strategies for Geode databases. Learn how to implement online and offline backups, full and incremental backups, point-in-time recovery, and disaster recovery planning. <h3 id="overview" class="position-relative d-flex align-items-center group"> Overview <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="overview" aria-haspopup="dialog" aria-label="Share link: Overview"> Share link </button> </h3>Geode provides multiple backup strategies to protect your data: <table> <thead> <tr> <th>Backup Type</th> <th>Description</th> <th>Use Case</th> </tr> </thead> <tbody> <tr> <td>Online Backup</td> <td>No downtime required</td> <td>Production systems</td> </tr> <tr> <td>Offline Backup</td> <td>Database stopped</td> <td>Maintenance windows</td> </tr> <tr> <td>Full Backup</td> <td>Complete database copy</td> <td>Weekly/monthly backups</td> </tr> <tr> <td>Incremental Backup</td> <td>Changes since last backup</td> <td>Daily backups</td> </tr> <tr> <td>Point-in-Time</td> <td>Restore to specific moment</td> <td>Data recovery</td> </tr> <tr> <td>Snapshot</td> <td>Instant copy</td> <td>Testing, development</td> </tr> </tbody> </table> <h3 id="backup-architecture" class="position-relative d-flex align-items-center group"> Backup Architecture <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="backup-architecture" aria-haspopup="dialog" aria-label="Share link: Backup Architecture"> Share link </button> </h3><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">Geode Database | +-- Data Files (*.gdb) | +-- Transaction Logs (*.wal) | +-- Configuration (geode.conf) | +-- Metadata (schemas, indexes) </code></pre></div> <h3 id="online-vs-offline-backups" class="position-relative d-flex align-items-center group"> Online vs Offline Backups <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="online-vs-offline-backups" aria-haspopup="dialog" aria-label="Share link: Online vs Offline Backups"> Share link </button> </h3> <h4 id="online-backups-hot-backup" class="position-relative d-flex align-items-center group"> Online Backups (Hot Backup) <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="online-backups-hot-backup" aria-haspopup="dialog" aria-label="Share link: Online Backups (Hot Backup)"> Share link </button> </h4>Online backups allow you to back up the database while it’s running and serving traffic. Advantages: <ul> <li>No downtime</li> <li>Consistent snapshot</li> <li>Suitable for 24/7 operations</li> </ul> CLI Command: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Create online backup geode backup create \ --output /backups/geode-$(date +%Y%m%d-%H%M%S).backup \ --compress \ --verify # With specific connection geode backup create \ --host localhost:3141 \ --output /backups/full-backup.backup </code></pre></div>Multi-Language Online Backup Examples: <div class="docs-tabs mb-4"> <ul class="nav nav-tabs" id="tabs-1774880883800779365" role="tablist"><li class="nav-item" role="presentation"> <button class="nav-link active" id="tabs-1774880883800779365-tab-0-tab" data-bs-toggle="tab" data-bs-target="#tabs-1774880883800779365-tab-0" type="button" role="tab" aria-controls="tabs-1774880883800779365-tab-0" aria-selected="true" > Go </button> </li><li class="nav-item" role="presentation"> <button class="nav-link" id="tabs-1774880883800779365-tab-1-tab" data-bs-toggle="tab" data-bs-target="#tabs-1774880883800779365-tab-1" type="button" role="tab" aria-controls="tabs-1774880883800779365-tab-1" aria-selected="false" > Python </button> </li><li class="nav-item" role="presentation"> <button class="nav-link" id="tabs-1774880883800779365-tab-2-tab" data-bs-toggle="tab" data-bs-target="#tabs-1774880883800779365-tab-2" type="button" role="tab" aria-controls="tabs-1774880883800779365-tab-2" aria-selected="false" > Rust </button> </li><li class="nav-item" role="presentation"> <button class="nav-link" id="tabs-1774880883800779365-tab-3-tab" data-bs-toggle="tab" data-bs-target="#tabs-1774880883800779365-tab-3" type="button" role="tab" aria-controls="tabs-1774880883800779365-tab-3" aria-selected="false" > Bash </button> </li></ul> <div class="tab-content border border-top-0 rounded-bottom p-3" id="tabs-1774880883800779365-content"><div class="tab-pane fade show active" id="tabs-1774880883800779365-tab-0" role="tabpanel" aria-labelledby="tabs-1774880883800779365-tab-0-tab" > <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">package main import ( "context" "database/sql" "fmt" "log" "time" _ "geodedb.com/geode" ) func createOnlineBackup(db *sql.DB, backupPath string) error { ctx := context.Background() // Start backup _, err := db.ExecContext(ctx, "CALL geode.backup.create($path, $compress)", backupPath, true) if err != nil { return fmt.Errorf("backup failed: %w", err) } // Verify backup rows, err := db.QueryContext(ctx, "CALL geode.backup.verify($path)", backupPath) if err != nil { return fmt.Errorf("verification failed: %w", err) } defer rows.Close() var valid bool var checksum string if rows.Next() { rows.Scan(&valid, &checksum) if !valid { return fmt.Errorf("backup verification failed") } log.Printf("Backup verified: checksum=%s", checksum) } return nil } func main() { db, err := sql.Open("geode", "localhost:3141") if err != nil { log.Fatal(err) } defer db.Close() backupPath := fmt.Sprintf("/backups/geode-%s.backup", time.Now().Format("20060102-150405")) if err := createOnlineBackup(db, backupPath); err != nil { log.Fatalf("Backup failed: %v", err) } log.Printf("Backup created successfully: %s", backupPath) } </code></pre></div> </div><div class="tab-pane fade" id="tabs-1774880883800779365-tab-1" role="tabpanel" aria-labelledby="tabs-1774880883800779365-tab-1-tab" > <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">import asyncio from datetime import datetime from geode_client import Client async def create_online_backup(backup_path: str): """Create an online backup without stopping the database.""" client = Client(host="localhost", port=3141, skip_verify=True) async with client.connection() as conn: # Start backup print(f"Starting online backup to {backup_path}...") await conn.execute( "CALL geode.backup.create($path, $compress)", {"path": backup_path, "compress": True} ) # Verify backup integrity result, _ = await conn.query( "CALL geode.backup.verify($path)", {"path": backup_path} ) if result.rows: row = result.rows[0] valid = row['valid'].as_bool checksum = row['checksum'].as_string size_mb = row['size_bytes'].as_int / (1024 * 1024) if valid: print(f"Backup verified successfully") print(f" Checksum: {checksum}") print(f" Size: {size_mb:.2f} MB") else: raise Exception("Backup verification failed") print(f"Online backup complete: {backup_path}") async def main(): timestamp = datetime.now().strftime("%Y%m%d-%H%M%S") backup_path = f"/backups/geode-{timestamp}.backup" await create_online_backup(backup_path) asyncio.run(main()) </code></pre></div> </div><div class="tab-pane fade" id="tabs-1774880883800779365-tab-2" role="tabpanel" aria-labelledby="tabs-1774880883800779365-tab-2-tab" > <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-rust" data-lang="rust">use geode_client::{Client, Value}; use std::collections::HashMap; use chrono::Local; #[tokio::main] async fn main() -> Result<(), Box<dyn std::error::Error>> { let client = Client::new("127.0.0.1", 3141).skip_verify(true); let mut conn = client.connect().await?; let timestamp = Local::now().format("%Y%m%d-%H%M%S"); let backup_path = format!("/backups/geode-{}.backup", timestamp); println!("Starting online backup to {}...", backup_path); // Create backup let mut params = HashMap::new(); params.insert("path".to_string(), Value::string(&backup_path)); params.insert("compress".to_string(), Value::bool(true)); conn.query_with_params( "CALL geode.backup.create($path, $compress)", &params ).await?; // Verify backup let mut verify_params = HashMap::new(); verify_params.insert("path".to_string(), Value::string(&backup_path)); let (result, _) = conn.query_with_params( "CALL geode.backup.verify($path)", &verify_params ).await?; if let Some(row) = result.rows.first() { let valid = row.get("valid").unwrap().as_bool()?; let checksum = row.get("checksum").unwrap().as_string()?; if valid { println!("Backup verified: checksum={}", checksum); } else { return Err("Backup verification failed".into()); } } println!("Online backup complete: {}", backup_path); Ok(()) } </code></pre></div> </div><div class="tab-pane fade" id="tabs-1774880883800779365-tab-3" role="tabpanel" aria-labelledby="tabs-1774880883800779365-tab-3-tab" > <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">#!/bin/bash # Online backup script set -euo pipefail BACKUP_DIR="/backups" TIMESTAMP=$(date +%Y%m%d-%H%M%S) BACKUP_FILE="${BACKUP_DIR}/geode-${TIMESTAMP}.backup" GEODE_HOST="localhost:3141" echo "Starting online backup..." # Create backup geode backup create \ --host "${GEODE_HOST}" \ --output "${BACKUP_FILE}" \ --compress \ --verify # Check result if [ $? -eq 0 ]; then SIZE=$(du -h "${BACKUP_FILE}" | cut -f1) echo "Backup complete: ${BACKUP_FILE} (${SIZE})" # Keep only last 7 daily backups find "${BACKUP_DIR}" -name "geode-*.backup" -mtime +7 -delete echo "Cleaned up old backups" else echo "Backup failed!" exit 1 fi </code></pre></div> </div></div> </div> <h4 id="offline-backups-cold-backup" class="position-relative d-flex align-items-center group"> Offline Backups (Cold Backup) <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="offline-backups-cold-backup" aria-haspopup="dialog" aria-label="Share link: Offline Backups (Cold Backup)"> Share link </button> </h4>Offline backups require stopping the database but guarantee complete consistency. CLI Commands: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Stop Geode systemctl stop geode # Create backup (filesystem copy) tar -czvf /backups/geode-offline-$(date +%Y%m%d).tar.gz /var/lib/geode/data # Restart Geode systemctl start geode </code></pre></div>When to Use Offline Backups: <ul> <li>Major version upgrades</li> <li>Schema migrations</li> <li>Hardware maintenance</li> <li>Compliance requirements</li> </ul> <h3 id="full-backups" class="position-relative d-flex align-items-center group"> Full Backups <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="full-backups" aria-haspopup="dialog" aria-label="Share link: Full Backups"> Share link </button> </h3> <h4 id="creating-full-backups" class="position-relative d-flex align-items-center group"> Creating Full Backups <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="creating-full-backups" aria-haspopup="dialog" aria-label="Share link: Creating Full Backups"> Share link </button> </h4>A full backup contains the complete database state. <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Full backup with metadata geode backup full \ --output /backups/full-$(date +%Y%m%d).backup \ --include-metadata \ --include-indexes \ --compress gzip \ --compression-level 6 </code></pre></div> <h4 id="full-backup-schedule" class="position-relative d-flex align-items-center group"> Full Backup Schedule <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="full-backup-schedule" aria-haspopup="dialog" aria-label="Share link: Full Backup Schedule"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">import asyncio import os from datetime import datetime from geode_client import Client async def create_full_backup(): """Create a full backup with all data and metadata.""" client = Client(host="localhost", port=3141, skip_verify=True) backup_dir = "/backups/full" os.makedirs(backup_dir, exist_ok=True) timestamp = datetime.now().strftime("%Y%m%d") backup_path = f"{backup_dir}/geode-full-{timestamp}.backup" async with client.connection() as conn: # Create full backup with all options await conn.execute( """CALL geode.backup.full($path, { include_metadata: true, include_indexes: true, compression: 'gzip', compression_level: 6 })""", {"path": backup_path} ) # Get backup info result, _ = await conn.query( "CALL geode.backup.info($path)", {"path": backup_path} ) if result.rows: info = result.rows[0] print(f"Full backup created: {backup_path}") print(f" Nodes: {info['node_count'].as_int:,}") print(f" Relationships: {info['relationship_count'].as_int:,}") print(f" Size: {info['size_bytes'].as_int / (1024*1024):.2f} MB") print(f" Duration: {info['duration_ms'].as_int} ms") asyncio.run(create_full_backup()) </code></pre></div> <h3 id="incremental-backups" class="position-relative d-flex align-items-center group"> Incremental Backups <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="incremental-backups" aria-haspopup="dialog" aria-label="Share link: Incremental Backups"> Share link </button> </h3> <h4 id="understanding-incremental-backups" class="position-relative d-flex align-items-center group"> Understanding Incremental Backups <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="understanding-incremental-backups" aria-haspopup="dialog" aria-label="Share link: Understanding Incremental Backups"> Share link </button> </h4>Incremental backups only store changes since the last backup, reducing storage and time. <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">Day 1: Full Backup (10GB) Day 2: Incremental (+500MB changes) Day 3: Incremental (+300MB changes) Day 4: Incremental (+400MB changes) ... Day 7: New Full Backup </code></pre></div> <h4 id="creating-incremental-backups" class="position-relative d-flex align-items-center group"> Creating Incremental Backups <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="creating-incremental-backups" aria-haspopup="dialog" aria-label="Share link: Creating Incremental Backups"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Create incremental backup based on last full backup geode backup incremental \ --base /backups/full/geode-full-20260125.backup \ --output /backups/incremental/geode-incr-$(date +%Y%m%d-%H%M%S).backup </code></pre></div><div class="docs-tabs mb-4"> <ul class="nav nav-tabs" id="tabs-1774880883815514356" role="tablist"><li class="nav-item" role="presentation"> <button class="nav-link active" id="tabs-1774880883815514356-tab-0-tab" data-bs-toggle="tab" data-bs-target="#tabs-1774880883815514356-tab-0" type="button" role="tab" aria-controls="tabs-1774880883815514356-tab-0" aria-selected="true" > Python </button> </li><li class="nav-item" role="presentation"> <button class="nav-link" id="tabs-1774880883815514356-tab-1-tab" data-bs-toggle="tab" data-bs-target="#tabs-1774880883815514356-tab-1" type="button" role="tab" aria-controls="tabs-1774880883815514356-tab-1" aria-selected="false" > Go </button> </li></ul> <div class="tab-content border border-top-0 rounded-bottom p-3" id="tabs-1774880883815514356-content"><div class="tab-pane fade show active" id="tabs-1774880883815514356-tab-0" role="tabpanel" aria-labelledby="tabs-1774880883815514356-tab-0-tab" > <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">import asyncio import os import json from datetime import datetime from geode_client import Client class IncrementalBackupManager: def __init__(self, backup_dir: str): self.backup_dir = backup_dir self.full_dir = os.path.join(backup_dir, "full") self.incr_dir = os.path.join(backup_dir, "incremental") self.state_file = os.path.join(backup_dir, "backup_state.json") os.makedirs(self.full_dir, exist_ok=True) os.makedirs(self.incr_dir, exist_ok=True) def _load_state(self) -> dict: try: with open(self.state_file, 'r') as f: return json.load(f) except FileNotFoundError: return {"last_full": None, "last_lsn": 0} def _save_state(self, state: dict): with open(self.state_file, 'w') as f: json.dump(state, f, indent=2) async def create_full_backup(self) -> str: """Create a new full backup.""" client = Client(host="localhost", port=3141, skip_verify=True) timestamp = datetime.now().strftime("%Y%m%d-%H%M%S") backup_path = os.path.join(self.full_dir, f"full-{timestamp}.backup") async with client.connection() as conn: # Create full backup result, _ = await conn.query( """CALL geode.backup.full($path, { include_metadata: true, compression: 'gzip' })""", {"path": backup_path} ) if result.rows: lsn = result.rows[0]['end_lsn'].as_int # Update state state = self._load_state() state["last_full"] = backup_path state["last_lsn"] = lsn self._save_state(state) print(f"Full backup created: {backup_path}") print(f" End LSN: {lsn}") return backup_path return None async def create_incremental_backup(self) -> str: """Create an incremental backup since last backup.""" state = self._load_state() if not state["last_full"]: print("No full backup exists. Creating full backup first...") return await self.create_full_backup() client = Client(host="localhost", port=3141, skip_verify=True) timestamp = datetime.now().strftime("%Y%m%d-%H%M%S") backup_path = os.path.join(self.incr_dir, f"incr-{timestamp}.backup") async with client.connection() as conn: # Create incremental backup result, _ = await conn.query( """CALL geode.backup.incremental($path, $from_lsn, { compression: 'gzip' })""", {"path": backup_path, "from_lsn": state["last_lsn"]} ) if result.rows: row = result.rows[0] changes = row['change_count'].as_int end_lsn = row['end_lsn'].as_int if changes == 0: print("No changes since last backup") os.remove(backup_path) return None # Update state state["last_lsn"] = end_lsn self._save_state(state) print(f"Incremental backup created: {backup_path}") print(f" Changes: {changes:,}") print(f" End LSN: {end_lsn}") return backup_path return None async def main(): manager = IncrementalBackupManager("/backups/geode") # Weekly: Create full backup # await manager.create_full_backup() # Daily: Create incremental backup await manager.create_incremental_backup() asyncio.run(main()) </code></pre></div> </div><div class="tab-pane fade" id="tabs-1774880883815514356-tab-1" role="tabpanel" aria-labelledby="tabs-1774880883815514356-tab-1-tab" > <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">package main import ( "context" "database/sql" "encoding/json" "fmt" "log" "os" "path/filepath" "time" _ "geodedb.com/geode" ) type BackupState struct { LastFull string `json:"last_full"` LastLSN int64 `json:"last_lsn"` } type IncrementalBackupManager struct { backupDir string db *sql.DB } func NewIncrementalBackupManager(backupDir string, db *sql.DB) *IncrementalBackupManager { os.MkdirAll(filepath.Join(backupDir, "full"), 0755) os.MkdirAll(filepath.Join(backupDir, "incremental"), 0755) return &IncrementalBackupManager{backupDir: backupDir, db: db} } func (m *IncrementalBackupManager) loadState() BackupState { stateFile := filepath.Join(m.backupDir, "backup_state.json") data, err := os.ReadFile(stateFile) if err != nil { return BackupState{} } var state BackupState json.Unmarshal(data, &state) return state } func (m *IncrementalBackupManager) saveState(state BackupState) { stateFile := filepath.Join(m.backupDir, "backup_state.json") data, _ := json.MarshalIndent(state, "", " ") os.WriteFile(stateFile, data, 0644) } func (m *IncrementalBackupManager) CreateFullBackup(ctx context.Context) (string, error) { timestamp := time.Now().Format("20060102-150405") backupPath := filepath.Join(m.backupDir, "full", fmt.Sprintf("full-%s.backup", timestamp)) rows, err := m.db.QueryContext(ctx, ` CALL geode.backup.full($1, {include_metadata: true, compression: 'gzip'}) `, backupPath) if err != nil { return "", err } defer rows.Close() if rows.Next() { var endLSN int64 rows.Scan(&endLSN) state := BackupState{LastFull: backupPath, LastLSN: endLSN} m.saveState(state) log.Printf("Full backup created: %s (LSN: %d)", backupPath, endLSN) return backupPath, nil } return "", fmt.Errorf("backup failed") } func (m *IncrementalBackupManager) CreateIncrementalBackup(ctx context.Context) (string, error) { state := m.loadState() if state.LastFull == "" { log.Println("No full backup exists, creating one first...") return m.CreateFullBackup(ctx) } timestamp := time.Now().Format("20060102-150405") backupPath := filepath.Join(m.backupDir, "incremental", fmt.Sprintf("incr-%s.backup", timestamp)) rows, err := m.db.QueryContext(ctx, ` CALL geode.backup.incremental($1, $2, {compression: 'gzip'}) `, backupPath, state.LastLSN) if err != nil { return "", err } defer rows.Close() if rows.Next() { var changes int64 var endLSN int64 rows.Scan(&changes, &endLSN) if changes == 0 { os.Remove(backupPath) log.Println("No changes since last backup") return "", nil } state.LastLSN = endLSN m.saveState(state) log.Printf("Incremental backup: %s (changes: %d, LSN: %d)", backupPath, changes, endLSN) return backupPath, nil } return "", fmt.Errorf("incremental backup failed") } func main() { db, err := sql.Open("geode", "localhost:3141") if err != nil { log.Fatal(err) } defer db.Close() ctx := context.Background() manager := NewIncrementalBackupManager("/backups/geode", db) // Create incremental backup _, err = manager.CreateIncrementalBackup(ctx) if err != nil { log.Fatalf("Backup failed: %v", err) } } </code></pre></div> </div></div> </div> <h3 id="point-in-time-recovery" class="position-relative d-flex align-items-center group"> Point-in-Time Recovery <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="point-in-time-recovery" aria-haspopup="dialog" aria-label="Share link: Point-in-Time Recovery"> Share link </button> </h3> <h4 id="understanding-pitr" class="position-relative d-flex align-items-center group"> Understanding PITR <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="understanding-pitr" aria-haspopup="dialog" aria-label="Share link: Understanding PITR"> Share link </button> </h4>Point-in-Time Recovery allows you to restore the database to any specific moment. Requirements: <ul> <li>Full backup as a base</li> <li>Continuous WAL (Write-Ahead Log) archiving</li> <li>WAL files stored safely</li> </ul> <h4 id="configuring-wal-archiving" class="position-relative d-flex align-items-center group"> Configuring WAL Archiving <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="configuring-wal-archiving" aria-haspopup="dialog" aria-label="Share link: Configuring WAL Archiving"> Share link </button> </h4>geode.conf: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml">[wal] archive_enabled = true archive_command = "cp %p /backups/wal/%f" archive_timeout = 60 # seconds [recovery] restore_command = "cp /backups/wal/%f %p" </code></pre></div> <h4 id="performing-point-in-time-recovery" class="position-relative d-flex align-items-center group"> Performing Point-in-Time Recovery <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="performing-point-in-time-recovery" aria-haspopup="dialog" aria-label="Share link: Performing Point-in-Time Recovery"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Restore to specific timestamp geode restore \ --backup /backups/full/geode-full-20260125.backup \ --wal-dir /backups/wal \ --target-time "2026-01-28T14:30:00Z" \ --output /var/lib/geode/data # Restore to specific transaction geode restore \ --backup /backups/full/geode-full-20260125.backup \ --wal-dir /backups/wal \ --target-lsn 12345678 \ --output /var/lib/geode/data </code></pre></div><div class="docs-tabs mb-4"> <ul class="nav nav-tabs" id="tabs-1774880883839918913" role="tablist"><li class="nav-item" role="presentation"> <button class="nav-link active" id="tabs-1774880883839918913-tab-0-tab" data-bs-toggle="tab" data-bs-target="#tabs-1774880883839918913-tab-0" type="button" role="tab" aria-controls="tabs-1774880883839918913-tab-0" aria-selected="true" > Python </button> </li></ul> <div class="tab-content border border-top-0 rounded-bottom p-3" id="tabs-1774880883839918913-content"><div class="tab-pane fade show active" id="tabs-1774880883839918913-tab-0" role="tabpanel" aria-labelledby="tabs-1774880883839918913-tab-0-tab" > <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">import asyncio from datetime import datetime from geode_client import Client async def point_in_time_recovery( backup_path: str, wal_dir: str, target_time: datetime, output_dir: str ): """Restore database to a specific point in time.""" client = Client(host="localhost", port=3141, skip_verify=True) async with client.connection() as conn: print(f"Starting point-in-time recovery...") print(f" Base backup: {backup_path}") print(f" Target time: {target_time.isoformat()}") # Initiate PITR result, _ = await conn.query( """CALL geode.restore.point_in_time($backup, $wal_dir, $target, $output, { verify: true, create_recovery_conf: true })""", { "backup": backup_path, "wal_dir": wal_dir, "target": target_time.isoformat(), "output": output_dir } ) if result.rows: info = result.rows[0] print(f"Recovery complete:") print(f" Restored to: {info['restored_to'].as_string}") print(f" WAL files applied: {info['wal_files_applied'].as_int}") print(f" Transactions recovered: {info['transactions_recovered'].as_int}") return True return False async def main(): # Restore to 2:30 PM today target = datetime(2026, 1, 28, 14, 30, 0) await point_in_time_recovery( backup_path="/backups/full/geode-full-20260125.backup", wal_dir="/backups/wal", target_time=target, output_dir="/var/lib/geode/data-recovered" ) asyncio.run(main()) </code></pre></div> </div></div> </div> <h3 id="backup-verification" class="position-relative d-flex align-items-center group"> Backup Verification <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="backup-verification" aria-haspopup="dialog" aria-label="Share link: Backup Verification"> Share link </button> </h3> <h4 id="automatic-verification" class="position-relative d-flex align-items-center group"> Automatic Verification <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="automatic-verification" aria-haspopup="dialog" aria-label="Share link: Automatic Verification"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Verify backup integrity geode backup verify /backups/geode-20260128.backup # Verify with detailed output geode backup verify \ --backup /backups/geode-20260128.backup \ --check-checksums \ --check-consistency \ --verbose </code></pre></div> <h4 id="programmatic-verification" class="position-relative d-flex align-items-center group"> Programmatic Verification <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="programmatic-verification" aria-haspopup="dialog" aria-label="Share link: Programmatic Verification"> Share link </button> </h4><div class="docs-tabs mb-4"> <ul class="nav nav-tabs" id="tabs-1774880883845372487" role="tablist"><li class="nav-item" role="presentation"> <button class="nav-link active" id="tabs-1774880883845372487-tab-0-tab" data-bs-toggle="tab" data-bs-target="#tabs-1774880883845372487-tab-0" type="button" role="tab" aria-controls="tabs-1774880883845372487-tab-0" aria-selected="true" > Python </button> </li></ul> <div class="tab-content border border-top-0 rounded-bottom p-3" id="tabs-1774880883845372487-content"><div class="tab-pane fade show active" id="tabs-1774880883845372487-tab-0" role="tabpanel" aria-labelledby="tabs-1774880883845372487-tab-0-tab" > <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">import asyncio from geode_client import Client async def verify_backup(backup_path: str) -> bool: """Comprehensively verify a backup file.""" client = Client(host="localhost", port=3141, skip_verify=True) async with client.connection() as conn: print(f"Verifying backup: {backup_path}") # Basic integrity check result, _ = await conn.query( """CALL geode.backup.verify($path, { check_checksums: true, check_consistency: true, check_indexes: true })""", {"path": backup_path} ) if not result.rows: print("Verification failed: No result") return False info = result.rows[0] checks = { "File integrity": info['file_valid'].as_bool, "Checksum match": info['checksum_valid'].as_bool, "Data consistency": info['data_consistent'].as_bool, "Index integrity": info['indexes_valid'].as_bool, } all_passed = True for check_name, passed in checks.items(): status = "PASS" if passed else "FAIL" print(f" {check_name}: {status}") if not passed: all_passed = False if all_passed: print(f"\nBackup verification: PASSED") print(f" Checksum: {info['checksum'].as_string}") print(f" Node count: {info['node_count'].as_int:,}") print(f" Relationship count: {info['relationship_count'].as_int:,}") else: print(f"\nBackup verification: FAILED") return all_passed async def verify_all_backups(backup_dir: str): """Verify all backups in a directory.""" import os results = [] for filename in os.listdir(backup_dir): if filename.endswith('.backup'): path = os.path.join(backup_dir, filename) valid = await verify_backup(path) results.append((filename, valid)) print() print("=" * 50) print("SUMMARY") print("=" * 50) for filename, valid in results: status = "OK" if valid else "FAILED" print(f" {filename}: {status}") asyncio.run(verify_all_backups("/backups/full")) </code></pre></div> </div></div> </div> <h4 id="test-restores" class="position-relative d-flex align-items-center group"> Test Restores <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="test-restores" aria-haspopup="dialog" aria-label="Share link: Test Restores"> Share link </button> </h4>Regularly test your backups by performing test restores: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">#!/bin/bash # Test restore script BACKUP_FILE="$1" TEST_DIR="/tmp/geode-test-restore" # Clean up previous test rm -rf "${TEST_DIR}" mkdir -p "${TEST_DIR}" # Restore to test directory geode restore \ --backup "${BACKUP_FILE}" \ --output "${TEST_DIR}" \ --no-start # Verify data geode verify "${TEST_DIR}" # Start test instance geode serve \ --data-dir "${TEST_DIR}" \ --port 3142 & GEODE_PID=$! sleep 5 # Run verification queries geode shell --port 3142 -c "MATCH (n) RETURN count(n)" # Stop test instance kill ${GEODE_PID} # Clean up rm -rf "${TEST_DIR}" echo "Test restore completed successfully" </code></pre></div> <h3 id="restore-procedures" class="position-relative d-flex align-items-center group"> Restore Procedures <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="restore-procedures" aria-haspopup="dialog" aria-label="Share link: Restore Procedures"> Share link </button> </h3> <h4 id="full-restore" class="position-relative d-flex align-items-center group"> Full Restore <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="full-restore" aria-haspopup="dialog" aria-label="Share link: Full Restore"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Stop Geode systemctl stop geode # Restore from backup geode restore \ --backup /backups/geode-full-20260128.backup \ --output /var/lib/geode/data \ --overwrite # Verify restored data geode verify /var/lib/geode/data # Start Geode systemctl start geode </code></pre></div> <h4 id="restore-from-incremental-backups" class="position-relative d-flex align-items-center group"> Restore from Incremental Backups <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="restore-from-incremental-backups" aria-haspopup="dialog" aria-label="Share link: Restore from Incremental Backups"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Restore full backup first geode restore \ --backup /backups/full/geode-full-20260125.backup \ --output /var/lib/geode/data # Apply incremental backups in order geode restore \ --backup /backups/incremental/geode-incr-20260126.backup \ --output /var/lib/geode/data \ --incremental geode restore \ --backup /backups/incremental/geode-incr-20260127.backup \ --output /var/lib/geode/data \ --incremental </code></pre></div> <h4 id="programmatic-restore" class="position-relative d-flex align-items-center group"> Programmatic Restore <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="programmatic-restore" aria-haspopup="dialog" aria-label="Share link: Programmatic Restore"> Share link </button> </h4><div class="docs-tabs mb-4"> <ul class="nav nav-tabs" id="tabs-1774880883853612658" role="tablist"><li class="nav-item" role="presentation"> <button class="nav-link active" id="tabs-1774880883853612658-tab-0-tab" data-bs-toggle="tab" data-bs-target="#tabs-1774880883853612658-tab-0" type="button" role="tab" aria-controls="tabs-1774880883853612658-tab-0" aria-selected="true" > Python </button> </li></ul> <div class="tab-content border border-top-0 rounded-bottom p-3" id="tabs-1774880883853612658-content"><div class="tab-pane fade show active" id="tabs-1774880883853612658-tab-0" role="tabpanel" aria-labelledby="tabs-1774880883853612658-tab-0-tab" > <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">import asyncio import os from geode_client import Client async def restore_database( backup_path: str, output_dir: str, incremental_backups: list = None ): """Restore database from backup files.""" client = Client(host="localhost", port=3141, skip_verify=True) # Ensure output directory exists os.makedirs(output_dir, exist_ok=True) async with client.connection() as conn: # Restore full backup print(f"Restoring full backup: {backup_path}") result, _ = await conn.query( """CALL geode.restore.full($backup, $output, { verify: true, overwrite: true })""", {"backup": backup_path, "output": output_dir} ) if result.rows: info = result.rows[0] print(f" Nodes restored: {info['node_count'].as_int:,}") print(f" Relationships restored: {info['relationship_count'].as_int:,}") # Apply incremental backups if incremental_backups: for incr_backup in incremental_backups: print(f"Applying incremental: {incr_backup}") result, _ = await conn.query( """CALL geode.restore.incremental($backup, $output, { verify: true })""", {"backup": incr_backup, "output": output_dir} ) if result.rows: changes = result.rows[0]['changes_applied'].as_int print(f" Changes applied: {changes:,}") print(f"\nRestore complete. Data directory: {output_dir}") async def main(): await restore_database( backup_path="/backups/full/geode-full-20260125.backup", output_dir="/var/lib/geode/data-restored", incremental_backups=[ "/backups/incremental/geode-incr-20260126.backup", "/backups/incremental/geode-incr-20260127.backup", "/backups/incremental/geode-incr-20260128.backup", ] ) asyncio.run(main()) </code></pre></div> </div></div> </div> <h3 id="disaster-recovery-planning" class="position-relative d-flex align-items-center group"> Disaster Recovery Planning <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="disaster-recovery-planning" aria-haspopup="dialog" aria-label="Share link: Disaster Recovery Planning"> Share link </button> </h3> <h4 id="recovery-time-objective-rto-and-recovery-point-objective-rpo" class="position-relative d-flex align-items-center group"> Recovery Time Objective (RTO) and Recovery Point Objective (RPO) <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="recovery-time-objective-rto-and-recovery-point-objective-rpo" aria-haspopup="dialog" aria-label="Share link: Recovery Time Objective (RTO) and Recovery Point Objective (RPO)"> Share link </button> </h4><table> <thead> <tr> <th>Strategy</th> <th>RTO</th> <th>RPO</th> <th>Cost</th> </tr> </thead> <tbody> <tr> <td>Standby replica</td> <td>Minutes</td> <td>Seconds</td> <td>High</td> </tr> <tr> <td>Continuous backup</td> <td>Hours</td> <td>Minutes</td> <td>Medium</td> </tr> <tr> <td>Daily backup</td> <td>Hours-Days</td> <td>24 hours</td> <td>Low</td> </tr> </tbody> </table> <h4 id="disaster-recovery-runbook" class="position-relative d-flex align-items-center group"> Disaster Recovery Runbook <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="disaster-recovery-runbook" aria-haspopup="dialog" aria-label="Share link: Disaster Recovery Runbook"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"># Geode Disaster Recovery Runbook ## 1. Assess the Situation - [ ] Identify the nature of the failure - [ ] Determine data loss extent - [ ] Notify stakeholders ## 2. Activate Recovery - [ ] Access backup storage - [ ] Identify latest valid backup - [ ] Prepare recovery environment ## 3. Restore Database - [ ] Deploy new Geode instance - [ ] Restore from backup - [ ] Apply incremental/WAL files - [ ] Verify data integrity ## 4. Validate Recovery - [ ] Run consistency checks - [ ] Execute test queries - [ ] Verify application connectivity ## 5. Resume Operations - [ ] Update DNS/load balancer - [ ] Monitor performance - [ ] Document incident ## 6. Post-Incident - [ ] Root cause analysis - [ ] Update procedures - [ ] Test improvements </code></pre></div> <h4 id="multi-region-backup-strategy" class="position-relative d-flex align-items-center group"> Multi-Region Backup Strategy <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="multi-region-backup-strategy" aria-haspopup="dialog" aria-label="Share link: Multi-Region Backup Strategy"> Share link </button> </h4><div class="docs-tabs mb-4"> <ul class="nav nav-tabs" id="tabs-1774880883859253796" role="tablist"><li class="nav-item" role="presentation"> <button class="nav-link active" id="tabs-1774880883859253796-tab-0-tab" data-bs-toggle="tab" data-bs-target="#tabs-1774880883859253796-tab-0" type="button" role="tab" aria-controls="tabs-1774880883859253796-tab-0" aria-selected="true" > Python </button> </li></ul> <div class="tab-content border border-top-0 rounded-bottom p-3" id="tabs-1774880883859253796-content"><div class="tab-pane fade show active" id="tabs-1774880883859253796-tab-0" role="tabpanel" aria-labelledby="tabs-1774880883859253796-tab-0-tab" > <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">import asyncio import boto3 from datetime import datetime from geode_client import Client class MultiRegionBackupManager: def __init__(self): self.primary_region = "us-east-1" self.backup_regions = ["us-west-2", "eu-west-1"] self.s3_clients = { region: boto3.client('s3', region_name=region) for region in [self.primary_region] + self.backup_regions } async def create_and_replicate_backup(self): """Create backup and replicate to multiple regions.""" client = Client(host="localhost", port=3141, skip_verify=True) timestamp = datetime.now().strftime("%Y%m%d-%H%M%S") local_path = f"/tmp/geode-backup-{timestamp}.backup" s3_key = f"backups/geode/full-{timestamp}.backup" async with client.connection() as conn: # Create local backup print("Creating backup...") await conn.execute( "CALL geode.backup.full($path, {compression: 'gzip'})", {"path": local_path} ) # Upload to primary region print(f"Uploading to {self.primary_region}...") self.s3_clients[self.primary_region].upload_file( local_path, f"geode-backups-{self.primary_region}", s3_key ) # Replicate to backup regions for region in self.backup_regions: print(f"Replicating to {region}...") # Copy from primary to backup region self.s3_clients[region].copy_object( CopySource={ 'Bucket': f"geode-backups-{self.primary_region}", 'Key': s3_key }, Bucket=f"geode-backups-{region}", Key=s3_key ) print(f"Backup replicated to {len(self.backup_regions)} regions") # Clean up local file import os os.remove(local_path) async def restore_from_nearest_region(self, target_dir: str): """Restore from the nearest available region.""" # Check backup availability in each region for region in [self.primary_region] + self.backup_regions: bucket = f"geode-backups-{region}" try: response = self.s3_clients[region].list_objects_v2( Bucket=bucket, Prefix="backups/geode/full-", MaxKeys=1 ) if response.get('Contents'): latest = sorted( response['Contents'], key=lambda x: x['LastModified'], reverse=True )[0] print(f"Restoring from {region}: {latest['Key']}") # Download backup local_path = f"/tmp/restore-{region}.backup" self.s3_clients[region].download_file( bucket, latest['Key'], local_path ) # Restore client = Client(host="localhost", port=3141, skip_verify=True) async with client.connection() as conn: await conn.execute( "CALL geode.restore.full($path, $output)", {"path": local_path, "output": target_dir} ) print(f"Restore complete from {region}") return True except Exception as e: print(f"Region {region} unavailable: {e}") continue print("No backup available in any region!") return False async def main(): manager = MultiRegionBackupManager() # Create and replicate backup await manager.create_and_replicate_backup() asyncio.run(main()) </code></pre></div> </div></div> </div> <h3 id="automated-backup-scheduling" class="position-relative d-flex align-items-center group"> Automated Backup Scheduling <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="automated-backup-scheduling" aria-haspopup="dialog" aria-label="Share link: Automated Backup Scheduling"> Share link </button> </h3> <h4 id="cron-based-scheduling" class="position-relative d-flex align-items-center group"> Cron-Based Scheduling <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="cron-based-scheduling" aria-haspopup="dialog" aria-label="Share link: Cron-Based Scheduling"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># /etc/cron.d/geode-backup # Full backup every Sunday at 2 AM 0 2 * * 0 geode /usr/local/bin/geode-full-backup.sh >> /var/log/geode-backup.log 2>&1 # Incremental backup every day at 2 AM (except Sunday) 0 2 * * 1-6 geode /usr/local/bin/geode-incr-backup.sh >> /var/log/geode-backup.log 2>&1 # WAL archiving check every 5 minutes */5 * * * * geode /usr/local/bin/geode-wal-check.sh >> /var/log/geode-wal.log 2>&1 </code></pre></div> <h4 id="systemd-timer" class="position-relative d-flex align-items-center group"> Systemd Timer <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="systemd-timer" aria-haspopup="dialog" aria-label="Share link: Systemd Timer"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-ini" data-lang="ini"># /etc/systemd/system/geode-backup.service [Unit] Description=Geode Database Backup After=geode.service [Service] Type=oneshot User=geode ExecStart=/usr/local/bin/geode-backup.sh StandardOutput=journal StandardError=journal </code></pre></div><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-ini" data-lang="ini"># /etc/systemd/system/geode-backup.timer [Unit] Description=Daily Geode Backup Timer [Timer] OnCalendar=*-*-* 02:00:00 Persistent=true [Install] WantedBy=timers.target </code></pre></div><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Enable timer systemctl enable geode-backup.timer systemctl start geode-backup.timer # Check timer status systemctl list-timers | grep geode </code></pre></div> <h4 id="comprehensive-backup-script" class="position-relative d-flex align-items-center group"> Comprehensive Backup Script <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="comprehensive-backup-script" aria-haspopup="dialog" aria-label="Share link: Comprehensive Backup Script"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">#!/bin/bash # /usr/local/bin/geode-backup.sh set -euo pipefail # Configuration BACKUP_DIR="/backups/geode" FULL_DIR="${BACKUP_DIR}/full" INCR_DIR="${BACKUP_DIR}/incremental" WAL_DIR="${BACKUP_DIR}/wal" STATE_FILE="${BACKUP_DIR}/backup_state.json" RETENTION_DAYS=30 FULL_BACKUP_DAY=0 # Sunday # Logging log() { echo "[$(date '+%Y-%m-%d %H:%M:%S')] $1" } # Create directories mkdir -p "${FULL_DIR}" "${INCR_DIR}" "${WAL_DIR}" # Determine backup type DAY_OF_WEEK=$(date +%w) TIMESTAMP=$(date +%Y%m%d-%H%M%S) if [ "${DAY_OF_WEEK}" -eq "${FULL_BACKUP_DAY}" ]; then BACKUP_TYPE="full" BACKUP_FILE="${FULL_DIR}/geode-full-${TIMESTAMP}.backup" else BACKUP_TYPE="incremental" BACKUP_FILE="${INCR_DIR}/geode-incr-${TIMESTAMP}.backup" fi log "Starting ${BACKUP_TYPE} backup" # Create backup if [ "${BACKUP_TYPE}" = "full" ]; then geode backup full \ --output "${BACKUP_FILE}" \ --compress gzip \ --verify # Update state with new full backup echo "{\"last_full\": \"${BACKUP_FILE}\"}" > "${STATE_FILE}" else # Read last full backup from state if [ -f "${STATE_FILE}" ]; then LAST_FULL=$(jq -r '.last_full' "${STATE_FILE}") else log "No state file found. Creating full backup instead." BACKUP_FILE="${FULL_DIR}/geode-full-${TIMESTAMP}.backup" geode backup full --output "${BACKUP_FILE}" --compress gzip --verify echo "{\"last_full\": \"${BACKUP_FILE}\"}" > "${STATE_FILE}" exit 0 fi geode backup incremental \ --base "${LAST_FULL}" \ --output "${BACKUP_FILE}" \ --compress gzip \ --verify fi # Verify backup log "Verifying backup..." geode backup verify "${BACKUP_FILE}" # Get backup size SIZE=$(du -h "${BACKUP_FILE}" | cut -f1) log "Backup complete: ${BACKUP_FILE} (${SIZE})" # Clean up old backups log "Cleaning up backups older than ${RETENTION_DAYS} days..." find "${FULL_DIR}" -name "*.backup" -mtime +${RETENTION_DAYS} -delete find "${INCR_DIR}" -name "*.backup" -mtime +${RETENTION_DAYS} -delete find "${WAL_DIR}" -name "*.wal" -mtime +${RETENTION_DAYS} -delete # Upload to remote storage (optional) if [ -n "${S3_BUCKET:-}" ]; then log "Uploading to S3..." aws s3 cp "${BACKUP_FILE}" "s3://${S3_BUCKET}/backups/geode/" fi log "Backup job completed successfully" </code></pre></div> <h3 id="monitoring-backups" class="position-relative d-flex align-items-center group"> Monitoring Backups <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="monitoring-backups" aria-haspopup="dialog" aria-label="Share link: Monitoring Backups"> Share link </button> </h3> <h4 id="backup-health-checks" class="position-relative d-flex align-items-center group"> Backup Health Checks <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="backup-health-checks" aria-haspopup="dialog" aria-label="Share link: Backup Health Checks"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">import asyncio import os from datetime import datetime, timedelta from geode_client import Client async def check_backup_health(backup_dir: str): """Check backup health and alert on issues.""" issues = [] # Check for recent full backup full_dir = os.path.join(backup_dir, "full") if os.path.exists(full_dir): full_backups = sorted([ f for f in os.listdir(full_dir) if f.endswith('.backup') ], reverse=True) if not full_backups: issues.append("No full backups found") else: latest_full = os.path.join(full_dir, full_backups[0]) mtime = datetime.fromtimestamp(os.path.getmtime(latest_full)) age_days = (datetime.now() - mtime).days if age_days > 7: issues.append(f"Latest full backup is {age_days} days old") # Check for recent incremental backup incr_dir = os.path.join(backup_dir, "incremental") if os.path.exists(incr_dir): incr_backups = sorted([ f for f in os.listdir(incr_dir) if f.endswith('.backup') ], reverse=True) if incr_backups: latest_incr = os.path.join(incr_dir, incr_backups[0]) mtime = datetime.fromtimestamp(os.path.getmtime(latest_incr)) age_hours = (datetime.now() - mtime).total_seconds() / 3600 if age_hours > 25: # More than 25 hours issues.append(f"Latest incremental is {age_hours:.0f} hours old") # Check WAL archiving wal_dir = os.path.join(backup_dir, "wal") if os.path.exists(wal_dir): wal_files = [f for f in os.listdir(wal_dir) if f.endswith('.wal')] if wal_files: latest_wal = max(wal_files, key=lambda f: os.path.getmtime( os.path.join(wal_dir, f))) mtime = datetime.fromtimestamp( os.path.getmtime(os.path.join(wal_dir, latest_wal))) age_minutes = (datetime.now() - mtime).total_seconds() / 60 if age_minutes > 10: issues.append(f"WAL archiving may be delayed ({age_minutes:.0f} min)") # Check disk space statvfs = os.statvfs(backup_dir) free_gb = (statvfs.f_frsize * statvfs.f_bavail) / (1024**3) if free_gb < 50: issues.append(f"Low disk space: {free_gb:.1f} GB free") # Report if issues: print("BACKUP HEALTH CHECK: ISSUES FOUND") for issue in issues: print(f" - {issue}") return False else: print("BACKUP HEALTH CHECK: OK") return True asyncio.run(check_backup_health("/backups/geode")) </code></pre></div> <h4 id="prometheus-metrics" class="position-relative d-flex align-items-center group"> Prometheus Metrics <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="prometheus-metrics" aria-haspopup="dialog" aria-label="Share link: Prometheus Metrics"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># Expose backup metrics for Prometheus from prometheus_client import Gauge, Counter, start_http_server import os from datetime import datetime # Define metrics backup_age_seconds = Gauge( 'geode_backup_age_seconds', 'Age of the latest backup in seconds', ['type'] ) backup_size_bytes = Gauge( 'geode_backup_size_bytes', 'Size of the latest backup in bytes', ['type'] ) backup_count = Gauge( 'geode_backup_count', 'Number of backup files', ['type'] ) backup_disk_free_bytes = Gauge( 'geode_backup_disk_free_bytes', 'Free disk space for backups' ) def update_metrics(backup_dir: str): """Update Prometheus metrics.""" for backup_type in ['full', 'incremental']: type_dir = os.path.join(backup_dir, backup_type) if not os.path.exists(type_dir): continue backups = [f for f in os.listdir(type_dir) if f.endswith('.backup')] # Count backup_count.labels(type=backup_type).set(len(backups)) if backups: # Latest backup latest = max(backups, key=lambda f: os.path.getmtime( os.path.join(type_dir, f))) latest_path = os.path.join(type_dir, latest) # Age age = datetime.now().timestamp() - os.path.getmtime(latest_path) backup_age_seconds.labels(type=backup_type).set(age) # Size size = os.path.getsize(latest_path) backup_size_bytes.labels(type=backup_type).set(size) # Disk space statvfs = os.statvfs(backup_dir) free_bytes = statvfs.f_frsize * statvfs.f_bavail backup_disk_free_bytes.set(free_bytes) # Start metrics server start_http_server(9090) # Update metrics periodically import time while True: update_metrics("/backups/geode") time.sleep(60) </code></pre></div> <h3 id="best-practices" class="position-relative d-flex align-items-center group"> Best Practices <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="best-practices" aria-haspopup="dialog" aria-label="Share link: Best Practices"> Share link </button> </h3> <h4 id="backup-checklist" class="position-relative d-flex align-items-center group"> Backup Checklist <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="backup-checklist" aria-haspopup="dialog" aria-label="Share link: Backup Checklist"> Share link </button> </h4><ul> <li><input disabled="" type="checkbox"> Regular full backups (weekly recommended)</li> <li><input disabled="" type="checkbox"> Daily incremental backups</li> <li><input disabled="" type="checkbox"> WAL archiving enabled for point-in-time recovery</li> <li><input disabled="" type="checkbox"> Backup verification after each backup</li> <li><input disabled="" type="checkbox"> Test restores at least monthly</li> <li><input disabled="" type="checkbox"> Off-site backup storage (different region/provider)</li> <li><input disabled="" type="checkbox"> Encryption for backups containing sensitive data</li> <li><input disabled="" type="checkbox"> Monitoring and alerting for backup failures</li> <li><input disabled="" type="checkbox"> Documented recovery procedures</li> <li><input disabled="" type="checkbox"> Regular DR drills</li> </ul> <h4 id="security-considerations" class="position-relative d-flex align-items-center group"> Security Considerations <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="security-considerations" aria-haspopup="dialog" aria-label="Share link: Security Considerations"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Encrypt backup geode backup create \ --output /backups/geode.backup \ --encrypt \ --encryption-key-file /etc/geode/backup.key # Restore encrypted backup geode restore \ --backup /backups/geode.backup \ --decrypt \ --encryption-key-file /etc/geode/backup.key \ --output /var/lib/geode/data </code></pre></div> <h3 id="next-steps" class="position-relative d-flex align-items-center group"> Next Steps <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="next-steps" aria-haspopup="dialog" aria-label="Share link: Next Steps"> Share link </button> </h3><ul> <li><a href="/guides/data-import/" >Data Import Guide</a> - Import data into Geode</li> <li><a href="/guides/data-export/" >Data Export Guide</a> - Export your data</li> <li><a href="/guides/high-availability/" >High Availability Guide</a> - Configure HA</li> <li><a href="/docs/performance/" >Performance Guide</a> - Optimize performance</li> </ul> <h3 id="resources" class="position-relative d-flex align-items-center group"> Resources <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="resources" aria-haspopup="dialog" aria-label="Share link: Resources"> Share link </button> </h3><ul> <li><a href="/docs/reference/cli-and-api/" >CLI Reference</a> </li> <li><a href="/docs/configuration/" >Configuration Reference</a> </li> <li><a href="/docs/api-reference/" >API Reference</a> </li> <li><a href="https://forum.geodedb.com" aria-label="Community Forum – opens in new window" target="_blank" rel="noopener noreferrer" >Community Forum ↗ </a> </li> </ul> <hr> Questions? Discuss backup strategies in our <a href="https://forum.geodedb.com" aria-label="forum – opens in new window" target="_blank" rel="noopener noreferrer" >forum ↗ </a> .

Related Guides

Backup Procedures

Disaster Recovery