org.gridgain.grid.persistentstore

Interface GridSnapshot

public interface GridSnapshot

Interface that controls GridGain snapshot.

Method Summary

Modifier and Type	Method and Description
IgniteFuture<Boolean>	cancelSnapshotOperation(IgniteUuid operationId, String msg) Tries to gracefully cancel an ongoing snapshot operation.
SnapshotFuture<List<SnapshotIssue>>	check(CheckSnapshotParams params) Verifies snapshot integrity.
SnapshotFuture<List<SnapshotIssue>>	checkSnapshot(long snapshotId, Collection<File> optSearchPaths, boolean skipCrc, String msg) Deprecated. Use check(CheckSnapshotParams).
SnapshotFuture<List<SnapshotIssue>>	checkSnapshot(long snapshotId, Collection<File> optSearchPaths, Set<String> cacheNames, boolean forceRestore, boolean skipCrc, String msg) Deprecated. Use check(CheckSnapshotParams).
SnapshotFuture<List<SnapshotIssue>>	checkSnapshot(long snapshotId, SnapshotOperationType type, Set<String> cacheNames, boolean forceRestore, Collection<File> optSearchPaths, boolean skipCrc, IgniteBiClosure<String,CacheConfiguration,CacheConfiguration> c, String msg) Deprecated. Use check(CheckSnapshotParams).
SnapshotFuture<Void>	copy(CopySnapshotParams params) Copy a snapshot with the given ID to the given destination folder.
SnapshotFuture<Void>	copySnapshot(long snapshotId, File destPath, boolean skipWalMove, org.gridgain.grid.internal.processors.cache.database.SnapshotUpdateOperationParameters operationParameters, String msg) Deprecated. Use copy(CopySnapshotParams).
SnapshotFuture<Void>	copySnapshot(long snapshotId, File destPath, boolean skipWalMove, SnapshotUpdateOperationParams updateOperationParams, String msg) Deprecated. Use copy(CopySnapshotParams).
SnapshotFuture<Void>	copySnapshot(long snapshotId, File destPath, org.gridgain.grid.internal.processors.cache.database.SnapshotUpdateOperationParameters operationParameters, String msg) Deprecated. Use copy(CopySnapshotParams).
SnapshotFuture<Void>	copySnapshot(long snapshotId, File destPath, SnapshotUpdateOperationParams operationParams, String msg) Deprecated. Use copy(CopySnapshotParams).
SnapshotFuture<Void>	createFullSnapshot(@Nullable Set<String> cacheNames, @Nullable File storePath, @Nullable org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotCommonParameters snapshotCommonParameters, @Nullable org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotCreateParameters snapshotCreateParameters, @Nullable String msg) Deprecated. Use createFullSnapshot(Set, File, SnapshotCommonParams, SnapshotCreateParams, String).
SnapshotFuture<Void>	createFullSnapshot(@Nullable Set<String> cacheNames, @Nullable File storePath, @Nullable SnapshotCommonParams snapshotCommonParams, @Nullable SnapshotCreateParams snapshotCreateParams, @Nullable String msg) Initiates full snapshot creation.
SnapshotFuture<Void>	createFullSnapshot(@Nullable Set<String> cacheNames, @Nullable File storePath, org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotCreateParameters snapshotCreateParameters, @Nullable String msg) Deprecated. Use createFullSnapshot(Set, File, SnapshotCreateParams, String).
SnapshotFuture<Void>	createFullSnapshot(@Nullable Set<String> cacheNames, @Nullable File storePath, SnapshotCreateParams snapshotCreateParams, @Nullable String msg) Initiates full snapshot creation.
SnapshotFuture<Void>	createFullSnapshot(@Nullable Set<String> includeCacheOrGroups, @Nullable Set<String> excludeCacheNames, @Nullable File storePath, @Nullable SnapshotCommonParams snapshotCommonParams, @Nullable SnapshotCreateParams snapshotCreateParams, @Nullable String msg) Initiates full snapshot creation.
SnapshotFuture<Void>	createFullSnapshot(@Nullable Set<String> cacheNames, @Nullable String msg) Initiates full snapshot creation.
SnapshotFuture<Void>	createSnapshot(@Nullable Set<String> cacheNames, @Nullable File storePath, @Nullable org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotCommonParameters snapshotCommonParameters, @Nullable org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotCreateParameters snapshotCreateParameters, @Nullable String msg) Deprecated. Use createSnapshot(Set, File, SnapshotCommonParams, SnapshotCreateParams, String).
SnapshotFuture<Void>	createSnapshot(@Nullable Set<String> cacheNames, @Nullable File storePath, @Nullable SnapshotCommonParams snapshotCommonParams, @Nullable SnapshotCreateParams snapshotCreateParams, @Nullable String msg) Initiates incremental snapshot creation.
SnapshotFuture<Void>	createSnapshot(@Nullable Set<String> cacheNames, @Nullable File storePath, org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotCreateParameters snapshotCreateParameters, @Nullable String msg) Deprecated. Use createSnapshot(Set, File, SnapshotCreateParams, String).
SnapshotFuture<Void>	createSnapshot(@Nullable Set<String> cacheNames, @Nullable File storePath, SnapshotCreateParams snapshotCreateParams, @Nullable String msg) Initiates incremental snapshot creation.
SnapshotFuture<Void>	createSnapshot(@Nullable Set<String> includeCacheOrGroups, @Nullable Set<String> excludeCachesOrGroups, @Nullable File storePath, @Nullable SnapshotCommonParams snapshotCommonParams, @Nullable SnapshotCreateParams snapshotCreateParams, @Nullable String msg) Initiates incremental snapshot creation.
SnapshotFuture<Void>	createSnapshot(@Nullable Set<String> cacheNames, @Nullable String msg) Initiates incremental snapshot creation.
SnapshotFuture<Void>	deleteSnapshot(long snapshotId, org.gridgain.grid.internal.processors.cache.database.SnapshotUpdateOperationParameters operationParameters, String msg) Deprecated. Use deleteSnapshot(long, SnapshotUpdateOperationParams, String).
SnapshotFuture<Void>	deleteSnapshot(long snapshotId, SnapshotUpdateOperationParams operationParams, String msg) Deletes snapshot from the local directory.
SnapshotFuture<Void>	deleteSnapshot(long snapshotId, String msg) Deletes snapshot from the local directory.
IgniteFuture<Boolean>	forceCancelSnapshotOperation(IgniteUuid operationId, String msg) Tries to cancel an ongoing snapshot operation.
SnapshotFuture<Void>	forceDeleteSnapshot(long snapshotId, String msg) Deprecated.
SnapshotFuture<Void>	forceMoveSnapshot(long snapshotId, File destPath, String msg) Deprecated.
List<SnapshotInfo>	list() Lists all previously created snapshots with basic info.
List<SnapshotInfo>	list(@Nullable ListSnapshotParams params) Lists all previously created snapshots with basic info.
List<SnapshotInfo>	listSnapshots(Collection<File> optSearchPaths) Deprecated. Use list(ListSnapshotParams) or list().
SnapshotFuture<Void>	move(MoveSnapshotParams params) Copy a snapshot with the given ID to the given destination folder and delete snapshot locally.
SnapshotFuture<Void>	moveSnapshot(long snapshotId, File destPath, boolean skipWalMove, org.gridgain.grid.internal.processors.cache.database.SnapshotUpdateOperationParameters operationParameters, String msg) Deprecated. Use move(MoveSnapshotParams).
SnapshotFuture<Void>	moveSnapshot(long snapshotId, File destPath, boolean skipWalMove, SnapshotUpdateOperationParams operationParams, String msg) Deprecated. Use move(MoveSnapshotParams).
SnapshotFuture<Void>	moveSnapshot(long snapshotId, File destPath, boolean skipWalMove, String msg) Deprecated. Use move(MoveSnapshotParams).
SnapshotFuture<Void>	moveSnapshot(long snapshotId, File destPath, String msg) Deprecated. Use move(MoveSnapshotParams).
SnapshotStatus	ongoingSnapshotOperation() Gets a status of an ongoing grid snapshot operation.
IgniteFuture	ongoingSnapshotOperationFuture()
SnapshotFuture<Void>	restore(RestoreSnapshotParams params) Restores snapshot identified by the given snapshot info.
SnapshotFuture<Void>	restoreSnapshot(long snapshotId, Collection<File> optSearchPaths, Set<String> cacheNames, boolean forceRestore, IgniteBiClosure<String,CacheConfiguration,CacheConfiguration> c, String msg) Deprecated. Use restore(RestoreSnapshotParams).
SnapshotFuture<Void>	restoreSnapshot(long snapshotId, Collection<File> optSearchPaths, Set<String> cacheNames, IgniteBiClosure<String,CacheConfiguration,CacheConfiguration> c, String msg) Deprecated. Use restore(RestoreSnapshotParams).
SnapshotFuture<Void>	restoreSnapshot(long snapshotId, Collection<File> optSearchPaths, Set<String> cacheNames, String msg) Deprecated. Use restore(RestoreSnapshotParams).
SnapshotFuture<Void>	restoreSnapshot(long snapshotId, Set<String> cacheNames, String msg) Deprecated. Use restore(RestoreSnapshotParams).
SnapshotInfoEx	snapshot(long snapshotId, Collection<File> optSearchPaths) Deprecated. Use snapshot(SnapshotInfoParams).
SnapshotInfoEx	snapshot(SnapshotInfoParams params) Collects extended snapshot information based on the snapshot ID.

