io.cdap.cdap.api.dataset

Interface DatasetAdmin

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

CompositeDatasetAdmin

@Beta
public interface DatasetAdmin
extends Closeable

Defines the minimum administrative operations a dataset should support. There are no strong strict requirements on what is expected from each operation. Every dataset implementation figures out what is the best for itself. NOTE: even though seems to be not required, the list of common operations helps to bring better structure to dataset administration design and better guide the design of new datasets.

Method Summary

Modifier and Type	Method and Description
void	create() Creates dataset.
void	drop() Drops dataset.
boolean	exists()
void	truncate() Deletes all data of the dataset.
void	upgrade() Upgrades dataset.

Methods inherited from interface java.io.Closeable

close

Method Detail

exists

boolean exists()
        throws IOException

Returns:

true if dataset exists

Throws:

IOException

create

void create()
     throws IOException

Creates dataset.

Throws:

IOException

drop

void drop()
   throws IOException

Drops dataset.

Throws:

IOException

truncate

void truncate()
       throws IOException

Deletes all data of the dataset.

Throws:

IOException

upgrade

void upgrade()
      throws IOException

Upgrades dataset.

Throws:

IOException