API

REST API for data migration and synchronization in Hegira 4Clouds.

The following resources are applicable:

/api/switchover

Mount Point: /rest/api/switchover

POST

Instructs the components (SRC and TWC) to perform a complete OFFLINE data switch over from the source to the destination databases. This type of data migration is typically not recoverable, i.e., in case of a crash of a component the data migration can be restarted from scratch.

Parameters

name description type default
source The source database identifier (e.g., DATASTORE, TABLES). query
destination The destination database identifier (e.g., DATASTORE, TABLES). query
threads The number of TWT (i.e., the number of parallel threads writing towards the target database). query

Response Body

element: status
media types: application/xml
application/json

A Status object stating whether the command has been properly executed.

/api/switchoverPartitioned

Mount Point: /rest/api/switchoverPartitioned

POST

Instructs the components (SRC and TWC) to perform a complete ONLINE data switch over from the source to the destination databases. This type of data migration should be executed in case one wants also to take advantage of data synchronization. This type of data migration is recoverable, i.e., in case of a crash of a component the data migration can be restarted from scratch.

Parameters

name description type default
source The source database identifier (e.g., DATASTORE, TABLES). query
destination The destination database identifier (e.g., DATASTORE, TABLES). query
threads The number of TWT (i.e., the number of parallel threads writing towards the target database). query
vdpSize The exponent for the base number 10 which, together, define the VDP size (e.g., 2 means that each VDP will contain 100 entities). query

Response Body

element: status
media types: application/xml
application/json

A Status object stating whether the command has been properly executed.