Method Detail

createFullSnapshot

SnapshotFuture<Void> createFullSnapshot(@Nullable
                                        @Nullable Set<String> cacheNames,
                                        @Nullable
                                        @Nullable String msg)

Initiates full snapshot creation. All updates completed before this call returns are guaranteed to be included to the created snapshot. There are no guarantees regarding the updates completed after this method returns but before SnapshotFuture.initFuture() completes. Using compression option from Snapshot confugration.

Parameters:

cacheNames - Cache names to snapshot. null to create a snapshot for all caches.

msg - Additional optional user message that will be printed out to the log and will be saved in snapshot catalog.

Returns:

Snapshot future.

createFullSnapshot

@Deprecated
SnapshotFuture<Void> createFullSnapshot(@Nullable
                                                    @Nullable Set<String> cacheNames,
                                                    @Nullable
                                                    @Nullable File storePath,
                                                    org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotCreateParameters snapshotCreateParameters,
                                                    @Nullable
                                                    @Nullable String msg)

Deprecated. Use createFullSnapshot(Set, File, SnapshotCreateParams, String).

Initiates full snapshot creation. All updates completed before this call returns are guaranteed to be included to the created snapshot. There are no guarantees regarding the updates completed after this method returns but before SnapshotFuture.initFuture() completes.

