by fastmonkeys

fastmonkeys /stellar

Fast database snapshot and restore tool for development

3.7K Stars 112 Forks Last release: Not found MIT License 190 Commits 0 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Stellar - Fast database snapshot and restore tool for development.

Build Status   

Stellar allows you to quickly restore database when you are e.g. writing database migrations, switching branches or messing with SQL. PostgreSQL and MySQL (partially) are supported.

Screenshot of Stellar terminal window


Stellar is fast. It can restore a database ~140 times faster than using the usual pgdump & pgrestore.

Benchmarking database restore speed

How it works

Stellar works by storing copies of the database in the RDBMS (named as stellarxxxmaster and stellarxxxxslave). When restoring the database, Stellar simply renames the database making it lot faster than the usual SQL dump. However, Stellar uses lots of storage space so you probably don't want to make too many snapshots or you will eventually run out of storage space.

Warning: Please don't use Stellar if you can't afford data loss. It's great for developing but not meant for production.

How to get started

You can install Stellar with


$ pip install stellar

After that, you should go to your project folder and initialize Stellar settings. Stellar initialization wizard will help you with that.

$ stellar init

Stellar settings are saved as 'stellar.yaml' so you probably want to add that to your


$ echo stellar.yaml >> .gitignore

Done! :dancers:

How to take a snapshot

$ stellar snapshot SNAPSHOT_NAME

How to restore from a snapshot

$ stellar restore SNAPSHOT_NAME

Common issues

sqlalchemy.exc.OperationalError: (OperationalError) (1044, u"Access denied for user 'my_db_username'@'localhost' to database 'stellar_data'") "CREATE DATABASE stellar_data CHARACTER SET = 'utf8'" ()

Make sure you have the rights to create new databases. See Issue 10 for discussion

If you are using PostreSQL, make sure you have a database that is named the same as the unix username. You can test this by running just

. (See issue #44 for details)

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.