Backup and Restore

Manage point-in-time independent copies of your LiteGraph deployment with comprehensive backup operations, restore procedures, and data protection strategies.

Overview

The Backup and Restore system provides essential data protection capabilities for your LiteGraph deployment. These operations enable you to create point-in-time snapshots of your entire database, manage backup files, and restore your system to previous states when needed.

Key capabilities include:

• Creating point-in-time database backups with custom filenames
• Listing and managing existing backup files
• Reading backup metadata and information
• Checking backup file existence and status
• Deleting old or unnecessary backup files
• Restoring the entire database from backup files
• Implementing comprehensive data protection strategies

Create a Backup

Create a point-in-time snapshot of your entire LiteGraph database with POST: v1.0/backups. This operation captures the complete state of your database at the moment of backup creation, including all graphs, nodes, edges, users, tenants, and associated data.

Request Parameters

• Filename: The name for the backup file (e.g., "backup-2025.db", "daily-backup.db")

Bash

curl -X POST -H "Authorization: Bearer litegraphadmin" \
     -H "Content-Type: application/json" \
     -d '{"Filename": "backup-2025.db"}' \
     http://localhost:8701/v1.0/backups

JavaScript

import { LiteGraphSdk } from "litegraphdb";

var api = new LiteGraphSdk(
  "http://localhost:8701/",
  "<Tenant-Guid>",
  "*******"
);

const createBackup = async () => {
  try {
    const data = await api.Backup.create({
      Filename: "backup-2025.db",
    });
    console.log(data, "Backup created successfully");
  } catch (err) {
    console.log("Error creating backup:", JSON.stringify(err));
  }
};

Python

import litegraph

sdk = litegraph.configure(
    endpoint="http://localhost:8701",
    tenant_guid="Tenant-Guid",
    access_key="******",
)

def create_backup():
    backup = litegraph.Admin.create_backup(filename="backup-2025.db")
    print(backup)

create_backup()

C#

using LiteGraph;
using LiteGraph.GraphRepositories.Sqlite;

LiteGraphClient liteGraph = new LiteGraphClient(new SqliteGraphRepository("litegraph.db"));
liteGraph.InitializeRepository();
liteGraph.Admin.Backup(outputFilename: "my-backup.db");

List Backups

Retrieve a comprehensive list of all available backup files with GET: v1.0/backups. This operation provides information about all backup files in your system, including their names, creation dates, and file sizes.

Bash

curl -H "Authorization: Bearer litegraphadmin" \
     -H "Content-Type: application/json" \
     http://localhost:8701/v1.0/backups

JavaScript

import { LiteGraphSdk } from "litegraphdb";

var api = new LiteGraphSdk(
  "http://localhost:8701/",
  "<Tenant-Guid>",
  "*******"
);

const readAllBackups = async () => {
  try {
    const data = await api.Backup.readAll();
    console.log(data, "Backups retrieved successfully");
  } catch (err) {
    console.log("Error retrieving backups:", JSON.stringify(err));
  }
};

Python

import litegraph

sdk = litegraph.configure(
    endpoint="http://localhost:8701",
    tenant_guid="Tenant-Guid",
    access_key="******",
)

def retrieve_all_backups():
    backups = litegraph.Admin.retrieve_all()
    print(backups)

retrieve_all_backups()

C#

using LiteGraph;
using LiteGraph.GraphRepositories.Sqlite;

LiteGraphClient liteGraph = new LiteGraphClient(new SqliteGraphRepository("litegraph.db"));
liteGraph.InitializeRepository();
IEnumerable<BackupFile> response= liteGraph.Admin.BackupReadAll();

Restore from Backup

Restore your LiteGraph database from a backup file by following these steps:

1. Stop the LiteGraph server to ensure no data corruption during the restore process
2. Locate your backup file in the backup directory
3. Replace the current litegraph.db file with your backup file
4. Restart the LiteGraph server to load the restored database

Read a Backup

Retrieve detailed information about a specific backup file with GET: v1.0/backups/{filename}. This operation provides metadata about the backup file, including its size, creation date, and other relevant information.

Request Parameters

• Filename: The name of the backup file to read (e.g., "backup-2025.db")

Bash

curl -H "Authorization: Bearer litegraphadmin" \
     -H "Content-Type: application/json" \
     http://localhost:8701/v1.0/backups/backup-2025.db

JavaScript

import { LiteGraphSdk } from "litegraphdb";

var api = new LiteGraphSdk(
  "http://localhost:8701/",
  "<Tenant-Guid>",
  "*******"
);

const readBackup = async () => {
  try {
    const data = await api.Backup.read("backup-2025.db");
    console.log(data, "Backup information retrieved successfully");
  } catch (err) {
    console.log("Error reading backup:", JSON.stringify(err));
  }
};