Parameters:

cacheNames - Cache names to snapshot. null to create a snapshot for all caches.

storePath - Path to directory where snapshot will be stored.

snapshotCreateParameters - Additional parameters for snapshot creation.

msg - Additional optional user message that will be printed out to the log and will be saved in snapshot catalog.

Returns:

Snapshot future.

createFullSnapshot

SnapshotFuture<Void> createFullSnapshot(@Nullable
                                        @Nullable Set<String> cacheNames,
                                        @Nullable
                                        @Nullable File storePath,
                                        SnapshotCreateParams snapshotCreateParams,
                                        @Nullable
                                        @Nullable String msg)

Initiates full snapshot creation. All updates completed before this call returns are guaranteed to be included to the created snapshot. There are no guarantees regarding the updates completed after this method returns but before SnapshotFuture.initFuture() completes.

Parameters:

cacheNames - Cache names to snapshot. null to create a snapshot for all caches.

storePath - Path to directory where snapshot will be stored.

snapshotCreateParams - Additional parameters for snapshot creation.

msg - Additional optional user message that will be printed out to the log and will be saved in snapshot catalog.

Returns:

Snapshot future.

createFullSnapshot

@Deprecated
SnapshotFuture<Void> createFullSnapshot(@Nullable
                                                    @Nullable Set<String> cacheNames,
                                                    @Nullable
                                                    @Nullable File storePath,
                                                    @Nullable
                                                    @Nullable org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotCommonParameters snapshotCommonParameters,
                                                    @Nullable
                                                    @Nullable org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotCreateParameters snapshotCreateParameters,
                                                    @Nullable
                                                    @Nullable String msg)

Deprecated. Use createFullSnapshot(Set, File, SnapshotCommonParams, SnapshotCreateParams, String).

Initiates full snapshot creation. All updates completed before this call returns are guaranteed to be included to the created snapshot. There are no guarantees regarding the updates completed after this method returns but before SnapshotFuture.initFuture() completes.

Parameters:

cacheNames - Cache names to snapshot. null to create a snapshot for all caches.

storePath - Path to directory where snapshot will be stored.

snapshotCommonParameters - Additional common parameters for snapshot operation.

snapshotCreateParameters - Additional parameters for snapshot creation.

msg - Additional optional user message that will be printed out to the log and will be saved in snapshot catalog.

Returns:

Snapshot future.

createFullSnapshot

SnapshotFuture<Void> createFullSnapshot(@Nullable
                                        @Nullable Set<String> cacheNames,
                                        @Nullable
                                        @Nullable File storePath,
                                        @Nullable
                                        @Nullable SnapshotCommonParams snapshotCommonParams,
                                        @Nullable
                                        @Nullable SnapshotCreateParams snapshotCreateParams,
                                        @Nullable
                                        @Nullable String msg)

Initiates full snapshot creation. All updates completed before this call returns are guaranteed to be included to the created snapshot. There are no guarantees regarding the updates completed after this method returns but before SnapshotFuture.initFuture() completes.

Parameters:

cacheNames - Cache names to snapshot. null to create a snapshot for all caches.

storePath - Path to directory where snapshot will be stored.

snapshotCommonParams - Additional common parameters for snapshot operation.

snapshotCreateParams - Additional parameters for snapshot creation.

msg - Additional optional user message that will be printed out to the log and will be saved in snapshot catalog.

Returns:

Snapshot future.

createFullSnapshot

SnapshotFuture<Void> createFullSnapshot(@Nullable
                                        @Nullable Set<String> includeCacheOrGroups,
                                        @Nullable
                                        @Nullable Set<String> excludeCacheNames,
                                        @Nullable
                                        @Nullable File storePath,
                                        @Nullable
                                        @Nullable SnapshotCommonParams snapshotCommonParams,
                                        @Nullable
                                        @Nullable SnapshotCreateParams snapshotCreateParams,
                                        @Nullable
                                        @Nullable String msg)

Initiates full snapshot creation.

Parameters:

includeCacheOrGroups - Caches or groups included to snapshot, null to create a snapshot for all caches.

excludeCacheNames - Cache or groups excluded from snapshot, null no caches will be excluded.

storePath - Path to directory where snapshot will be stored.

snapshotCommonParams - Additional common parameters for snapshot operation.

snapshotCreateParams - Additional parameters for snapshot creation.

msg - Additional optional user message that will be printed out to the log and will be saved in snapshot catalog.

Returns:

Snapshot future.

createSnapshot

SnapshotFuture<Void> createSnapshot(@Nullable
                                    @Nullable Set<String> cacheNames,
                                    @Nullable
                                    @Nullable String msg)

