quartzbio.resource.dataset module

class quartzbio.resource.dataset.Dataset(id=None, **params)

Bases: CreateableAPIResource, ListableAPIResource, DeletableAPIResource, UpdateableAPIResource

Datasets are access points to data. Dataset names are unique within a vault folder.

LIST_FIELDS = (('id', 'ID'), ('vault_name', 'Vault'), ('vault_object_path', 'Path'), ('documents_count', 'Documents'), ('description', 'Description'))

RESOURCE_VERSION = 2

activity(follow=False, limit=1, sleep_seconds=5.0)

Get a list of active Tasks that have a target object of the dataset. Active tasks are in the running, queued or pending state.

Defaults to limit=1 for performance. Increase this value in order to return more tasks as output.

archive(storage_class=None, follow=False)

Archive this dataset

beacon(**params)

commits(**params)

disable_global_beacon()

Disable Global Beacon for this dataset.

enable_global_beacon()

Enable Global Beacon for this dataset.

export(format='json', follow=True, **kwargs)

fields(name=None, **params)

classmethod get_by_full_path(full_path, **kwargs)

get_global_beacon_status(raise_on_disabled=False)

Retrieves the Global Beacon status for this dataset.

classmethod get_or_create_by_full_path(full_path, **kwargs)

import_file(path, **kwargs)

This is a shortcut to creating a DatasetImport. Can’t use “import()” because of Python.

imports(**params)

lookup(*sbids)

classmethod make_full_path(vault_name, path, name, **kwargs)

migrate(target, follow=True, **kwargs)

Migrate the data from this dataset to a target dataset.

Valid optional kwargs include:

• source_params

• target_fields

• include_errors

• commit_mode

query(query=None, **params)

restore(storage_class=None, follow=False, **kwargs)

Restore this dataset

saved_queries(**params)

template(**params)

property vault_object