Datasets

Models representing datasets.

Dataset object

class renku.core.models.dataset.Dataset(*args, **kwargs)

Represent a dataset.

add_or_update_files(files)

Add new files or update existing files.

clear_files()

Remove all files.

copy()

Return a clone of this dataset.

property creators_csv

Comma-separated list of creators associated with dataset.

property creators_full_csv

Comma-separated list of creators with full identity.

derive_from(dataset, creator, identifier=None)

Make self a derivative of dataset and update related fields.

property files

Return list of existing files.

find_file(path)

Find a file in the dataset using its relative path.

freeze()

Set immutable property.

classmethod from_jsonld(data, schema_class=None)

Create an instance from JSON-LD data.

static generate_id(identifier)

Generate an identifier for Dataset.

property immutable

Return if object is immutable.

is_removed()

Return true if dataset is removed.

property keywords_csv

Comma-separated list of keywords associated with dataset.

reassign_oid()

Reassign oid (after assigning a new identifier for example).

remove(date=None)

Mark the dataset as removed.

replace_identifier(identifier=None)

Replace dataset’s identifier and update relevant fields.

NOTE: Call this only for newly-created/-imported datasets that don’t have a mutability chain because it sets initial_identifier.

to_jsonld()

Create JSON-LD.

unlink_file(path, missing_ok=False)

Mark a file as removed using its relative path.

update_files_from(current_dataset, date=None)

Check current_files to reuse existing entries and mark removed files.

update_metadata(**kwargs)

Updates metadata.

update_metadata_from(other, exclude=None)

Update metadata from another dataset.

Dataset file

Manage files in the dataset.

class renku.core.models.dataset.DatasetFile(*, based_on=None, date_added=None, date_removed=None, entity=None, id=None, is_external=False, source=None)

A file in a dataset.

copy()

Return a clone of this object.

classmethod from_dataset_file(other)

Return a copy with a different id.

classmethod from_path(client, path, source=None, based_on=None)

Return an instance from a path.

static generate_id()

Generate an identifier for DatasetFile.

NOTE: ID should not rely on Entity properties because the same Entity can be added and removed multiple times. So, it should be marked by different DatasetFiles.

is_equal_to(other)

Compare content.

NOTE: id is generated randomly and should not be included in this comparison.

is_removed()

Return true if dataset is removed and should not be accessed.

classmethod make_instance(**kwargs)

Instantiate from the given parameters.

remove(date=None)

Create a new instance and mark it as removed.

to_jsonld()

Create JSON-LD.