com.gooddata.dataset

Class DatasetService

java.lang.Object

com.gooddata.AbstractService

com.gooddata.dataset.DatasetService

public class DatasetService
extends AbstractService

Service to work with datasets, manifests and dataset uploads.

Nested Class Summary

Nested classes/interfaces inherited from class com.gooddata.AbstractService

AbstractService.OutputStreamResponseExtractor

Field Summary

Fields inherited from class com.gooddata.AbstractService

mapper, restTemplate

Constructor Summary

Constructors

Constructor and Description
DatasetService(org.springframework.web.client.RestTemplate restTemplate, DataStoreService dataStoreService) Deprecated. use DatasetService(RestTemplate, DataStoreService, GoodDataSettings) constructor instead
DatasetService(org.springframework.web.client.RestTemplate restTemplate, DataStoreService dataStoreService, GoodDataSettings settings)

Method Summary

Modifier and Type	Method and Description
DatasetManifest	getDatasetManifest(Project project, String datasetId) Obtains manifest from given project by given datasetId
Upload	getLastUploadForDataset(Project project, String datasetId) Returns last upload for the dataset with given identifier in the given project.
UploadStatistics	getUploadStatistics(Project project) Returns global upload statistics for the given project.
Collection<AboutLinks.Link>	listDatasetLinks(Project project) Lists datasets (links) in project.
Collection<Dataset>	listDatasets(Project project) Deprecated. use listDatasetLinks(Project) instead
Collection<Upload>	listUploadsForDataset(Project project, String datasetId) Lists all uploads for the dataset with the given identifier in the given project.
FutureResult<Void>	loadDataset(Project project, DatasetManifest manifest, InputStream dataset) Loads dataset into platform.
FutureResult<Void>	loadDataset(Project project, String datasetId, InputStream dataset) Gets DatasetManifest (using getDatasetManifest(com.gooddata.project.Project, String) first and then calls loadDataset(com.gooddata.project.Project, DatasetManifest, java.io.InputStream)
FutureResult<Void>	loadDatasets(Project project, Collection<DatasetManifest> datasets) Loads datasets into platform.
FutureResult<Void>	loadDatasets(Project project, DatasetManifest... datasets)
FutureResult<Void>	optimizeSliHash(Project project) Optimize SLI hash.
FutureResult<Void>	updateProjectData(Project project, String maqlDml) Update project data with the given update script (MAQL).

Methods inherited from class com.gooddata.AbstractService

extractData

Methods inherited from class java.lang.Object

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

Constructor Detail

DatasetService

public DatasetService(org.springframework.web.client.RestTemplate restTemplate,
                      DataStoreService dataStoreService,
                      GoodDataSettings settings)

DatasetService

@Deprecated
public DatasetService(org.springframework.web.client.RestTemplate restTemplate,
                                  DataStoreService dataStoreService)

Deprecated. use DatasetService(RestTemplate, DataStoreService, GoodDataSettings) constructor instead

Method Detail

getDatasetManifest

public DatasetManifest getDatasetManifest(Project project,
                                          String datasetId)

Obtains manifest from given project by given datasetId

Parameters:

project - project to which manifest belongs

datasetId - id of dataset

Returns:

manifest for dataset

Throws:

DatasetNotFoundException - when manifest can't be found (doesn't exist)

DatasetException - in case the API call failure

loadDataset

public FutureResult<Void> loadDataset(Project project,
                                      DatasetManifest manifest,
                                      InputStream dataset)

Loads dataset into platform. Uploads given dataset and manifest to staging area and triggers ETL pull. The call is asynchronous returning FutureResult to let caller wait for results. Uploaded files are deleted from staging area when finished.

Parameters:

project - project to which dataset belongs

manifest - dataset manifest

dataset - dataset to upload

Returns:

FutureResult of the task, which can throw DatasetException in case the ETL pull task fails

Throws:

DatasetException - if there is a problem to serialize manifest or upload dataset

loadDataset

public FutureResult<Void> loadDataset(Project project,
                                      String datasetId,
                                      InputStream dataset)

Gets DatasetManifest (using getDatasetManifest(com.gooddata.project.Project, String) first and then calls loadDataset(com.gooddata.project.Project, DatasetManifest, java.io.InputStream)

Parameters:

project - project to which dataset belongs

datasetId - datasetId to obtain a manifest

dataset - dataset to upload

Returns:

FutureResult of the task

loadDatasets

public FutureResult<Void> loadDatasets(Project project,
                                       DatasetManifest... datasets)

loadDatasets

public FutureResult<Void> loadDatasets(Project project,
                                       Collection<DatasetManifest> datasets)

Loads datasets into platform. Uploads given datasets and their manifests to staging area and triggers ETL pull. The call is asynchronous returning FutureResult to let caller wait for results. Uploaded files are deleted from staging area when finished.

Parameters:

project - project to which dataset belongs

datasets - map dataset manifests

Returns:

FutureResult of the task, which can throw DatasetException in case the ETL pull task fails

Throws:

DatasetException - if there is a problem to serialize manifest or upload dataset

See Also:

batch upload reference

listDatasets

@Deprecated
public Collection<Dataset> listDatasets(Project project)

Deprecated. use listDatasetLinks(Project) instead

Lists datasets (links) in project. Returns empty list in case there are no datasets.

Parameters:

project - project to list datasets in

Returns:

collection of dataset links or empty list

listDatasetLinks

public Collection<AboutLinks.Link> listDatasetLinks(Project project)

Lists datasets (links) in project. Returns empty list in case there are no datasets.

Parameters:

project - project to list datasets in

Returns:

collection of dataset links or empty list

optimizeSliHash

public FutureResult<Void> optimizeSliHash(Project project)

Optimize SLI hash. This feature is useful only if data warehouse was reduced somehow. Remove unused values from the existing SLI hash.

Parameters:

project - project to optimize SLI hash in

Returns:

FutureResult of the task

updateProjectData

public FutureResult<Void> updateProjectData(Project project,
                                            String maqlDml)

Update project data with the given update script (MAQL). This method can be used for data manipulation only, for model changes use ModelService.updateProjectModel(com.gooddata.project.Project, com.gooddata.model.ModelDiff).

Parameters:

project - project to be updated

maqlDml - update script to be executed in the project

Returns:

poll result

See Also:

ModelService.updateProjectModel(com.gooddata.project.Project, com.gooddata.model.ModelDiff)

listUploadsForDataset

public Collection<Upload> listUploadsForDataset(Project project,
                                                String datasetId)

Lists all uploads for the dataset with the given identifier in the given project. Returns empty list if there are no uploads for the given dataset.

Parameters:

project - GoodData project

datasetId - dataset identifier

Returns:

collection of Upload objects or empty list

getLastUploadForDataset

public Upload getLastUploadForDataset(Project project,
                                      String datasetId)

Returns last upload for the dataset with given identifier in the given project. Returns null if the last upload doesn't exist.

Parameters:

project - GoodData project

datasetId - dataset identifier

Returns:

last dataset upload or null if the upload doesn't exist

getUploadStatistics

public UploadStatistics getUploadStatistics(Project project)

Returns global upload statistics for the given project.

Parameters:

project - GoodData project

Returns:

UploadStatistics object with project's upload statistics