Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

gooddata-dbt

GoodData plugin for dbt. Reads dbt models and profiles, generates GoodData semantic model.

Install

pip install gooddata-dbt
# Or add the corresponding line to requirements.txt
# Or install specific version
pip install gooddata-dbt==1.0.0

You can also install optional dependencies:

# To allow sending comments to GitHub pull requests
pip install PyGithub
# To allow automatic translation of GoodData metadata
pip install deep-translator

Configuration, parametrization

Create gooddata.yaml file to configure so-called data products and environments. Check gooddata_example.yml file for more details.

Parametrization of each execution can be done using environment variables / tool arguments. Use main --help and --help for each use case to learn more.

Alternatively, you can configure everything with environment variables. You can directly set env variables in a shell session, or store them to .env file(s). We provide the following example:

  • .env.dev
  • .env.custom.dev is loaded from the above file and contains sensitive variables. Add .env.custom.* to .gitignore!

Then load .env files:

source .env.local

Use cases

gooddata-dbt --help

The plugin provides the following use cases:

  • provision_workspaces
    • Provisions workspaces to GoodData based on gooddata.yaml file
  • register_data_sources
    • Registers data source in GoodData for each relevant dbt profile
  • deploy_ldm
    • Reads dbt models and profiles
    • Scans data source (connection props from dbt profiles) through GoodData to get column data types (optional in dbt)
    • Generates GoodData LDM(Logical Data Model) from dbt models. Can utilize custom gooddata-specific metadata, more below
  • upload_notification
    • Invalidates caches for data source
  • deploy_analytics
    • Reads content of gooddata_layout folder and deploys analytics model to GoodData
  • store_analytics
    • Reads analytics model from GoodData instance and stores it to disk to gooddata_layout folder
  • test_visualizations
    • Lists all visualizations execution from GoodData instance, and executes each report to validate it
  • dbt_cloud
    • Runs dbt cloud job through their API. Alternative to running dbt-core locally.
    • If running in CI pipeline, it can also notify about performance degradations in a form of GitHub/Gitlab comment.
  • dbt_cloud_stats
    • Esp. for testing purposes. It's triggered from dbt_cloud as well. It collects stats and reports perf degradations.
    • Check .env.dev/.env.custom.dev files for how to set related env variables.

Custom metadata in dbt models (optional)

If you want to generate optimal LDM from dbt models, sometimes you need to specify semantic metadata in dbt models.

In general, all GoodData metadata must be put to dbt models under meta key, except descriptions.

Titles, descriptions

dbt supports only description field. For now, gooddata-dbt generates GoodData title/description from dbt description.

Can be specified for both tables and columns.

Model ID

Per table, you can specify model_id. When deploying models/analytics, you can include any subset of model_ids.

models:
  - name: xxx
    meta:
      gooddata:
        model_id: my_id

GoodData entities

By default, gooddata-dbt generates GoodData entities based on the following rules:

  • data type = NUMERIC (decimal number) - fact
  • data_type = DATE/TIMESTAMP/TIMESTAMPTZ - date dimension
  • other data types = attributes

To override the default, specify custom GoodData meta this way:

columns:
  - name: xxxx
    meta:
      gooddata:
        ldm_type: fact/attribute/label/date/reference/primary_key
        referenced_table: <table name, target of reference (FK), if ldm_type=reference>
        label_type: TEXT/HYPERLINK/GEO_LATITUDE/GEO_LONGITUDE
        attribute_column: <column name of attribute of label, if ldm_type=label>
        sort_column: "<any column in the same table, may not be exposed as LDM object>"
        sort_direction: "DESC"
        # Only for labels, this label will be displayed by default in reports
        default_view: true

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gooddata_dbt-1.71.1.dev3.tar.gz (137.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gooddata_dbt-1.71.1.dev3-py3-none-any.whl (51.0 kB view details)

Uploaded Python 3

File details

Details for the file gooddata_dbt-1.71.1.dev3.tar.gz.

File metadata

  • Download URL: gooddata_dbt-1.71.1.dev3.tar.gz
  • Upload date:
  • Size: 137.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for gooddata_dbt-1.71.1.dev3.tar.gz
Algorithm Hash digest
SHA256 2ccad6570ef3d551fa8084687a8ebd28b70de8377f03cb112cd841a621a19f96
MD5 4291ed4a10265b2838a47d14e4417c56
BLAKE2b-256 c73c80334bec7c72e2ef9a2c12fbaf04d628bea6541390448f942a56df956637

See more details on using hashes here.

Provenance

The following attestation bundles were made for gooddata_dbt-1.71.1.dev3.tar.gz:

Publisher: dev-release.yaml on gooddata/gooddata-python-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file gooddata_dbt-1.71.1.dev3-py3-none-any.whl.

File metadata

File hashes

Hashes for gooddata_dbt-1.71.1.dev3-py3-none-any.whl
Algorithm Hash digest
SHA256 2c0f1a7a280499460cb234959f0d159870b7fdcf45e6973fe98b236383e218e4
MD5 1322504ce1e937df6b212d2431901293
BLAKE2b-256 318200a05cf2bc7aaba5422aa1db3c960b6e121a0420dec8ab9c9c194fc9d4da

See more details on using hashes here.

Provenance

The following attestation bundles were made for gooddata_dbt-1.71.1.dev3-py3-none-any.whl:

Publisher: dev-release.yaml on gooddata/gooddata-python-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

1.73.0

2 files

1.72.0

2 files

This release

1.71.1.dev3 This release

2 files

1.71.0

2 files

1.70.0

2 files

1.69.0

2 files

1.68.0

2 files

1.67.0

2 files

1.66.0

2 files

1.65.0

2 files

1.64.0

2 files

1.63.0

2 files

1.62.0

2 files

1.61.0

2 files

1.60.0

2 files

1.59.0

2 files

1.58.0

2 files

1.57.0

2 files

1.56.0

2 files

1.55.0

2 files

1.54.0

2 files

1.53.0

2 files

1.52.0

2 files

1.51.0

2 files

1.50.0

2 files

1.49.0

2 files

1.48.0

2 files

1.47.0

2 files

1.46.0

2 files

1.45.0

2 files

1.44.0

2 files

1.43.0

2 files

1.42.0

2 files

1.41.0

2 files

1.40.0

2 files

1.39.0

2 files

1.38.0

2 files

1.37.0

2 files

1.36.0

2 files

1.35.0

2 files

1.34.0

2 files

1.33.0

2 files

1.32.2

2 files

1.32.1

2 files

1.32.0

2 files

1.31.0

2 files

1.30.0

2 files

1.29.1

2 files

1.29.0

2 files

1.28.0

2 files

1.27.0

2 files

1.26.0

2 files

1.25.0

2 files

1.24.0

2 files

1.23.0

2 files

1.22.0

2 files

1.21.0

2 files

1.20.0

2 files

1.19.0

2 files

1.18.1

2 files

1.18.0

2 files

1.17.0

2 files

1.16.0

2 files

1.15.0

2 files

1.14.0

2 files

1.13.0

2 files

1.12.0

2 files

1.11.0

2 files

1.10.0

2 files

1.9.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page