io.cdap.cdap.api.dataset

Interface DatasetDefinition<D extends Dataset,A extends DatasetAdmin>

Type Parameters:

D - defines data operations that can be performed on this dataset instance

A - defines administrative operations that can be performed on this dataset instance

All Known Implementing Classes:

AbstractDatasetDefinition, CompositeDatasetDefinition, CounterTimeseriesTableDefinition, IndexedObjectStoreDefinition, IndexedTableDefinition, KeyValueTableDefinition, TimeseriesTableDefinition

@Beta
public interface DatasetDefinition<D extends Dataset,A extends DatasetAdmin>

Defines named dataset type implementation. The dataset implementation defines:

• a way to configure new dataset instance by using configure(String, DatasetProperties) method
• a way to perform administrative operations on the dataset instance (e.g. create, drop etc.) by providing implementation of DatasetAdmin via getAdmin(DatasetContext, DatasetSpecification, ClassLoader) method
• a way to perform operations to manipulate data of the dataset instance (e.g. read, write etc.) by providing implementation of Dataset via getDataset(DatasetContext, DatasetSpecification, Map, ClassLoader) method

Field Summary

Fields

Modifier and Type	Field and Description
static Map<String,String>	NO_ARGUMENTS Convenience constant for passing in no arguments.

Method Summary

Modifier and Type	Method and Description
DatasetSpecification	configure(String instanceName, DatasetProperties properties) Configures new instance of the dataset.
A	getAdmin(DatasetContext datasetContext, DatasetSpecification spec, ClassLoader classLoader) Provides dataset admin to be used to perform administrative operations on the dataset instance defined by passed DatasetSpecification.
D	getDataset(DatasetContext datasetContext, DatasetSpecification spec, Map<String,String> arguments, ClassLoader classLoader) Provides dataset to be used to perform data operations on the dataset instance data defined by passed DatasetSpecification and the given arguments.
String	getName()

Field Detail

NO_ARGUMENTS

static final Map<String,String> NO_ARGUMENTS

Convenience constant for passing in no arguments.

Method Detail

getName

String getName()

Returns:

name of this dataset implementation

configure

DatasetSpecification configure(String instanceName,
                               DatasetProperties properties)

Configures new instance of the dataset.

Parameters:

instanceName - name of the instance

properties - instance configuration properties

Returns:

instance of DatasetSpecification that fully describes dataset instance. The DatasetSpecification can be used to create DatasetAdmin and Dataset to perform administrative and data operations respectively, see getAdmin(DatasetContext, DatasetSpecification, ClassLoader) and getDataset(DatasetContext, DatasetSpecification, Map, ClassLoader).

getAdmin

A getAdmin(DatasetContext datasetContext,
           DatasetSpecification spec,
           ClassLoader classLoader)
    throws IOException

Provides dataset admin to be used to perform administrative operations on the dataset instance defined by passed DatasetSpecification.

Parameters:

datasetContext - context for the dataset

spec - specification of the dataset instance.

classLoader - classloader to use when executing admin operations

Returns:

dataset admin to perform administrative operations

Throws:

IOException

getDataset

D getDataset(DatasetContext datasetContext,
             DatasetSpecification spec,
             Map<String,String> arguments,
             ClassLoader classLoader)
      throws IOException

Provides dataset to be used to perform data operations on the dataset instance data defined by passed DatasetSpecification and the given arguments.

Parameters:

datasetContext - context for the dataset

spec - specification of the dataset instance.

arguments - arguments for this instance of the dataset. Should not be null - provide an empty map for no arguments.

classLoader - classloader to use when executing dataset operations

Returns:

dataset to perform object operations

Throws:

IOException