Model synchronization from dbt to Metabase.
Project description
Model synchronization from dbt to Metabase.
If dbt is your source of truth for database schemas and you use Metabase as your analytics tool, dbt-metabase can propagate table relationships, model and column descriptions and special types (e.g. currency, category, URL) to your Metabase data model.
Requirements
Requires Python 3.6 or above.
Usage
You can install dbt-metabase from PyPI:
pip install dbt-metabase
To install the dbt package in your project, add the following to your packages.yml:
packages:
- git: https://github.com/gouline/dbt-metabase.git
revision: vX.Y.Z
Where vX.Y.Z corresponds to the latest release. Now run dbt deps and you’re ready to go.
Basic Example
Let’s start by defining a short sample schema.yml as below.
models:
- name: stg_users
description: User records.
columns:
- name: id
description: Primary key.
tests:
- not_null
- unique
- name: email
description: User's email address.
- name: group_id
description: Foreign key to user group.
tests:
- not_null
- relationships:
to: ref('groups')
field: id
- name: stg_groups
description: User groups.
columns:
- name: id
description: Primary key.
tests:
- not_null
- unique
- name: name
description: Group name.
That’s already enough to propagate the primary keys, foreign keys and descriptions to Metabase by executing the below command.
dbt-metabase export \
--dbt_path . \
--mb_host metabase.example.com \
--mb_user user@example.com \
--mb_password Password123 \
--database business \
--schema public
Check your Metabase instance by going into Settings > Admin > Data Model, you will notice that ID in STG_USERS is now marked as “Entity Key” and GROUP_ID is marked as “Foreign Key” pointing to ID in STG_GROUPS.
Special Types
Now that we have primary and foreign keys, let’s tell Metabase that email column contains email addresses.
Change the email column as follows:
- name: email
description: User's email address.
tests:
- metabase.field:
special_type: type/Email
Once you run dbt-metabase export again, you will notice that EMAIL is now marked as “Email”.
Here is the list of special types currently accepted by Metabase:
type/AvatarURL
type/Category
type/City
type/Country
type/Currency
type/Description
type/Email
type/Enum
type/ImageURL
type/SerializedJSON
type/Latitude
type/Longitude
type/Number
type/State
type/URL
type/ZipCode
type/Quantity
type/Income
type/Discount
type/CreationTimestamp
type/CreationTime
type/CreationDate
type/CancelationTimestamp
type/CancelationTime
type/CancelationDate
type/DeletionTimestamp
type/DeletionTime
type/DeletionDate
type/Product
type/User
type/Source
type/Price
type/JoinTimestamp
type/JoinTime
type/JoinDate
type/Share
type/Owner
type/Company
type/Subscription
type/Score
type/Title
type/Comment
type/Cost
type/GrossMargin
type/Birthdate
If you notice new ones, please submit a PR to update this readme and macros/tests.sql.
Visibility Types
In addition to special types, you can optionally specify visibility for each field. This affects whether or not they are displayed in the Metabase UI.
Here is how you would hide that same email:
- name: email
description: User's email address.
tests:
- metabase.field:
special_type: type/Email
visibility_type: sensitive
Here are the visibility types supported by Metabase:
normal (default)
details-only
sensitive
hidden (supported but not reflected in the UI)
retired (supported but not reflected in the UI)
If you notice new ones, please submit a PR to update this readme and macros/tests.sql.
Database Sync
By default, dbt-metabase will tell Metabase to synchronize database fields and wait for the data model to contain all the tables and columns in your dbt project.
You can control this behavior with two arguments:
--sync - boolean to enable or disable pre-synchronization
--sync_timeout - number of seconds to wait and re-check data model before giving up
Programmatic Invocation
As you have already seen, you can invoke dbt-metabase from the command line. But if you prefer to call it from your code, here’s how to do it:
import dbtmetabase
dbtmetabase.export(dbt_path, mb_host, mb_user, mb_password, database, schema)
Code of Conduct
All contributors are expected to follow the PyPA Code of Conduct.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for dbt_metabase-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 60797698c942608d47390fa19972511d8edb13a99005f447dd4226a0c460e62d |
|
MD5 | 9d1288602b1e77ac84d87def29ae6903 |
|
BLAKE2b-256 | 43bc41a2fab57c35f544ac55eb3d2511bd441eb17545bd6863e065dff7f6dd59 |