RootExternal class

Export & import 'archives' of selected stores and tiles, outside of the FMTC environment

Archives are backend specific, and FMTC specific. They cannot necessarily be imported by a backend different to the one that exported it. The archive may hold a similar form to the raw format of the database used by the backend, but FMTC specific information has been attached, and therefore the file will be unreadable by non-FMTC database implementations.

If the specified archive (at pathToArchive) is not of the expected format, an error from the ImportExportError group will be thrown:

Importing (especially) and exporting operations are likely to be slow. It is not recommended to attempt to use other FMTC operations during the operation, to avoid slowing it further or potentially causing inconsistent state.

Properties

hashCode → int
The hash code for this object.
no setterinherited
listStores → Future<List<String>>
List the available store names within the archive at pathToArchive
no setter
pathToArchive → String
The path to an archive file
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

export({required List<String> storeNames}) → Future<void>
Creates an archive at pathToArchive containing the specified stores and their tiles
import({List<String>? storeNames, ImportConflictStrategy strategy = ImportConflictStrategy.rename}) → ImportResult
Imports specified stores and all necessary tiles into the current root
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited