Skip to content

cmem_client.models.dataset¤

Corporate Memory dataset models for data integration.

This module defines models for representing datasets within Corporate Memory projects. Datasets are data sources or sinks used in data integration workflows, connecting to various external systems through plugins.

The Dataset model represents the configuration and metadata of datasets within the DataIntegration environment, including their association with projects and the plugins that handle their data access.

Classes:

  • Dataset – A Dataset Description (Build)
  • DatasetData – Plugin configuration as returned by the full dataset details endpoint.
  • DatasetMetadata – Metadata for a dataset with optional label and description.
  • DatasetPlugin – A dataset plugin description as returned by the task plugins endpoint.
  • DatasetPluginSchema – Schema description of a dataset plugin as returned by the plugin schema endpoint.
  • DatasetSearchResultSet – A dataset search result set
  • ItemLink – An item link pointing to a workspace resource.
  • PluginProperty – A single configuration property of a dataset plugin.

Dataset¤

Bases: ReadRepositoryItem

A Dataset Description (Build)

Attributes:

  • id (str) – ID of the dataset, unique within its project.
  • project_id (str) – ID of the project holding the dataset. Together with id it forms the {project_id}:{id} key of the repository.
  • tags (list[Tag]) – Tags attached to the dataset.
  • item_links (list[ItemLink]) – Links into the user interface for this dataset.
  • data (DatasetData) – Plugin type and parameters, which is what actually connects the dataset to its data.
  • metadata (DatasetMetadata) – Label and description of the dataset.

Functions:

  • get_id – Get the ID of the dataset

data¤

data: DatasetData = Field(default_factory=DatasetData)

get_id¤

get_id()

Get the ID of the dataset

id¤

id: str

item_links: list[ItemLink] = Field(default_factory=list, alias='itemLinks')

metadata¤

metadata: DatasetMetadata = Field(default_factory=DatasetMetadata)

model_config¤

model_config = ConfigDict(extra='allow', populate_by_name=True)

project_id¤

project_id: str = Field(alias='project', default='')

tags¤

tags: list[Tag] = Field(default_factory=list)

DatasetData¤

Bases: Model

Plugin configuration as returned by the full dataset details endpoint.

Attributes:

  • type (str) – ID of the dataset plugin, e.g. csv or eccencaDataPlatform. Use DatasetsRepository.get_dataset_plugins() to see which ones a deployment offers.
  • parameters (dict[str, Any]) – Parameters of that plugin, keyed by parameter name. Which ones apply is described by DatasetsRepository.get_plugin_schema().
  • read_only (bool) – Whether the dataset may only be read.
  • uri_property (str) – Property holding the URI of an entity, for the dataset types which need one.

model_config¤

model_config = ConfigDict(extra='allow', populate_by_name=True)

parameters¤

parameters: dict[str, Any] = Field(default_factory=dict)

read_only¤

read_only: bool = Field(alias='readOnly', default=False)

type¤

type: str = ''

uri_property¤

uri_property: str = Field(alias='uriProperty', default='')

DatasetMetadata¤

Bases: TypedDict

Metadata for a dataset with optional label and description.

Attributes:

  • label (str) – Human readable name of the dataset.
  • description (str) – Description of the dataset.

description¤

description: str

label¤

label: str

DatasetPlugin¤

Bases: Model

A dataset plugin description as returned by the task plugins endpoint.

Attributes:

  • title (str) – Human readable name of the plugin.
  • description (str) – What the plugin connects to.
  • task_type (str) – Kind of task the plugin builds, Dataset for these.

description¤

description: str = ''

model_config¤

model_config = ConfigDict(extra='allow', populate_by_name=True)

task_type¤

task_type: str = Field(alias='taskType', default='')

title¤

title: str = ''

DatasetPluginSchema¤

Bases: Model

Schema description of a dataset plugin as returned by the plugin schema endpoint.

Attributes:

  • title (str) – Human readable name of the plugin.
  • description (str) – What the plugin connects to.
  • properties (dict[str, PluginProperty]) – Parameters the plugin accepts, keyed by parameter name. These are the keys of DatasetData.parameters.
  • required (list[str]) – Names of the parameters which must be given.

description¤

description: str = ''

model_config¤

model_config = ConfigDict(extra='allow', populate_by_name=True)

properties¤

properties: dict[str, PluginProperty] = Field(default_factory=dict)

required¤

required: list[str] = Field(default_factory=list)

title¤

title: str = ''

DatasetSearchResultSet¤

Bases: Model

A dataset search result set

Attributes:

model_config¤

model_config = ConfigDict(extra='allow', populate_by_name=True)

results¤

results: list[Dataset]

Bases: Model

An item link pointing to a workspace resource.

Attributes:

  • path (str) – Path the link points at, relative to the DataIntegration user interface.
  • type (str) – Kind of view the link opens, e.g. the dataset preview.

model_config¤

model_config = ConfigDict(extra='allow', populate_by_name=True)

path¤

path: str = ''

type¤

type: str = ''

PluginProperty¤

Bases: Model

A single configuration property of a dataset plugin.

Attributes:

  • title (str) – Human readable name of the property.
  • description (str) – What the property configures.

description¤

description: str = ''

model_config¤

model_config = ConfigDict(extra='allow', populate_by_name=True)

title¤

title: str = ''

Comments