Skip to main content

MetricFlow adapter for Datus semantic layer

Project description

datus-semantic-metricflow

MetricFlow adapter for Datus semantic layer.

Installation

pip install datus-semantic-metricflow

Dependencies (datus-metricflow, pydantic) will be installed automatically.

Requirements

  • Python >= 3.12

Quick Start

import asyncio
from datus_semantic_metricflow import MetricFlowAdapter, MetricFlowConfig

config = MetricFlowConfig(
    datasource="my_project",
    config_path="/path/to/metricflow/config",  # optional
)

adapter = MetricFlowAdapter(config)

async def main():
    # List metrics
    metrics = await adapter.list_metrics(limit=10)
    for metric in metrics:
        print(f"{metric.name}: {metric.description}")

    # Get dimensions for a metric
    dimensions = await adapter.get_dimensions("revenue")
    for dim in dimensions:
        print(f"{dim.name}: {dim.description}")

    # Query metrics
    result = await adapter.query_metrics(
        metrics=["revenue", "orders"],
        dimensions=["date", "region"],
        limit=100,
    )
    print(f"Columns: {result.columns}")
    print(f"Data: {result.data[:5]}")

asyncio.run(main())

Configuration

Field Type Default Description
datasource str Required Datasource for this semantic layer instance
config_path str None Path to MetricFlow configuration file
timeout int 300 Query timeout in seconds
db_config dict None Datus datasource config; Snowflake supports password or private_key / private_key_file with private_key_file_pwd plus optional role

API

  • list_metrics(path=None, limit=100, offset=0) - List available metrics
  • get_dimensions(metric_name, path=None) - Get dimensions for a metric
  • query_metrics(metrics, dimensions=[], ...) - Execute metric queries
  • validate_semantic() - Validate configuration files

Development

pip install -e ".[dev]"
pytest

Project details


Download files

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

Source Distribution

datus_semantic_metricflow-0.2.11.tar.gz (27.0 kB view details)

Uploaded Source

Built Distribution

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

datus_semantic_metricflow-0.2.11-py3-none-any.whl (29.4 kB view details)

Uploaded Python 3

File details

Details for the file datus_semantic_metricflow-0.2.11.tar.gz.

File metadata

File hashes

Hashes for datus_semantic_metricflow-0.2.11.tar.gz
Algorithm Hash digest
SHA256 57ee277d7314795e0b91f50d21c11aa987e7fbe6b76fe1cb658e9d675115d5ec
MD5 249a1cb6de2340495ce7f760f1f24edf
BLAKE2b-256 225fe54ace7d77458c052e89b8b4498d98f83763413045488d58d0cd839c408c

See more details on using hashes here.

File details

Details for the file datus_semantic_metricflow-0.2.11-py3-none-any.whl.

File metadata

File hashes

Hashes for datus_semantic_metricflow-0.2.11-py3-none-any.whl
Algorithm Hash digest
SHA256 72c86d3022bc5a2b60d82f3400c78539e71d4a34f8efccbe0688425daf182874
MD5 3938811baf327043b5c1804335e41d94
BLAKE2b-256 6eb4821aa487500f129747d3f7fd3eee0259790ee08ddde10088bfb57279d5d5

See more details on using hashes here.

Supported by

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