datus-semantic-dosi
A Datus semantic adapter backed by Dosi, the native Rust OSI engine, with no
MetricFlow dependency. It is a thin protocol translator: the OSI YAML is
loaded, planned, compiled to dialect SQL, and executed entirely inside the Rust
engine (via the dosi-engine pyo3 bindings); this package only maps the Datus
semantic-adapter contract onto the engine's API and its structured errors onto
SemanticValidationError.
service_type: dosi.
Install
The adapter declares the native engine as a normal dependency. One command installs both packages:
pip install datus-semantic-dosi
No separate dosi-engine installation is required.
For local source development, a release is not required. Install the native checkout first, then the adapter into the same environment:
uv pip install -e ../osi-engine/crates/dosi-py
uv pip install -e ./datus-semantic-dosi
Adjust the relative paths to the workspace root. The first command builds the Rust/PyO3 extension with maturin and keeps the Python package linked to the local checkout.
Configure
from datus_semantic_dosi.config import DosiConfig
DosiConfig(
semantic_model_path="model.yaml", # OSI model (.yaml/.yml/.json)
db_config={"type": "sqlite", "uri": "orders.sqlite"}, # or duckdb / connections_path
)
Connection precedence: an explicit connections_path (agent.yml or a
standalone datasources: YAML, consumed verbatim by the engine) wins over an
inline db_config (one agent.yml datasource entry, written to a temporary
connections file). With neither, the engine falls back to its own discovery
order and, failing that, local DuckDB.
SQLite is a storage connector rather than a SQL dialect: Dosi builds that
advertise SQLite connection support receive type: sqlite unchanged and
execute DuckDB SQL against the file in read-only mode. For compatibility,
older installed engine builds still use the adapter's cached DuckDB companion
bridge.
Use with Datus-agent
Install the adapter into the same virtualenv as datus-agent:
uv pip install datus-semantic-dosi
For local development before a registry release, install both checkouts with
the editable commands above. Entry-point discovery requires an installed
adapter distribution; PYTHONPATH alone is not sufficient.
Then wire it in agent.yml. The semantic_layer key must equal the
service_type (dosi); Datus-agent fills db_config from the active
datasource and semantic_models_path from subject/semantic_models/<datasource>/
automatically, so a model file dropped there needs no further config:
agent:
services:
datasources:
mydb:
type: duckdb
uri: /abs/path/to/orders.db
semantic_layer:
dosi: # key MUST be the service_type
# both optional; either overrides the auto-derived directory:
# semantic_model_path: /abs/path/to/model.yaml # explicit single file
# connections_path: /abs/path/to/agent.yml # reuse a connections file
Place OSI model files under <project>/subject/semantic_models/mydb/ (Datus's
per-datasource convention). The adapter catalogs every top-level YAML/YML/JSON
file, keeps one native engine per file, and routes each globally unique metric
name to its owning model. Set semantic_model_path only when an authoring flow
must pin the adapter to one explicit file. Launch with datus --datasource mydb; the ask_metrics node then drives list_metrics / query_metrics
through this adapter.
Behavior notes
validate_semanticdelegates to the engine's own validator (structure, references, metric compilation) — no separate ossie integration.get_dimensions(metric)checks model dimensions against that metric with native compile-only planning and returns only queryable candidates and grains. Window discovery includes the planner-required time axis while testing business dimensions.list_metricsleaves metric-level dimensions empty until the engine exposes this catalog relation directly.- Ambiguous / unknown names surface as
SemanticValidationExceptionwhosepayloadcarries the engine'scandidates; single-candidate fixes are turned into a concretesuggested_retry. - Multiple model files are supported for discovery and single-model queries. Metric and semantic-model names must be unique within a datasource; one query cannot combine metrics owned by different files.
- Time granularity attaches only to time dimensions; supplying it with no
time dimension raises a
time_grain_requiredvalidation payload. - Native time axis accepts
metric_timeplustime_granularity; a suffixed result column is an output/order key, not a query dimension. - Window discovery exposes native structured-window metadata and rejects legacy
grain_to_date,window_aggregation,period_over_period, and stringwindowhints instead of silently executing the base aggregate. - Engine instances and the metric routing catalog refresh when model files are added, removed, or changed.
Tests
Unit tests run against a fake binding (no native build needed):
ci/run-unit-tests.sh datus-semantic-dosi. Integration tests
(-m integration) need the real local or installed dosi-engine binding and the duckdb CLI used
to seed the test fixture,
and use the vendored tests/fixtures/orders/ copy.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file datus_semantic_dosi-0.1.5.tar.gz.
File metadata
- Download URL: datus_semantic_dosi-0.1.5.tar.gz
- Upload date:
- Size: 47.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bff02b9ba6b9afbcb0ee5594efbe6a580facf4f07865c72cd8c63271238dbf4b
|
|
| MD5 |
c5ed653154345776f947f882ad94e576
|
|
| BLAKE2b-256 |
8d35eff8e4ad9c69fd83cfc3592ad053cda8b0f7cc640cadb8a9c45cd751ace7
|
File details
Details for the file datus_semantic_dosi-0.1.5-py3-none-any.whl.
File metadata
- Download URL: datus_semantic_dosi-0.1.5-py3-none-any.whl
- Upload date:
- Size: 39.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c82bb855502db45bedbd20f2daabcc9cae35842e48bfc3ee528fa4f2b305a216
|
|
| MD5 |
628cde7e721a6695cc10b93cc56a768c
|
|
| BLAKE2b-256 |
0ef4a386171cd82ec2b8e3b7e8ec907a4d3d12d0ea5c6e78005930773ef9cd99
|