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.7.tar.gz (16.9 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.7-py3-none-any.whl (18.6 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for datus_semantic_metricflow-0.2.7.tar.gz
Algorithm Hash digest
SHA256 aded341abb449d59f89a8b33720983a3c0028b6dbbcdff649b6ef2a595d27908
MD5 8148eb676fc63820963863f4eb6beecb
BLAKE2b-256 5ee8138d1f0fabc7994432cd935e9762d47d38317aad66f8ae99a9743668065c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for datus_semantic_metricflow-0.2.7-py3-none-any.whl
Algorithm Hash digest
SHA256 bf1529105b7287d4de365e2de26380ba99ed23736e90b46533c175fa643ab72d
MD5 cd9f4f7cef83f7088a8eaeaf290fa098
BLAKE2b-256 386b3ac4abf68bca53b11414f551a13e14b5880ae49aa1083e354a6375df3ec9

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