Skip to content

Latest commit

 

History

History
64 lines (54 loc) · 3.08 KB

CHANGELOG.md

File metadata and controls

64 lines (54 loc) · 3.08 KB
Raw

Version 0.4.2

  • Add check during dataset registration to raise an exception if the root_dir does not exist
  • Add check before copying any data (i.e., old_location != None) that the user has write permission to the root_dir folder.

Version 0.4.1

Add ability to register "external" datasets. For example datasets that are not physically managed by the registry, or are offsite, therefore only a database entry is created.

  • Database version bumped to 2.2.0
  • Added location_type column to dataset table (can be either "onsite", "external" or "dummy").
  • Added contact_email and url column to dataset table. One of these is required when registering a location_type="external" dataset.
  • Removed is_external_link column from dataset table as it is redundant.
  • Renamed execution.locale to execution.site in the execution table.

Version 0.4.0

Version 0.4.0 focuses around being able to manipulate data already within the dataregistry, i.e., adding the ability to delete and modify previous datasets.

Changelog for developers:

  • Registrar now has a class for each table. They inherit from a BaseTable class, this means that shared functions, like deleting entries, are available for all tables. (#92)
  • Working with tables via the python interface has slightly different syntax (see user changelog below). (#92)
  • is_valid is removed as a dataset property. It has been replaced with status which is a bitmask (bit 0="valid", bit 1= "deleted" and bit 2="archived"), so now datasets can a combination of multiple states. (#93)
  • archive_date, archive_path, delete_date, delete_uid and move_date have been added as new dataset fields. (#93)
  • Database version bumped to 2.0.1 (#93)
  • dataset entries can be deleted (see below) (#94)
  • The CI for the CLI is now pure Python (i.e., there is no more bash script to ingest dummy entries into the registry for testing).
  • Can no longer "bump" a dataset that has a version suffix (trying to do so will raise an error). If a user wants to make a new version of a dataset with a suffix they can still do so by manually specifying the version and suffix (#97 ).
  • Dataset entries can be modified (see below, #100)

Changelog for users:

  • All database tables (dataset, execution, etc) have a more universal syntax. The functionality is still accessed via the Registrar class, but now for example to register a dataset it's Registrar.dataset.register(), similarly for an execution Registrar.execution.register() (#92). The docs and tutorials have been updated (#95).
  • dataset entries can now be deleted using the Registrar.dataset.delete(dataset_id=...) function. This will also delete the raw data within the root_dir. Note that the entry in the database will always remain (with an updated status field to indicate it has been deleted). (#94)
  • Documentation has been updated to make things a bit clearer. Now split into more focused tutorials (#95).
  • Certain dataset quantities can be modified after registration (#100). Documentation has been updated with examples.