io.cdap.cdap.api

Interface DatasetConfigurer

All Known Subinterfaces:

ApplicationConfigurer, ConditionConfigurer, CustomActionConfigurer, HttpServiceConfigurer, MapReduceConfigurer, ServiceConfigurer, SparkConfigurer, WorkerConfigurer, WorkflowConfigurer

All Known Implementing Classes:

DefaultDatasetConfigurer

public interface DatasetConfigurer

Provides the ability to add datasets.

Method Summary

Modifier and Type	Method and Description
void	addDatasetModule(String moduleName, Class<? extends DatasetModule> moduleClass) Adds a DatasetModule to be deployed automatically (if absent in the CDAP namespace) during application deployment.
void	addDatasetType(Class<? extends Dataset> datasetClass) Adds a DatasetModule to be deployed automatically during application deployment, using Dataset as a base for the DatasetModule.
void	createDataset(String datasetName, Class<? extends Dataset> datasetClass) Deploys a Dataset type using the datasetClass parameter (see addDatasetType(Class)), then adds a Dataset instance, if absent in the CDAP namespace, or if the Dataset instance already exists, updates the existing instance with empty properties.
void	createDataset(String datasetName, Class<? extends Dataset> datasetClass, DatasetProperties props) Deploys a Dataset type using the datasetClass parameter (see addDatasetType(Class)), then adds a Dataset instance, if absent in the CDAP namespace, or if the Dataset instance already exists, updates the existing instance with the new properties.
void	createDataset(String datasetName, String typeName) Adds a Dataset instance with DatasetProperties.EMPTY created automatically if absent in the CDAP namespace.
void	createDataset(String datasetName, String typeName, DatasetProperties properties) Adds a Dataset instance, created automatically if absent in the CDAP namespace.

Method Detail

addDatasetModule

@Beta
void addDatasetModule(String moduleName,
                            Class<? extends DatasetModule> moduleClass)

Adds a DatasetModule to be deployed automatically (if absent in the CDAP namespace) during application deployment.

Parameters:

moduleName - Name of the module to deploy

moduleClass - Class of the module

addDatasetType

@Beta
void addDatasetType(Class<? extends Dataset> datasetClass)

Adds a DatasetModule to be deployed automatically during application deployment, using Dataset as a base for the DatasetModule. The module will have a single dataset type identical to the name of the class in the datasetClass parameter.

Parameters:

datasetClass - Class of the dataset; module name will be the same as the class in the parameter

createDataset

@Beta
void createDataset(String datasetName,
                         String typeName,
                         DatasetProperties properties)

Adds a Dataset instance, created automatically if absent in the CDAP namespace. If the Dataset instance already exists, this updates the existing instance with the new properties. See DatasetDefinition for details.

Parameters:

datasetName - name of the dataset instance

typeName - name of the dataset type

properties - dataset instance properties

createDataset

void createDataset(String datasetName,
                   String typeName)

Adds a Dataset instance with DatasetProperties.EMPTY created automatically if absent in the CDAP namespace. If the Dataset instance already exists, this updates the existing instance with the new properties.

Parameters:

datasetName - name of the dataset instance

typeName - name of the dataset type

createDataset

void createDataset(String datasetName,
                   Class<? extends Dataset> datasetClass,
                   DatasetProperties props)

Deploys a Dataset type using the datasetClass parameter (see addDatasetType(Class)), then adds a Dataset instance, if absent in the CDAP namespace, or if the Dataset instance already exists, updates the existing instance with the new properties.

Parameters:

datasetName - dataset instance name

datasetClass - dataset class to create the Dataset type from

props - dataset instance properties

createDataset

void createDataset(String datasetName,
                   Class<? extends Dataset> datasetClass)

Deploys a Dataset type using the datasetClass parameter (see addDatasetType(Class)), then adds a Dataset instance, if absent in the CDAP namespace, or if the Dataset instance already exists, updates the existing instance with empty properties.

Parameters:

datasetName - dataset instance name

datasetClass - dataset class to create the Dataset type from