io.pivotal.gemfire.gpdb.service

Class GpdbService

java.lang.Object

io.pivotal.gemfire.gpdb.service.GpdbService

public class GpdbService
extends Object

GpdbService provides API to execute import and export operations between GemFire and Greenplum Database. It also provides an API for terminating in-progress operations.

 Examples of export with  ExportConfiguration and import with  ImportConfiguration:


 // Case 1: Operation without Event Listener.

 ExportConfiguration exportConfiguration = ExportConfiguration.builder(region).build();
 GpdbService.exportRegion(exportConfiguration);

 ImportConfiguration importConfiguration = ImportConfiguration.builder(region).build();
 GpdbService.importRegion(importConfiguration);

 // Case 2: Operation with Event Listener.

 ExportConfiguration exportConfiguration = ExportConfiguration.builder(region)
    .addOperationEventListener(listener)
    .build();
 GpdbService.exportRegion(exportConfiguration);

 ImportConfiguration importConfiguration = ImportConfiguration.builder(region)
    .addOperationEventListener(listener)
    .build();
 GpdbService.importRegion(importConfiguration);

 
 

Method Summary

Modifier and Type	Method and Description
static boolean	cancelOperation(String operationId) Terminate an operation that is in progress.
static ExportResult	exportRegion(ExportConfiguration exportConfiguration) Exports all entries from GemFire, breaking those entries up into the columns of specified Greenplum table.
static ImportResult	importRegion(ImportConfiguration importConfiguration) Import all rows from a Greenplum table, doing an upsert operation on the associated GemFire entries.

Methods inherited from class java.lang.Object

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

Method Detail

cancelOperation

public static boolean cancelOperation(String operationId)
                               throws io.pivotal.gemfire.gpdb.operations.OperationException

Terminate an operation that is in progress.

Parameters:

operationId - the operation identifier from the GGCMonitor

Returns:

true if the operation is successfully cancelled, false otherwise

Throws:

io.pivotal.gemfire.gpdb.operations.OperationException - if the cancel operation failed

exportRegion

public static ExportResult exportRegion(ExportConfiguration exportConfiguration)
                                 throws io.pivotal.gemfire.gpdb.operations.OperationException

Exports all entries from GemFire, breaking those entries up into the columns of specified Greenplum table. The process details of the export are set by exportConfiguration.

Parameters:

exportConfiguration - the object that details aspects of the configuration. See ExportConfiguration

Returns:

ExportResult details of the export operation result

Throws:

io.pivotal.gemfire.gpdb.operations.OperationException - if operation failed

importRegion

public static ImportResult importRegion(ImportConfiguration importConfiguration)
                                 throws io.pivotal.gemfire.gpdb.operations.OperationException

Import all rows from a Greenplum table, doing an upsert operation on the associated GemFire entries. The process details of the import are set by importConfiguration.

WARNING: No GemFire transactions are currently used, so this method can leave the region in an inconsistent state if the import fails.

Parameters:

importConfiguration - the object that details aspects of the configuration

Returns:

ImportResult details of the import operation result

Throws:

io.pivotal.gemfire.gpdb.operations.OperationException - if operation failed