Package com.sleepycat.je.sync

Data synchronization framework that provides the basis for data transfer between JE Databases and external systems.

See: Description

Interface Summary

Interface	Description
ChangeReader	Retrieves all pending and unprocessed changes for one or more SyncDataSets; used only by SyncProcessor implementations and custom sources of change set information.
ChangeReader.Change	A change operation that is part of a ChangeTxn; used only by SyncProcessor implementations and custom sources of change set information.
ChangeReader.ChangeTxn	A transaction that contains one or more Changes; used only by SyncProcessor implementations and custom sources of change set information.
FieldConverter	Provides custom conversion between local field/property values and external field/column values.
RecordConverter	Provides custom data conversion between records in an external table/view and raw data records in a local database.

Class Summary

Class	Description
ExportConfig	Optional export parameters that may be passed to a sync operation.
ImportConfig	Optional import parameters that may be passed to a sync operation.
ProcessorMetadata<S extends SyncDataSet>	Used for storing a serialized form of processor-specific metadata, including a collection of SyncDataSet objects and processor connection properties; used only by SyncProcessor implementations.
RecordMapping	Defines record conversion based on the fields/properties of a Java object, and uses a JE binding to convert between local raw records and Java objects.
SyncDatabase	Defines a synchronized database as a mapping between external table/view name and local JE database name, and includes a RecordConverter for converting between local and external record data.
SyncDataSet	Defines a sychronized data set as a set of local databases to be synchronized with an external system.
SyncProcessor	Manages one or more synchronized data sets for a particular external system and processes sync operations.

Enum Summary

Enum	Description
ChangeReader.ChangeType	The operation type of a Change; used only by SyncProcessor implementations and custom sources of change set information.

Exception Summary

Exception	Description
SyncCanceledException	Thrown by a sync operation when it is explicitly canceled.

Package com.sleepycat.je.sync Description

Data synchronization framework that provides the basis for data transfer between JE Databases and external systems.

TODO (remove this list before the release)

• Add config option for amount of memory to use for consolidating txns during an export.
• Add warning: During import, a foreign key constraint on the JE side that does not match a constraint on the Oracle Server side, will cause a problem. I think this is an application design / programming error.
• Add import/export config options for number of txn retries and lock timeout.
• Document how the user should manually handle table rename / remove / truncate on the server side.
• Document cases where the user must do a full sync (refreshAll), such as JE data corruption.
• Provide a way to use JDBCSyncProcessor to perform a "custom import" where the user provides the SELECT statement for reading the change set on the server side.
• Currently the SyncProcessor.getChangeSet method can be overridden so that the user can provide a custom data set to be exported. Perhaps a better API is to allow passing the ChangeSet to the SyncProcessor constructor.
• For mobile sync, ChangeReader.ChangeTxn.markChangesPending may need to be a method on ChangeReader itself, not ChangeTxn, so that all changes in the entire set can be marked pending at once. Needs more thought.