No release in over 3 years
A fast alternative to ActiveRecord::SchemaDumper
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Runtime

 Project Readme

fast_schema_dumper

A super fast alternative to ActiveRecord::SchemaDumper. Currently only MySQL is supported.

Usage

Ridgepole integration

Requiring fast_schema_dumper/ridgepole will overwrite Ridgepole::Dumper.dump, which will force Ridgepole to use fast_schema_dumper.

RUBYOPT='-rridgepole -rfast_schema_dumper' ridgepole ... --apply

Environment variables for Ridgepole

The Ridgepole integration is configurable via envionment variables.

  • FAST_SCHEMA_DUMPER_MODE:
    • disabled: Use the original ActiveRecord dumper
    • verify: Run both dumpers and verify output matches (useful for testing)
    • Any other value or unset: Use FastSchemaDumper (default)
  • FAST_SCHEMA_DUMPER_SUPPRESS_MESSAGE=1: Suppress the warning message when FastSchemaDumper is enabled

I recommend using only fast_schema_dumper in local development environments, and configuring FAST_SCHEMA_DUMPER_MODE=verify in CI setups.

Installation

Install the gem and add to the application's Gemfile by executing:

bundle add fast_schema_dumper

If bundler is not being used to manage dependencies, install the gem by executing:

gem install fast_schema_dumper

Development

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/fast_schema_dumper.