Initiates incremental snapshot creation. All updates completed before this call returns are guaranteed to be included to the created snapshot. There are no guarantees regarding the updates completed after this method returns but before SnapshotFuture.initFuture() completes. If incremental snapshot creation is not possible (there is no previously created full snapshot available), the returned future will be completed with a corresponding error. Using compression option from Snapshot configuration.

Parameters:

cacheNames - Cache names to snapshot. null to create a snapshot for all caches.

msg - Additional optional user message that will be printed out to the log and will be saved in snapshot catalog.

Returns:

Snapshot future.

createSnapshot

@Deprecated
SnapshotFuture<Void> createSnapshot(@Nullable
                                                @Nullable Set<String> cacheNames,
                                                @Nullable
                                                @Nullable File storePath,
                                                org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotCreateParameters snapshotCreateParameters,
                                                @Nullable
                                                @Nullable String msg)

Deprecated. Use createSnapshot(Set, File, SnapshotCreateParams, String).

Initiates incremental snapshot creation. All updates completed before this call returns are guaranteed to be included to the created snapshot. There are no guarantees regarding the updates completed after this method returns but before SnapshotFuture.initFuture() completes. If incremental snapshot creation is not possible (there is no previously created full snapshot available), the returned future will be completed with a corresponding error.

Parameters:

cacheNames - Cache names to snapshot. null to create a snapshot for all caches.

storePath - Path to directory where snapshot will be stored.

snapshotCreateParameters - Additional parameters for snapshot creation.

msg - Additional optional user message that will be printed out to the log and will be saved in snapshot catalog.

Returns:

Snapshot future.

createSnapshot

SnapshotFuture<Void> createSnapshot(@Nullable
                                    @Nullable Set<String> cacheNames,
                                    @Nullable
                                    @Nullable File storePath,
                                    SnapshotCreateParams snapshotCreateParams,
                                    @Nullable
                                    @Nullable String msg)

Initiates incremental snapshot creation. All updates completed before this call returns are guaranteed to be included to the created snapshot. There are no guarantees regarding the updates completed after this method returns but before SnapshotFuture.initFuture() completes. If incremental snapshot creation is not possible (there is no previously created full snapshot available), the returned future will be completed with a corresponding error.

Parameters:

cacheNames - Cache names to snapshot. null to create a snapshot for all caches.

storePath - Path to directory where snapshot will be stored.

snapshotCreateParams - Additional parameters for snapshot creation.

msg - Additional optional user message that will be printed out to the log and will be saved in snapshot catalog.

Returns:

Snapshot future.

createSnapshot

@Deprecated
SnapshotFuture<Void> createSnapshot(@Nullable
                                                @Nullable Set<String> cacheNames,
                                                @Nullable
                                                @Nullable File storePath,
                                                @Nullable
                                                @Nullable org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotCommonParameters snapshotCommonParameters,
                                                @Nullable
                                                @Nullable org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotCreateParameters snapshotCreateParameters,
                                                @Nullable
                                                @Nullable String msg)

Deprecated. Use createSnapshot(Set, File, SnapshotCommonParams, SnapshotCreateParams, String).

Initiates incremental snapshot creation. All updates completed before this call returns are guaranteed to be included to the created snapshot. There are no guarantees regarding the updates completed after this method returns but before SnapshotFuture.initFuture() completes. If incremental snapshot creation is not possible (there is no previously created full snapshot available), the returned future will be completed with a corresponding error.

Parameters:

cacheNames - Cache names to snapshot. null to create a snapshot for all caches.

storePath - Path to directory where snapshot will be stored.

snapshotCommonParameters - Additional common parameters for snapshot operation.

snapshotCreateParameters - Additional parameters for snapshot creation.

msg - Additional optional user message that will be printed out to the log and will be saved in snapshot catalog.

Returns:

Snapshot future.

createSnapshot

SnapshotFuture<Void> createSnapshot(@Nullable
                                    @Nullable Set<String> cacheNames,
                                    @Nullable
                                    @Nullable File storePath,
                                    @Nullable
                                    @Nullable SnapshotCommonParams snapshotCommonParams,
                                    @Nullable
                                    @Nullable SnapshotCreateParams snapshotCreateParams,
                                    @Nullable
                                    @Nullable String msg)

Initiates incremental snapshot creation. All updates completed before this call returns are guaranteed to be included to the created snapshot. There are no guarantees regarding the updates completed after this method returns but before SnapshotFuture.initFuture() completes. If incremental snapshot creation is not possible (there is no previously created full snapshot available), the returned future will be completed with a corresponding error.

Parameters:

cacheNames - Cache names to snapshot. null to create a snapshot for all caches.

storePath - Path to directory where snapshot will be stored.

snapshotCommonParams - Additional common parameters for snapshot operation.

snapshotCreateParams - Additional parameters for snapshot creation.

msg - Additional optional user message that will be printed out to the log and will be saved in snapshot catalog.

Returns:

Snapshot future.

createSnapshot

