def create_dataset(self,
stream_id='',
datastore_name='',
view_name='',
name='',
description='',
contact=None,
user_metadata=None):
"""@brief Create a resource which defines a dataset. For LCA it is assumed that datasets are organized by stream.
@param stream_id is the primary key used in the couch view to retrieve the content or metadata
@param datastore_name is the name of the datastore where this dataset resides.
@param view_name is the name of the view which joins the dataset definition to the dataset
@param contact is the contact information for the dataset adminstrator
@param user_metadata is user defined metadata which can be added to this dataset. Should be annotation via association
@param name is the name of the dataset resource
@param description is a description of the dataset resource
@param stream_id str
@param datastore_name str
@param view_name str
@param name str
@param description str
@param contact ContactInformation
@param user_metadata Unknown
@retval dataset_id str
"""
if not (stream_id and datastore_name):
raise BadRequest(
"You must provide a stream_id and datastore name by which to identify this dataset."
)
dataset = DataSet()
dataset.description = description
dataset.name = name or stream_id
dataset.primary_view_key = stream_id
dataset.datastore_name = datastore_name
#@todo: fill this in
dataset.view_name = view_name or 'datasets/dataset_by_id'
dataset_id, _ = self.clients.resource_registry.create(dataset)
return dataset_id