Python

import litegraph

sdk = litegraph.configure(
    endpoint="http://localhost:8701",
    tenant_guid="Tenant-Guid",
    access_key="******",
)

def retrieve_backup():
    backup = litegraph.Admin.retrieve(filename="backup-2025.db")
    print(backup)

retrieve_backup()

C#

using LiteGraph;
using LiteGraph.GraphRepositories.Sqlite;

LiteGraphClient liteGraph = new LiteGraphClient(new SqliteGraphRepository("litegraph.db"));
liteGraph.InitializeRepository();
BackupFile response = liteGraph.Admin.BackupRead(backupFilename: "my-backup.db");

Delete a Backup

Remove a specific backup file from your system with DELETE: v1.0/backups/{filename}. This operation permanently deletes the backup file and cannot be undone, so ensure you no longer need the backup before proceeding.

Request Parameters

• Filename: The name of the backup file to delete (e.g., "backup-2025.db")

Bash

curl -X DELETE -H "Authorization: Bearer litegraphadmin" \
     -H "Content-Type: application/json" \
     http://localhost:8701/v1.0/backups/backup-2025.db

JavaScript

import { LiteGraphSdk } from "litegraphdb";

var api = new LiteGraphSdk(
  "http://localhost:8701/",
  "<Tenant-Guid>",
  "*******"
);

const deleteBackup = async () => {
  try {
    const data = await api.Backup.delete("backup-2025.db");
    console.log(data, "Backup deleted successfully");
  } catch (err) {
    console.log("Error deleting backup:", JSON.stringify(err));
  }
};

Python

import litegraph

sdk = litegraph.configure(
    endpoint="http://localhost:8701",
    tenant_guid="Tenant-Guid",
    access_key="******",
)

def delete_backup():
    backup = litegraph.Admin.delete(filename="backup-2025.db")
    print(backup)

delete_backup()

C#

using LiteGraph;
using LiteGraph.GraphRepositories.Sqlite;

LiteGraphClient liteGraph = new LiteGraphClient(new SqliteGraphRepository("litegraph.db"));
liteGraph.InitializeRepository();
liteGraph.Admin.DeleteBackup(backupFilename: "my-backup.db");

Check Backup Existence

Verify whether a specific backup file exists in your system with HEAD: v1.0/backups/{filename}. This operation returns a simple status indicating whether the backup file is available without returning the file contents.

Request Parameters

• Filename: The name of the backup file to check (e.g., "backup-2025.db")

Bash

curl -I -H "Authorization: Bearer litegraphadmin" \
     http://localhost:8701/v1.0/backups/backup-2025.db

JavaScript

import { LiteGraphSdk } from "litegraphdb";

var api = new LiteGraphSdk(
  "http://localhost:8701/",
  "<Tenant-Guid>",
  "*******"
);

const existsBackup = async () => {
  try {
    const data = await api.Backup.exists("backup-2025.db");
    console.log(data, "Backup existence checked successfully");
  } catch (err) {
    console.log("Error checking backup existence:", JSON.stringify(err));
  }
};

Python

import litegraph

sdk = litegraph.configure(
    endpoint="http://localhost:8701",
    tenant_guid="Tenant-Guid",
    access_key="******",
)

def check_backup_exists():
    backup = litegraph.Admin.exists(filename="backup-2025.db")
    print(backup)

check_backup_exists()

C#

using LiteGraph;
using LiteGraph.GraphRepositories.Sqlite;

LiteGraphClient liteGraph = new LiteGraphClient(new SqliteGraphRepository("litegraph.db"));
liteGraph.InitializeRepository();
bool exists = liteGraph.Admin.BackupExists(backupFilename: "my-backup.db");

Best Practices

When managing backups and restore operations, consider the following recommendations:

• Regular Backup Schedule: Implement automated daily or weekly backup creation
• Backup Verification: Always verify backup file integrity before relying on them
• Retention Policy: Establish a clear backup retention policy to manage storage space
• Testing Restores: Regularly test restore procedures to ensure they work correctly
• Offsite Storage: Consider storing backups in secure, offsite locations
• Documentation: Maintain clear documentation of backup and restore procedures
• Monitoring: Implement monitoring to ensure backup operations complete successfully

Next Steps

After setting up your backup and restore system, you can:

• Implement automated backup scheduling and management
• Set up backup monitoring and alerting systems
• Create disaster recovery procedures and documentation
• Implement backup encryption for enhanced security
• Set up backup verification and integrity checking
• Develop backup retention and cleanup automation
• Create comprehensive data protection strategies