io.cdap.cdap.api.dataset

Interface DatasetManager

All Known Subinterfaces:

Admin

@Beta
public interface DatasetManager

Provides dataset management functions.

Method Summary

Modifier and Type	Method and Description
void	createDataset(String name, String type, DatasetProperties properties) Create a new dataset instance.
boolean	datasetExists(String name) Check whether a dataset exists in the current namespace.
void	dropDataset(String name) Delete a dataset instance.
DatasetProperties	getDatasetProperties(String name) Get the properties with which a dataset was created or updated.
String	getDatasetType(String name) Get the type of a dataset.
void	truncateDataset(String name) Truncate a dataset, that is, delete all its data.
void	updateDataset(String name, DatasetProperties properties) Update an existing dataset with new properties.

Method Detail

datasetExists

boolean datasetExists(String name)
               throws DatasetManagementException

Check whether a dataset exists in the current namespace.

Parameters:

name - the name of the dataset

Returns:

whether a dataset of that name exists

Throws:

DatasetManagementException - for any issues encountered in the dataset system

getDatasetType

String getDatasetType(String name)
               throws DatasetManagementException

Get the type of a dataset.

Parameters:

name - the name of a dataset

Returns:

the type of the dataset, if it exists; null otherwise

Throws:

InstanceNotFoundException - if the dataset does not exist

DatasetManagementException - for any issues encountered in the dataset system

getDatasetProperties

DatasetProperties getDatasetProperties(String name)
                                throws DatasetManagementException

Get the properties with which a dataset was created or updated.

Parameters:

name - the name of the dataset

Returns:

The properties that were used to create or update the dataset, or null if the dataset does not exist.

Throws:

InstanceNotFoundException - if the dataset does not exist

DatasetManagementException - for any issues encountered in the dataset system

createDataset

void createDataset(String name,
                   String type,
                   DatasetProperties properties)
            throws DatasetManagementException

Create a new dataset instance.

Parameters:

name - the name of the new dataset

type - the type of the dataset to create

properties - the properties for the new dataset

Throws:

InstanceConflictException - if the dataset already exists

DatasetManagementException - for any issues encountered in the dataset system, or if the dataset type's create method fails.

updateDataset

void updateDataset(String name,
                   DatasetProperties properties)
            throws DatasetManagementException

Update an existing dataset with new properties.

Parameters:

name - the name of the dataset

properties - the new properties for the dataset

Throws:

InstanceNotFoundException - if the dataset does not exist

DatasetManagementException - for any issues encountered in the dataset system, or if the dataset type's update method fails.

dropDataset

void dropDataset(String name)
          throws DatasetManagementException

Delete a dataset instance.

Parameters:

name - the name of the dataset

Throws:

InstanceNotFoundException - if the dataset does not exist

DatasetManagementException - for any issues encountered in the dataset system, or if the dataset type's drop method fails.

truncateDataset

void truncateDataset(String name)
              throws DatasetManagementException

Truncate a dataset, that is, delete all its data.

Parameters:

name - the name of the dataset

Throws:

InstanceNotFoundException - if the dataset does not exist

DatasetManagementException - for any issues encountered in the dataset system, or if the dataset type's truncate method fails.