xtdb-core/xtdb.api.storage/Storage/RemoteStorageFactory

RemoteStorageFactory

@Serializable

@SerialName(value = "!Remote")

data class RemoteStorageFactory(val objectStore: ObjectStoreFactory, val localDiskCache: Path, var maxCacheEntries: Long = 1024, var maxCacheBytes: Long = 536870912) : Storage.Factory

Implementation for the storage module that persists data remotely within a specified objectStore, while maintaining a local cache of the working set cache under the localDiskCache directory.

Any implementer of ObjectStoreFactory can be used as the objectStore. We currently offer:

AWS S3 (under xtdb-s3)
Azure Blob Storage (under xtdb-azure)
Google Cloud Storage (under xtdb-google-cloud)

Example usage, as part of a node config:

Xtdb.openNode {
   remoteStorage(
      objectStore = objStoreImpl(...) { ... },
      localDiskCache = Paths.get("test-path")
   ) {
      maxCacheEntries = 1024,
      maxCacheBytes = 536870912
   },
   ...
}