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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for datus_semantic_metricflow-0.2.9.tar.gz
Algorithm Hash digest
SHA256 c00778827c1771156cd4eda76c38551e08a585597b028e88598124fe7a478a76
MD5 f0c324c2e98c8d2e2698bfcb849989c7
BLAKE2b-256 09849156fb341a31fd2755c7d47361508a1c1512544de4975e22fc82563a298b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for datus_semantic_metricflow-0.2.9-py3-none-any.whl
Algorithm Hash digest
SHA256 543d4249f4c029a30c36c9c018565495b187d95b70a5ba2b4861815c8750468e
MD5 f4839d317c1c1f5a318b2d93a31d80ce
BLAKE2b-256 2781c7cf2145a332a03b189b8a4a87eb1c994d1aec125b289c66a0a95daa1922

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