Skip to main content

Translates a simple metric definition into reusable SQL and executes it against the SQL engine of your choice.

Project description

metricflow logo

Build and maintain all of your metric logic in code.


Welcome to MetricFlow

See our latest updates in the Metricflow Changelog!

MetricFlow is a semantic layer that makes it easy to organize metric definitions. It takes those definitions and generates legible and reusable SQL. This makes it easy to get consistent metrics output broken down by attributes (dimensions) of interest.

The name comes from the approach taken to generate metrics. A query is compiled into a query plan (represented below) called a dataflow that constructs metrics. The plan is then optimized and rendered to engine-specific SQL.



MetricFlow provides a set of abstractions that help you construct complicated logic and dynamically generate queries to handle:

  • Multi-hop joins between fact and dimension sources
  • Complex metric types such as ratio, expression, and cumulative
  • Metric aggregation to different time granularities
  • And so much more

To get up and running with your own metrics, you should rely on MetricFlow’s documentation.

Licensing

MetricFlow is distributed under a Business Source License (BUSL-1.1). For details on our additional use grant, change license, and change date please refer to our licensing agreement.

Getting Started

Install MetricFlow

MetricFlow can be installed from PyPi for use as a Python library with the following command:

pip install dbt-metricflow

MetricFlow currently serves as a query compilation and SQL rendering library, built to work in conjunction with a dbt project. As such, using MetricFlow requires a working dbt project and a dbt adapter. We provide the dbt-metricflow bundle for this purpose. You may choose to install other adapters as optional extras from dbt-metricflow.

You may need to install Postgres or Graphviz. You can do so by following the install instructions for Postgres or Graphviz. Mac users may prefer to use brew: brew install postgresql or brew install graphviz.

Tutorial

The best way to get started is to follow the tutorial steps, which you can access by running:

mf tutorial

Note: this must be run from a dbt project root directory.

Resources

Contributing and Code of Conduct

This project will be a place where people can easily contribute high-quality updates in a supportive environment.

Please read our code of conduct before diving in.

To get started on direct contributions, head on over to our contributor guide.

License

MetricFlow is source-available software.

Version 0 to 0.140.0 was covered by the Affero GPL license. Version 0.150.0 and greater is covered by the BSL license..

MetricFlow is built by dbt Labs.

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

metricflow-0.206.0.tar.gz (425.5 kB view details)

Uploaded Source

Built Distribution

metricflow-0.206.0-py3-none-any.whl (597.8 kB view details)

Uploaded Python 3

File details

Details for the file metricflow-0.206.0.tar.gz.

File metadata

  • Download URL: metricflow-0.206.0.tar.gz
  • Upload date:
  • Size: 425.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.27.0

File hashes

Hashes for metricflow-0.206.0.tar.gz
Algorithm Hash digest
SHA256 a632df4c1426b4df711d04adaebffdd07e0cdeb6031900daf8599da43a7f7b34
MD5 2e588be0a545fcf007354ca486c57f0d
BLAKE2b-256 633bb666625328e8407737da8e4b7d86e30b65b88612def63b3b2ff7287efc68

See more details on using hashes here.

File details

Details for the file metricflow-0.206.0-py3-none-any.whl.

File metadata

File hashes

Hashes for metricflow-0.206.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3ed53a11941dec0c26938eea90d63ab1df26ba091d3e9f470974db07ca86f95d
MD5 215d7ec910670f9e5ddfb10c9767294b
BLAKE2b-256 067c5a1457e29aeb2140ba9b7917d722474aa32be8a8fc4952621bf0a01128ec

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page