SnapshotFuture<Void> createSnapshot(@Nullable
                                    @Nullable Set<String> includeCacheOrGroups,
                                    @Nullable
                                    @Nullable Set<String> excludeCachesOrGroups,
                                    @Nullable
                                    @Nullable File storePath,
                                    @Nullable
                                    @Nullable SnapshotCommonParams snapshotCommonParams,
                                    @Nullable
                                    @Nullable SnapshotCreateParams snapshotCreateParams,
                                    @Nullable
                                    @Nullable String msg)

Initiates incremental snapshot creation.

Parameters:

includeCacheOrGroups - Cache names to snapshot, null to create a snapshot for all caches.

excludeCachesOrGroups - Cache or groups excluded from scope of operation, null no caches will be excluded.

storePath - Path to directory where snapshot will be stored.

snapshotCommonParams - Additional common parameters for snapshot operation.

snapshotCreateParams - Additional parameters for snapshot creation.

msg - Additional optional user message that will be printed out to the log and will be saved in snapshot catalog.

Returns:

Snapshot future.

listSnapshots

@Deprecated
List<SnapshotInfo> listSnapshots(Collection<File> optSearchPaths)

Deprecated. Use list(ListSnapshotParams) or list().

Lists all previously created snapshots with basic info. If optSearchPaths is not empty, will try to read and merge snapshot chains from the specified search paths as well.

Parameters:

optSearchPaths - An optional collection of search paths to search for snapshots.

Returns:

A sorted list of found snapshot infos.

list

List<SnapshotInfo> list()

Lists all previously created snapshots with basic info.

Returns:

A sorted list of found snapshot infos.

list

List<SnapshotInfo> list(@Nullable
                        @Nullable ListSnapshotParams params)

Lists all previously created snapshots with basic info. If optSearchPaths is not empty, will try to read and merge snapshot chains from the specified search paths as well.

Parameters:

params - Parameters for list operation.

Returns:

A sorted list of found snapshot infos.

snapshot

@Deprecated
SnapshotInfoEx snapshot(long snapshotId,
                                    Collection<File> optSearchPaths)

Deprecated. Use snapshot(SnapshotInfoParams).

Collects extended snapshot information based on the snapshot ID. If optSearchPaths is not empty, will try to read and merge snapshot chains from the specified search paths as well.

Parameters:

optSearchPaths - An optional collection of search paths to search for snapshots.

Returns:

Extended snapshot info for specified ID.

snapshot

SnapshotInfoEx snapshot(SnapshotInfoParams params)

Collects extended snapshot information based on the snapshot ID. If optSearchPaths is not empty, will try to read and merge snapshot chains from the specified search paths as well.

Parameters:

params - Parameters for operation.

Returns:

Extended snapshot info for specified ID.

restoreSnapshot

@Deprecated
SnapshotFuture<Void> restoreSnapshot(long snapshotId,
                                                 Set<String> cacheNames,
                                                 String msg)

Deprecated. Use restore(RestoreSnapshotParams).

Restores snapshot identified by the given snapshot ID. If a cache with the given name already exists, it will be destroyed and contents will be applied in-place. If snapshot restore fails, the previous state of the cache being restored will be preserved.

Parameters:

snapshotId - ID of snapshot to restore.

cacheNames - Collection of cache names to restore from this snapshot. If null, all saved caches will be restored.

msg - Additional optional user message that will be printed out to the log and will be saved in the snapshot catalog.

Returns:

Future that will be completed once the snapshot is restored.

restoreSnapshot

@Deprecated
SnapshotFuture<Void> restoreSnapshot(long snapshotId,
                                                 Collection<File> optSearchPaths,
                                                 Set<String> cacheNames,
                                                 String msg)

Deprecated. Use restore(RestoreSnapshotParams).

Restores snapshot identified by the given snapshot info. If a cache with the given name already exists, it will be destroyed and contents will be applied in-place. If snapshot restore fails, the previous state of the cache being restored will be preserved.

Parameters:

optSearchPaths - Optional path to search for snapshots data. If a snapshot was moved to an external directory or was initially created in custom directory, this external directory may be specified in this parameter for a snapshot restore.

snapshotId - ID of snapshot to restore. If a cache with the given name already exists, it will be destroyed and contents will be applied in-place. This operations (destroy and restore) are not atomic, so it is recommended to create a snapshot before restoring the data.

cacheNames - Collection of cache names to restore from this snapshot. If null, all saved caches will be restored.

msg - Additional optional user message that will be printed out to the log and will be saved in snapshot catalog.

Returns:

Future that will be completed once the snapshot is restored.

See Also:

moveSnapshot(long, File, String)

restoreSnapshot

@Deprecated
SnapshotFuture<Void> restoreSnapshot(long snapshotId,
                                                 Collection<File> optSearchPaths,
                                                 Set<String> cacheNames,
                                                 IgniteBiClosure<String,CacheConfiguration,CacheConfiguration> c,
                                                 String msg)

Deprecated. Use restore(RestoreSnapshotParams).

Restores snapshot identified by the given snapshot info. If a cache with the given name already exists, it will be destroyed and contents will be applied in-place. If snapshot restore fails, the previous state of the cache being restored will be preserved.

Parameters:

optSearchPaths - Optional path to search for snapshots data. If a snapshot was moved to an external directory or was initially created in custom directory, this external directory may be specified in this parameter for a snapshot restore.

