ActionType

class pysdmx.model.dataset.ActionType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Enumeration that defines the Dataset Action.

Parameters:

  • Append – Append data to an existing dataset.

  • Replace – Replace the existing dataset with new data.

  • Delete – Delete the data provided from the data source.

  • Information – Provide information about the dataset without modifying it.

Dataset

class pysdmx.model.dataset.Dataset(*, structure: str | ~pysdmx.model.dataflow.Schema, attributes: ~typing.Dict[str, ~typing.Any] = <factory>, action: ~pysdmx.model.dataset.ActionType = ActionType.Information, reporting_begin: ~datetime.date | None = None, reporting_end: ~datetime.date | None = None, data_extraction_date: ~datetime.date | None = None, valid_from: ~datetime.date | None = None, valid_to: ~datetime.date | None = None, publication_year: ~datetime.date | None = None, publication_period: ~datetime.date | None = None, set_id: str | None = None)

An organised collection of data.

It includes metadata such as the structure of the dataset, attributes, action type, reporting periods and publication details.

Parameters:

  • structure – The structure referenced from a dataset, which can be a string (short_urn) or a Schema object.

  • attributes – dictionary of attributes at dataset level, with its values.

  • action – Defines the Action of the dataset, default is ActionType.Information.

  • reporting_begin – The start date for reporting, if applicable.

  • reporting_end – The end date for reporting, if applicable.

  • data_extraction_date – The date when the data was extracted.

  • valid_from – The start date for the validity of the dataset.

  • valid_to – The end date for the validity of the dataset.

  • publication_year – The year of publication of the dataset.

  • publication_period – The period of publication of the dataset.

  • set_id – An optional identifier for the dataset.