Skip to content

Commit 359fe4e

Browse files
committed
Update API: new_managed_dataset rather than new_managed_dataset_creation_helper
1 parent 08c031a commit 359fe4e

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

dataikuapi/dss/project.py

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -412,10 +412,25 @@ def create_sql_table_dataset(self, dataset_name, type, connection, table, schema
412412
return DSSDataset(self.client, self.project_key, dataset_name)
413413

414414
def new_managed_dataset_creation_helper(self, dataset_name):
415+
"""Deprecated. Please use :meth:`new_managed_dataset`"""
416+
warnings.warn("new_managed_dataset_creation_helper is deprecated, please use new_managed_dataset", DeprecationWarning)
417+
return DSSManagedDatasetCreationHelper(self, dataset_name)
418+
419+
def new_managed_dataset(self, dataset_name):
415420
"""
416-
Creates a helper class to create a managed dataset in the project
421+
Initializes the creation of a new managed dataset. Returns a :class:`dataikuapi.dss.dataset.DSSManagedDatasetCreationHelper`
422+
or one of its subclasses to complete the creation of the managed dataset.
423+
424+
Usage example:
425+
426+
.. code-block:: python
427+
428+
builder = project.new_managed_dataset("my_dataset")
429+
builder.with_store_into("target_connection")
430+
dataset = builder.create()
417431
418-
:param string dataset_name: Name of the new dataset - must be unique in the project
432+
:param str dataset_name: Name of the dataset to create
433+
:rtype: :class:`dataikuapi.dss.dataset.DSSManagedDatasetCreationHelper`
419434
:return: A :class:`dataikuapi.dss.dataset.DSSManagedDatasetCreationHelper` object to create the managed dataset
420435
"""
421436
return DSSManagedDatasetCreationHelper(self, dataset_name)
@@ -510,9 +525,10 @@ def create_httpsse_streaming_endpoint(self, streaming_endpoint_name, url=None):
510525
body = obj)
511526
return DSSStreamingEndpoint(self.client, self.project_key, streaming_endpoint_name)
512527

513-
def new_managed_streaming_endpoint_creation_helper(self, streaming_endpoint_name, streaming_endpoint_type=None):
528+
def new_managed_streaming_endpoint(self, streaming_endpoint_name, streaming_endpoint_type=None):
514529
"""
515-
Creates a helper class to create a managed streaming endpoint in the project
530+
Initializes the creation of a new streaming endpoint. Returns a :class:`dataikuapi.dss.streaming_endpoint.DSSManagedStreamingEndpointCreationHelper`
531+
to complete the creation of the streaming endpoint
516532
517533
:param string streaming_endpoint_name: Name of the new streaming endpoint - must be unique in the project
518534
:param string streaming_endpoint_type: Type of the new streaming endpoint (optional if it can be inferred from a connection type)

0 commit comments

Comments
 (0)