Dataset

class ansys.dynamicreporting.core.serverless.item.Dataset(*args, **kwargs)

Bases: BaseModel

Metadata describing a source dataset used for reporting.

Methods

Dataset.add_tag(tag[, value])	Add or update a single tag.
Dataset.as_dict([recursive])	Serialize the model into a plain dictionary.
Dataset.create(*args, **kwargs)
Dataset.delete()	Delete this object from the database.
Dataset.filter(*args, **kwargs)
Dataset.find(*args, **kwargs)
Dataset.get(*args, **kwargs)
Dataset.get_tags()	Return the raw tag string stored on this object.
Dataset.reinit()	Reset the in-memory ORM state for this object.
Dataset.rem_tag(tag)	Remove a tag by key, if it exists.
Dataset.remove_tag(tag)	Alias for rem_tag() for backwards compatibility.
Dataset.save(**kwargs)
Dataset.set_tags(tag_str)	Replace all tags with the given tag string.

Attributes

Dataset.db	Database alias in which this object is stored.
Dataset.dirname	Directory containing the dataset.
Dataset.filename	Dataset file name (without directory).
Dataset.format	Dataset format identifier (for example "hdf5").
Dataset.numelements	Number of elements (for example rows or mesh elements) in the dataset.
Dataset.numparts	Number of parts in the dataset.
Dataset.saved	Whether this object has been successfully saved to the database.
Dataset.tags	Tag string used to group and filter objects.
Dataset.guid	Globally unique identifier for this object.

exception DoesNotExist(extra_detail: str = None)

Bases: ObjectDoesNotExistError

exception IntegrityError(extra_detail: str = None)

Bases: IntegrityError

exception MultipleObjectsReturned(extra_detail: str = None)

Bases: MultipleObjectsReturnedError

exception NotSaved(extra_detail: str = None)

Bases: ObjectNotSavedError

dirname: str = ''

Directory containing the dataset.

filename: str = 'none'

Dataset file name (without directory).

format: str = 'none'

Dataset format identifier (for example "hdf5").

numelements: int = 0

Number of elements (for example rows or mesh elements) in the dataset.

numparts: int = 0

Number of parts in the dataset.