snapshotId - ID of snapshot to restore. If a cache with the given name already exists, it will be destroyed and contents will be applied in-place. This operations (destroy and restore) are not atomic, so it is recommended to create a snapshot before restoring the data.

cacheNames - Collection of cache names to restore from this snapshot. If null, all saved caches will be restored.

c - Optional closure for CacheConfiguration conversion during snapshot restore.

msg - Additional optional user message that will be printed out to the log and will be saved in snapshot catalog.

Returns:

Future that will be completed once the snapshot is restored.

See Also:

moveSnapshot(long, File, String)

restoreSnapshot

@Deprecated
SnapshotFuture<Void> restoreSnapshot(long snapshotId,
                                                 Collection<File> optSearchPaths,
                                                 Set<String> cacheNames,
                                                 boolean forceRestore,
                                                 IgniteBiClosure<String,CacheConfiguration,CacheConfiguration> c,
                                                 String msg)

Deprecated. Use restore(RestoreSnapshotParams).

Restores snapshot identified by the given snapshot info. If a cache with the given name already exists, it will be destroyed and contents will be applied in-place. If snapshot restore fails, the previous state of the cache being restored will be preserved.

Parameters:

snapshotId - ID of snapshot to restore. If a cache with the given name already exists, it will be destroyed and contents will be applied in-place. This operations (destroy and restore) are not atomic, so it is recommended to create a snapshot before restoring the data.

optSearchPaths - Optional path to search for snapshots data. If a snapshot was moved to an external directory or was initially created in custom directory, this external directory may be specified in this parameter for a snapshot restore.

cacheNames - Collection of cache names to restore from this snapshot. If null, all saved caches will be restored.

forceRestore - flag indicating restore force: if newly created cache in group may be destroyed by this restore, default is false.

c - Optional closure for CacheConfiguration conversion during snapshot restore.

msg - Additional optional user message that will be printed out to the log and will be saved in snapshot catalog.

Returns:

Future that will be completed once the snapshot is restored.

See Also:

moveSnapshot(long, File, String)

restore

SnapshotFuture<Void> restore(RestoreSnapshotParams params)

Restores snapshot identified by the given snapshot info. If a cache with the given name already exists, it will be destroyed and contents will be applied in-place. If snapshot restore fails, the previous state of the cache being restored will be preserved.

Parameters:

params - Parameters for restore operation.

Returns:

Future that will be completed once the snapshot is restored.

See Also:

move(MoveSnapshotParams)

deleteSnapshot

SnapshotFuture<Void> deleteSnapshot(long snapshotId,
                                    String msg)

Deletes snapshot from the local directory. Will fail if there is a dependent snapshot (use forceDeleteSnapshot(long, String) in this case).

Parameters:

snapshotId - ID of snapshot to delete.

msg - Additional optional user message that will be printed out to the log and will be saved in snapshot catalog.

Returns:

Future that will be completed once the snapshot is deleted.

deleteSnapshot

@Deprecated
SnapshotFuture<Void> deleteSnapshot(long snapshotId,
                                                org.gridgain.grid.internal.processors.cache.database.SnapshotUpdateOperationParameters operationParameters,
                                                String msg)

Deprecated. Use deleteSnapshot(long, SnapshotUpdateOperationParams, String).

Deletes snapshot from the local directory. Will fail if there is a dependent snapshot (use forceDeleteSnapshot(long, String) in this case).

Parameters:

snapshotId - ID of snapshot to delete.

operationParameters - Additional operation parameters.

msg - Additional optional user message that will be printed out to the log and will be saved in snapshot catalog.

Returns:

Future that will be completed once the snapshot is deleted.

deleteSnapshot

SnapshotFuture<Void> deleteSnapshot(long snapshotId,
                                    SnapshotUpdateOperationParams operationParams,
                                    String msg)

Deletes snapshot from the local directory. Will fail if there is a dependent snapshot (use forceDeleteSnapshot(long, String) in this case).

Parameters:

snapshotId - ID of snapshot to delete.

operationParams - Additional operation params.

msg - Additional optional user message that will be printed out to the log and will be saved in snapshot catalog.

Returns:

Future that will be completed once the snapshot is deleted.

forceDeleteSnapshot

@Deprecated
SnapshotFuture<Void> forceDeleteSnapshot(long snapshotId,
                                                     String msg)

Deprecated.

Deletes snapshot from the local directory. Will also remove all dependent snapshots.

Parameters:

snapshotId - Snapshot ID to delete.

msg - Additional optional user message that will be printed out to the log and will be saved in snapshot catalog.

Returns:

Future that will be completed once the snapshot is deleted.

checkSnapshot

@Deprecated
SnapshotFuture<List<SnapshotIssue>> checkSnapshot(long snapshotId,
                                                              Collection<File> optSearchPaths,
                                                              boolean skipCrc,
                                                              String msg)

Deprecated. Use check(CheckSnapshotParams).

Verifies snapshot integrity. Will check availability of all partitions, metadata consistency and will verify the physical integrity of snapshot files.

Parameters:

snapshotId - Snapshot ID to check.

