https://github.com/24eme/metabase_export_import

A python library allowing to import and export metabase database configuration from a metabase API
https://github.com/24eme/metabase_export_import

metabase metabase-api metabase-python

Last synced: 3 months ago
JSON representation

A python library allowing to import and export metabase database configuration from a metabase API

• Host: GitHub
• URL: https://github.com/24eme/metabase_export_import
• Owner: 24eme
• License: agpl-3.0
• Created: 2021-08-19T09:35:16.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-08-02T17:16:58.000Z (almost 2 years ago)
• Last Synced: 2025-12-24T09:36:59.864Z (5 months ago)
• Topics: metabase, metabase-api, metabase-python
• Language: Python
• Homepage:
• Size: 50.8 KB
• Stars: 21
• Watchers: 5
• Forks: 8
• Open Issues: 8
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Metabase Export/Import

This python library allows to export and import a community version instance of Metabase

## Example scripts

Two scripts are provided to import and export fields, cards and dashboards of a specific database configuration of metabase :

    python3 metabase_export.py http://localhost:3000/api/ my_user my_password my_database export_folder

The script produces 3 files for each exported elements (the name of the database is user as prefix) : `my_database_fields_exported.csv`, `my_database_cards_exported.json` and `my_database_dashboard_exported.json`

    python3 metabase_import.py http://localhost:3000/api/ my_user my_password my_database import_folder

The script imports from 3 files, one for each elements : `my_database_fields_forimport.csv`, `my_database_cards_forimport.json` and `my_database_dashboard_forimport.json`

## Library calls

### database creation/deletion

    import metabase

    

    #connect to metabase

    ametabase = metabase.MetabaseApi("http://localhost:3000/api/", "metabase_username", "metabase_password")

    

    #add a sqlite database located at /path/to/database.sqlite. The metabase associated name is my_database

    ametabase.create_database("my_database", 'sqlite', {"db":"/path/to/database.sqlite"})

    #ametabase.delete_database('my_database')

### users and permisssions

    ametabase.create_user("user@example.org", "the_password", {'first_name': 'John', 'last_name': 'Doe'})

    

    #Add a group and associate it with our new user

    ametabase.membership_add('user@example.org', 'a_group')

    

    #allow read data and create interraction with my_database for users members of our new group (a_group)

    ametabase.permission_set_database('a_group', 'my_database', True, True)

### collections and permissions

    #create a collection and its sub collection

    ametabase.create_collection('sub_collection', 'main_collection')

    #allow write right on the new collections to the membres of a_group

    ametabase.permission_set_collection('main_collection', 'a_group', 'write')

    ametabase.permission_set_collection('sub_collection', 'a_group', 'write')

### schema

    #export and import the schema of fields

    ametabase.export_fields_to_csv('my_database', 'my_database_fields.csv')

    ametabase.import_fields_from_csv('my_database', 'my_database_fields.csv')

### cards and dashboards

    ametabase.export_cards_to_json('my_database', 'my_database_cards.json')

    ametabase.export_dashboards_to_json('my_database', 'my_database_dashboard.json')

    ametabase.import_cards_from_json('my_database', 'my_database_cards.json')

    ametabase.import_dashboards_from_json('my_database', 'my_database_dashboard.json')