Package io.cdap.cdap.api.dataset

Defines APIs for accessing and managing data within CDAP.

See: Description

Interface Summary

Interface	Description
Dataset	Implementations of this class perform data operations on dataset instance.
DatasetAdmin	Defines the minimum administrative operations a dataset should support.
DatasetDefinition<D extends Dataset,A extends DatasetAdmin>	Defines named dataset type implementation.
DatasetManager	Provides dataset management functions.
Reconfigurable	Interface implemented by DatasetDefinitions that have a way to reconfigure the dataset properties.
Updatable	Interface implemented by DatasetAdmin that have a way to update the dataset after reconfiguration.

Class Summary

Class	Description
DatasetContext	Provides access to the context for a dataset including its environment and configuration
DatasetProperties	Dataset instance properties.
DatasetProperties.Builder	A Builder to construct DatasetProperties instances.
DatasetSpecification	A DatasetSpecification is a hierarchical meta data object that contains all meta data needed to instantiate a dataset at runtime.
DatasetSpecification.Builder	A Builder to construct DatasetSpecification instances.
ExploreProperties	Useful class to configure dataset properties for Explore.
ExploreProperties.AbstractBuilder<B extends ExploreProperties.AbstractBuilder>	A builder for dataset properties for Explore.
ExploreProperties.Builder	A builder for dataset properties for Explore.

Exception Summary

Exception	Description
DataSetException	Thrown when a data operation fails.
DatasetManagementException	Thrown when there's an error during dataset modules, types or instances management operations.
IncompatibleUpdateException	Exception thrown when a dataset instance is reconfigured in an incompatible way.
InstanceConflictException	Thrown when operation conflicts with existing dataset instances available in the system.
InstanceNotFoundException	Thrown for an operation on a non-existing dataset instance.
PartitionNotFoundException	Thrown when a Partition is not found on a PartitionedFileSet.

Package io.cdap.cdap.api.dataset Description

Defines APIs for accessing and managing data within CDAP.

Implement DatasetDefinition or Dataset to define custom data set types.

Otherwise, use pre-packaged types available in the io.cdap.cdap.api.dataset.lib and io.cdap.cdap.api.dataset.table packages.