get_datasets

geodesic.boson.dataset.get_datasets(names=[], domain=None, category=None, type=None, search=None, project=None, version_datetime=None, deleted=False, limit=None, page_size=None)

Gets a DatasetList from by name or by a combination of qualifers and name.

Parameters:

• names (List | str) – an optional list of dataset names to return

• search (str | None) – a search string to use to search for datasets who’s name/description match

• domain (str | None) – an optional filter based off the the domain qualifer of the dataset to search

• category (str | None) – an optional filter based off the the category qualifer of the dataset to search

• type (str | None) – an optional filter based off the the type qualifer of the dataset to search

• project – the name of the project to search datasets. Defaults to the active project

• version_datetime (str | datetime | None) – the point in time to search the graph - will return older versions of datasets given a version_datetime.

• deleted (bool) – if True, will return datasets that have been soft deleted. This allows you to recover datasets that have been deleted by calling save() on them again.

• limit (int | None) – the maximum total number of datasets to return. If None, all matching datasets are returned.

• page_size (int | None) – the number of datasets to fetch per request. When set, the client pages through results automatically. When limit is also set, paging stops once limit results have been collected.

Returns:

a Datasets of matching Datasets.

Return type:

Datasets