Quemsi Documentation
Complete guides, tutorials, and reference materials to help you get the most out of Quemsi
Welcome to Quemsi Documentation
Whether you're just getting started or looking to implement advanced backup strategies, our documentation covers everything you need to know about Quemsi. From initial setup to best practices, find the information you need to manage your database backups effectively while keeping all data within your infrastructure.
Getting Started
Getting Started
A friendly, step-by-step guide to go from your first login to a working flow. Learn how to register, install the agent, connect storage and datasources, and run your first backup while keeping data in your environment.
Read Guide โDemo Setup
Experience Quemsi's full capabilities without any installation. Learn about the demo agent setup, including pre-configured databases, data sources, and workflows.
Explore Demo โArchitecture Overview
Understand how Quemsi works under the hood. Learn about the agent-based architecture, data flow, storage options, and how your data stays within your infrastructure.
Learn More โIntegration
Company API tokens and /api/v1 for pipelines, scripts, and coding agents. Guides stay the clicks in the UI; this is the machine path.
Create API tokens
Issue a qsk_โฆ token, copy it once, pick scopes, optionally bind it to one agent, and store it as a CI secret or laptop env var.
Install the quemsi CLI
Download Linux, Windows, or JAR, set QUEMSI_TOKEN, and run your first snapshot or restore.
API reference
Bearer auth, snapshot and restore bodies, polling, and repeated tag= filters on restore-actions.
Restore before tests
POST a restore for a tagged snapshot, poll until it finishes, then run the suite. Restore overwrites the target database.
Open Page โSnapshot before deploy
POST a tagged snapshot, poll until it finishes, then migrate or deploy.
Open Page โJenkins integration
Credentials, CLI on the agent, and Declarative Pipeline stages for restore-before-tests and snapshot-before-deploy.
Open Page โCoding agent snapshot
Install the CLI, bind a token to your local agent, and snapshot before Hibernate auto-DDL or a migration.
Open Page โView all integration pages
Tokens, the contract, CLI install, Jenkins, CI restore/snapshot, and coding-agent snapshot in one place.
Browse Integration โGuides
Role and task recipes with the clicks in the Quemsi UI. Tutorials stay the story; guides stay the how.
Take a tagged snapshot
Quick Backup Wizard if Data is empty, then Take Snapshot on the timeline with tags so Restore can find the version.
Open Guide โSnapshot before a schema change
Tag a baseline snapshot before you migrate, so you can overwrite back if the change fails.
Open Guide โSchedule a recurring backup
Create a timer, attach it to the backup flow, and keep tagged snapshots on a schedule.
Open Guide โRestore a tagged snapshot
Before a test run, filter Restore by tags, pick the latest matching snapshot, and overwrite a target database.
Open Guide โPark work and switch
Snapshot and tag in-progress work, restore another tagged state for an urgent task, then switch back.
Open Guide โRestore across environments
Backup to company cloud storage, then restore onto a database on another agent.
Open Guide โView all guides
Browse recipes by role and task. More guides will land here as we document each path.
Browse Guides โTutorials
Step-by-step tutorials covering real-world scenarios and best practices for database backup and management.
Take a Snapshot Before Schema Changes
Learn how taking a 30-second snapshot before a major schema change can save you hours of debugging and recovery. Includes a real-world story and step-by-step guide.
Read Tutorial โSwitch Between Schema States
Learn how to instantly switch between database schemas when urgent tasks interrupt your long-running work. Save your progress and restore previous schemas in minutes.
Read Tutorial โShare Data Across Environments
Learn how to easily move database states between dev, test, UAT, and production. Develop on test data, test on production data, and keep environments synchronized.
Read Tutorial โSetting Up Automated Backups
Learn how to configure automated backup flows with timers. Never forget to backup again with scheduled snapshots that protect your data automatically.
Read Tutorial โTesting with Known DB States
Ensure consistent, repeatable tests by using tagged database snapshots as known initial states. Perfect for regression testing and test automation.
Read Tutorial โMask Sensitive Data for Privacy
Export production data without privacy concerns. Use real data structures for development, testing, and troubleshooting while keeping sensitive information protected.
Read Tutorial โMigrate Config and Reference Data
Promote lookup and configuration rows between environments with Upsert. Insert missing keys, update or skip existing ones, and leave transactional tables untouched.
Read Tutorial โView All Tutorials
Browse all available tutorials in one place. Find step-by-step guides for common scenarios and best practices.
Browse Tutorials โQuick Links
- Getting Started Guide - Start here if you're new to Quemsi
- Architecture Overview - Understand how Quemsi works
- Demo Setup - Explore the demo environment
- Integration - Company API tokens and
/api/v1for CI, scripts, and coding agents - Guides - Role and task recipes (tagged snapshots, then restore)
- All Tutorials - Browse all step-by-step tutorials
- Create Account - Sign up for free and start using Quemsi