MODULE REFERENCE

client

anomx.data.base.client

Dataset access contracts and an optional scoped client binding.

DatasetClient

DatasetClient

Bases: Protocol

Resolve versioned datasets and load channels without a specific host.

describe_datasetmethod

describe_dataset(reference: str) -> dict[str, Any]

Signature parameters
Parameter	Type	Default
`reference`	`str`	`required`

Returns dict[str, Any]

read_datasetmethod

read_dataset(reference: str, *, version: str, cursor: str | None = None, limit: int = 5000) -> dict[str, Any]

Returns dict[str, Any]

load_channelsmethod

load_channels(channels: Sequence[str], *, start: str | None = None, end: str | None = None, frequency: str | None = None) -> object

Returns object

SelectableDatasetClient

Bases: DatasetClient, Protocol

Optional capability for immutable time-window and aggregation views.

describe_dataset_selectionmethod

describe_dataset_selection(reference: str, *, selection: dict[str, Any]) -> dict[str, Any]

Signature parameters
Parameter	Type	Default
`reference`	`str`	`required`
`selection`keyword only	`dict[str, Any]`	`required`

Returns dict[str, Any]

current_dataset_client() -> DatasetClient | None

Return the client bound by an application or execution host, if any.

Returns DatasetClient | None

use_dataset_client(client: DatasetClient) -> Iterator[DatasetClient]

Temporarily bind a client, restoring the previous binding on exit.

Signature parameters
Parameter	Type	Default
`client`	`DatasetClient`	`required`

Returns Iterator[DatasetClient]