optSearchPaths - Optional path to search for snapshots data. If a snapshot was moved to an external directory or was initially created in custom directory, this external directory may be specified in this parameter for a snapshot restore.

skipCrc - Flag to skip CRC check.

msg - Additional optional user message that will be printed out to the log and will be saved in snapshot catalog.

Returns:

Future that will be completed once the snapshot check is completed. The future result will contain all found issues, if any.

checkSnapshot

@Deprecated
SnapshotFuture<List<SnapshotIssue>> checkSnapshot(long snapshotId,
                                                              Collection<File> optSearchPaths,
                                                              Set<String> cacheNames,
                                                              boolean forceRestore,
                                                              boolean skipCrc,
                                                              String msg)

Deprecated. Use check(CheckSnapshotParams).

Verifies snapshot integrity. Will check availability of all partitions, metadata consistency and will verify the physical integrity of snapshot files.

Parameters:

snapshotId - Snapshot ID to check.

optSearchPaths - Optional path to search for snapshots data. If a snapshot was moved to an external directory or was initially created in custom directory, this external directory may be specified in this parameter for a snapshot restore.

cacheNames - Collection of cache names to check for restore. If null, all saved caches will be checked.

forceRestore - check snapshot for force restore or not, default is false.

skipCrc - Flag to skip CRC check.

msg - Additional optional user message that will be printed out to the log and will be saved in snapshot catalog.

Returns:

Future that will be completed once the snapshot check is completed. The future result will contain all found issues, if any.

checkSnapshot

@Deprecated
SnapshotFuture<List<SnapshotIssue>> checkSnapshot(long snapshotId,
                                                              SnapshotOperationType type,
                                                              Set<String> cacheNames,
                                                              boolean forceRestore,
                                                              Collection<File> optSearchPaths,
                                                              boolean skipCrc,
                                                              IgniteBiClosure<String,CacheConfiguration,CacheConfiguration> c,
                                                              String msg)

Deprecated. Use check(CheckSnapshotParams).

Verifies snapshot integrity. Will check availability of all partitions, metadata consistency and will verify the physical integrity of snapshot files.

Parameters:

snapshotId - Snapshot ID to check.

optSearchPaths - Optional path to search for snapshots data. If a snapshot was moved to an external directory or was initially created in custom directory, this external directory may be specified in this parameter for a snapshot restore.

cacheNames - Collection of cache names to check for restore. If null, all saved caches will be checked.

forceRestore - check snapshot for force restore or not, default is false.

skipCrc - Flag to skip CRC check.

c - Optional closure for CacheConfiguration conversion during snapshot restore.

msg - Additional optional user message that will be printed out to the log and will be saved in snapshot catalog.

Returns:

Future that will be completed once the snapshot check is completed. The future result will contain all found issues, if any.

check

SnapshotFuture<List<SnapshotIssue>> check(CheckSnapshotParams params)

Verifies snapshot integrity. Will check availability of all partitions, metadata consistency and will verify the physical integrity of snapshot files.

Parameters:

params - Parameters for operation.

Returns:

Future that will be completed once the snapshot check is completed. The future result will contain all found issues, if any.

moveSnapshot

@Deprecated
SnapshotFuture<Void> moveSnapshot(long snapshotId,
                                              File destPath,
                                              String msg)

Deprecated. Use move(MoveSnapshotParams).

Copy a snapshot with the given ID to the given destination folder and delete snapshot locally. Will fails if there are dependent snapshots (use forceMoveSnapshot(long, File, String) in this case).

Parameters:

snapshotId - Snapshot ID to move.

destPath - Destination path.

msg - Additional optional user message that will be printed out to the log and will be saved in snapshot catalog.

Returns:

Future that will be completed once the snapshot is moved.

forceMoveSnapshot

@Deprecated
SnapshotFuture<Void> forceMoveSnapshot(long snapshotId,
                                                   File destPath,
                                                   String msg)

Deprecated.

Copy a snapshot with the given ID to the given destination folder and delete snapshot locally. Will also move all dependant snapshots.

Parameters:

snapshotId - Snapshot ID to move.

destPath - Destination path.

msg - Additional optional user message that will be printed out to the log and will be saved in snapshot catalog.

Returns:

Future that will be completed once the snapshot is restored.

moveSnapshot

@Deprecated
SnapshotFuture<Void> moveSnapshot(long snapshotId,
                                              File destPath,
                                              boolean skipWalMove,
                                              String msg)

Deprecated. Use move(MoveSnapshotParams).

Copy a snapshot with the given ID to the given destination folder and delete snapshot locally.

Parameters:

snapshotId - Snapshot ID to move.

destPath - Destination path.

skipWalMove - If true then skip moving WAL files in PITR case.

msg - Additional user message to log.

Returns:

Future that will be completed once the snapshot is restored.

moveSnapshot

@Deprecated
SnapshotFuture<Void> moveSnapshot(long snapshotId,
                                              File destPath,
                                              boolean skipWalMove,
                                              org.gridgain.grid.internal.processors.cache.database.SnapshotUpdateOperationParameters operationParameters,
                                              String msg)

Deprecated. Use move(MoveSnapshotParams).

Copy a snapshot with the given ID to the given destination folder and delete snapshot locally.

Parameters:

