createSnapshot

abstract suspend fun createSnapshot(name: String, wait: Boolean = true): SnapshotDescription

Create a snapshot of the collection name; the returned SnapshotDescription.name identifies it for later download or recover.

Parameters

wait

if true (the default) return only once the snapshot exists; if false it is built in the background. Note snapshot wait defaults to true — the opposite of the mutation wait flags.

Throws

if the collection does not exist.