co.cask.cdap.data2.datafabric.dataset.service

Class DatasetInstanceService

java.lang.Object

co.cask.cdap.data2.datafabric.dataset.service.DatasetInstanceService

public class DatasetInstanceService
extends Object

Handles dataset instance management calls.

Constructor Summary

Constructors

Constructor and Description
DatasetInstanceService(DatasetTypeManager implManager, DatasetInstanceManager instanceManager, DatasetOpExecutor opExecutorClient, ExploreFacade exploreFacade, CConfiguration conf, co.cask.tephra.TransactionExecutorFactory txFactory, DatasetDefinitionRegistryFactory registryFactory, NamespaceStore nsStore)

Method Summary

Methods

Modifier and Type	Method and Description
void	create(String namespaceId, String name, DatasetInstanceConfiguration props) Creates a dataset instance.
void	drop(Id.DatasetInstance instance) Drops the specified dataset instance.
DatasetAdminOpResponse	executeAdmin(Id.DatasetInstance instance, String method) Executes an admin operation on a dataset instance.
DatasetMeta	get(Id.DatasetInstance instance, List<? extends Id> owners) Gets a dataset instance.
Collection<co.cask.cdap.api.dataset.DatasetSpecification>	list(Id.Namespace namespace) Lists all dataset instances in a namespace.
void	update(Id.DatasetInstance instance, Map<String,String> properties) Updates an existing Dataset specification properties.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DatasetInstanceService

@Inject
public DatasetInstanceService(DatasetTypeManager implManager,
                             DatasetInstanceManager instanceManager,
                             DatasetOpExecutor opExecutorClient,
                             ExploreFacade exploreFacade,
                             CConfiguration conf,
                             co.cask.tephra.TransactionExecutorFactory txFactory,
                             DatasetDefinitionRegistryFactory registryFactory,
                             NamespaceStore nsStore)

Method Detail

list

public Collection<co.cask.cdap.api.dataset.DatasetSpecification> list(Id.Namespace namespace)
                                                               throws Exception

Lists all dataset instances in a namespace.

Parameters:

namespace - the namespace to list datasets for

Returns:

the dataset instances in the provided namespace

Throws:

NotFoundException - if the namespace was not found

IOException - if there is a problem in making an HTTP request to check if the namespace exists.

Exception

get

public DatasetMeta get(Id.DatasetInstance instance,
              List<? extends Id> owners)
                throws Exception

Gets a dataset instance.

Parameters:

instance - instance to get

owners - the Ids that will be using the dataset instance

Returns:

the dataset instance's DatasetMeta

Throws:

NotFoundException - if either the namespace or dataset instance is not found,

IOException - if there is a problem in making an HTTP request to check if the namespace exists.

Exception

create

public void create(String namespaceId,
          String name,
          DatasetInstanceConfiguration props)
            throws Exception

Creates a dataset instance.

Parameters:

namespaceId - the namespace to create the dataset instance in

name - the name of the new dataset instance

props - the properties for the new dataset instance

Throws:

NamespaceNotFoundException - if the specified namespace was not found

DatasetAlreadyExistsException - if a dataset with the same name already exists

DatasetTypeNotFoundException - if the dataset type was not found

Exception - if something went wrong

update

public void update(Id.DatasetInstance instance,
          Map<String,String> properties)
            throws Exception

Updates an existing Dataset specification properties. DatasetInstanceConfiguration is constructed based on request and the Dataset instance is updated.

Parameters:

instance - the dataset instance

properties - the dataset properties to be used

Throws:

NamespaceNotFoundException - if the specified namespace was not found

DatasetNotFoundException - if the dataset was not found

DatasetTypeNotFoundException - if the type of the existing dataset was not found

Exception

drop

public void drop(Id.DatasetInstance instance)
          throws Exception

Drops the specified dataset instance.

Parameters:

instance - the Id.DatasetInstance to drop

Throws:

NamespaceNotFoundException - if the namespace was not found

DatasetNotFoundException - if the dataset instance was not found

IOException - if there was a problem in checking if the namespace exists over HTTP

Exception

executeAdmin

public DatasetAdminOpResponse executeAdmin(Id.DatasetInstance instance,
                                  String method)
                                    throws Exception

Executes an admin operation on a dataset instance.

Parameters:

instance - the instance to execute the admin operation on

method - the type of admin operation to execute

Returns:

the DatasetAdminOpResponse from the HTTP handler

Throws:

NamespaceNotFoundException - if the requested namespace was not found

IOException - if there was a problem in checking if the namespace exists over HTTP

Exception