snapshotId - Snapshot ID to move.

destPath - Destination path.

skipWalMove - If true then skip moving WAL files in PITR case.

msg - Additional user message to log.

operationParameters - Additional operation parameters.

Returns:

Future that will be completed once the snapshot is restored.

moveSnapshot

@Deprecated
SnapshotFuture<Void> moveSnapshot(long snapshotId,
                                              File destPath,
                                              boolean skipWalMove,
                                              SnapshotUpdateOperationParams operationParams,
                                              String msg)

Deprecated. Use move(MoveSnapshotParams).

Copy a snapshot with the given ID to the given destination folder and delete snapshot locally.

Parameters:

snapshotId - Snapshot ID to move.

destPath - Destination path.

skipWalMove - If true then skip moving WAL files in PITR case.

msg - Additional user message to log.

operationParams - Additional operation parameters.

Returns:

Future that will be completed once the snapshot is restored.

move

SnapshotFuture<Void> move(MoveSnapshotParams params)

Copy a snapshot with the given ID to the given destination folder and delete snapshot locally.

Parameters:

params - Parameters for operation.

Returns:

Future that will be completed once the snapshot is restored.

copySnapshot

@Deprecated
SnapshotFuture<Void> copySnapshot(long snapshotId,
                                              File destPath,
                                              org.gridgain.grid.internal.processors.cache.database.SnapshotUpdateOperationParameters operationParameters,
                                              String msg)

Deprecated. Use copy(CopySnapshotParams).

Copy a snapshot with the given ID to the given destination folder.

Parameters:

snapshotId - Snapshot ID to move.

destPath - Destination path.

operationParameters - Additional operation parameters.

msg - Additional user message to log.

Returns:

Future that will be completed once the snapshot is copied.

copySnapshot

@Deprecated
SnapshotFuture<Void> copySnapshot(long snapshotId,
                                              File destPath,
                                              SnapshotUpdateOperationParams operationParams,
                                              String msg)

Deprecated. Use copy(CopySnapshotParams).

Copy a snapshot with the given ID to the given destination folder.

Parameters:

snapshotId - Snapshot ID to move.

destPath - Destination path.

operationParams - Additional operation params.

msg - Additional user message to log.

Returns:

Future that will be completed once the snapshot is copied.

copySnapshot

@Deprecated
SnapshotFuture<Void> copySnapshot(long snapshotId,
                                              File destPath,
                                              boolean skipWalMove,
                                              org.gridgain.grid.internal.processors.cache.database.SnapshotUpdateOperationParameters operationParameters,
                                              String msg)

Deprecated. Use copy(CopySnapshotParams).

Copy a snapshot with the given ID to the given destination folder.

Parameters:

snapshotId - Snapshot ID to move.

destPath - Destination path.

skipWalMove - If true then skip moving WAL files in PITR case.

operationParameters - Additional operation parameters.

msg - Additional user message to log.

Returns:

Future that will be completed once the snapshot is copied.

copySnapshot

@Deprecated
SnapshotFuture<Void> copySnapshot(long snapshotId,
                                              File destPath,
                                              boolean skipWalMove,
                                              SnapshotUpdateOperationParams updateOperationParams,
                                              String msg)

Deprecated. Use copy(CopySnapshotParams).

Copy a snapshot with the given ID to the given destination folder.

Parameters:

snapshotId - Snapshot ID to move.

destPath - Destination path.

skipWalMove - If true then skip moving WAL files in PITR case.

updateOperationParams - Additional operation params.

msg - Additional user message to log.

Returns:

Future that will be completed once the snapshot is copied.

copy

SnapshotFuture<Void> copy(CopySnapshotParams params)

Copy a snapshot with the given ID to the given destination folder.

Parameters:

params - Snapshot ID to move.

Returns:

Future that will be completed once the snapshot is copied.

ongoingSnapshotOperation

SnapshotStatus ongoingSnapshotOperation()

Gets a status of an ongoing grid snapshot operation. If there are no ongoing snapshot tasks, will return null.

Returns:

Ongoing snapshot operation status or null if there is none.

ongoingSnapshotOperationFuture

IgniteFuture ongoingSnapshotOperationFuture()

Returns:

Future if there is any snapshot activity, null if there is none. Future will be completed when snapshot operation completes.

cancelSnapshotOperation

IgniteFuture<Boolean> cancelSnapshotOperation(IgniteUuid operationId,
                                              String msg)

Tries to gracefully cancel an ongoing snapshot operation.

Parameters:

operationId - Operation ID to cancel.

msg - Additional optional user message that will be printed out to the log and will be saved in snapshot catalog.

forceCancelSnapshotOperation

IgniteFuture<Boolean> forceCancelSnapshotOperation(IgniteUuid operationId,
                                                   String msg)

Tries to cancel an ongoing snapshot operation. Forcible cancellation will try to cancel an ongoing operation as fast as possible. This means that if there is any intermediate state left on disk, then this state will be left as-is. If snapshot restore is forcibly cancelled, previous state of the storage is not guaranteed to be preserved.

Parameters:

operationId - Operation ID to cancel.

msg - Additional optional user message that will be printed out to the log and will be saved in snapshot catalog.