MetaExodus

MetaExodus is a powerful tool designed to facilitate the seamless migration of data from Metabase to a local PostgreSQL database. Utilizing the Metabase API, this tool enables developers to effortlessly copy entire databases, which is invaluable for local testing and development purposes.

Key Features

• Direct API Connection: MetaExodus connects to your Metabase instance, allowing for efficient data retrieval.
• Comprehensive Data Retrieval: It downloads all table structures along with their corresponding data, ensuring that a complete replica is established.
• Local Database Creation: After downloading, identical tables are created in your local PostgreSQL environment.
• User-Friendly Progress Indication: The tool provides clear feedback during the migration process, enhancing usability with visually appealing terminal output.
• Robust Error Handling: MetaExodus incorporates error handling mechanisms, complete with retries, to ensure a smooth migration experience.

System Requirements

• Node.js version 16 or higher
• Local instance of PostgreSQL set up with the same schema as your Metabase
• Access to a Metabase instance to extract the data

Quick Start Guide

To begin, clone the repository and set up the project:

git clone https://github.com/larrasket/metaexodus
cd metaexodus
yarn install

Next, configure the environment by copying and editing the .env file with your PostgreSQL and Metabase credentials. This setup includes settings such as local database details and the Metabase API access information:

DB_LOCAL_HOST=localhost
DB_LOCAL_PORT=5432
DB_LOCAL_NAME=my_local_db
DB_LOCAL_USERNAME=postgres
DB_LOCAL_PASSWORD=your_password

METABASE_BASE_URL=https://your-metabase.com
METABASE_DATABASE_ID=1
DB_REMOTE_USERNAME=your_metabase_email
DB_REMOTE_PASSWORD=your_metabase_password

Once configured, run the migration with:

yarn start

Watch as your data is efficiently copied over.

Additional Development Opportunities

MetaExodus also welcomes contributions. Developers can run tests and ensure code quality with the following commands:

# Run tests
yarn test

# Check code style
yarn lint

# Fix code style issues
yarn lint:fix

Future Enhancements Planned

• Incremental syncing to capture only new or updated data
• Schema-only mode for copying just the structures
• Selective table synchronization for custom migration preferences
• Capability to resume interrupted syncs
• Support for multiple database types, such as MySQL and SQLite

Current Limitations

• An existing database schema is required, as the tool does not create the database automatically.
• It is compatible solely with PostgreSQL for local setups.
• Options to exclude sensitive tables or columns are not currently available.

MetaExodus aims to streamline the data migration process from Metabase to local PostgreSQL environments, making it a vital tool for developers requiring access to production data in a local setting.