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_file / 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.5.tar.gz (15.4 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.5-py3-none-any.whl (17.2 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for datus_semantic_metricflow-0.2.5.tar.gz
Algorithm Hash digest
SHA256 d04365f9b9fc1c96db68eaf3f0544a3929864d923bd7036451fb76b93eacc8e6
MD5 0fc64c90b5029f5d0128cbcbbf51b429
BLAKE2b-256 daa2ffed58314d2d3b3e91eabe22085b9696ea88ee7aadade60e6b68db16a927

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for datus_semantic_metricflow-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 9b58aa4d5e158d94f89c048eb78efde718fa994023a283aee37f118cae9c3ab3
MD5 cf214b442f4e1287ee1d3862c7d6c277
BLAKE2b-256 76ffeb1d0ff8da4b4c12dde7a252f8e85508f493310ab1ce656e58ecc6a4c606

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