Recover from an uploaded snapshot
Changed onRecover local collection data from an uploaded snapshot. This will overwrite any data, stored on this node, for the collection. If collection does not exist - it will be created.
Request
- Base URLhttp://localhost:6333
- Auth
- API key in header api-key
- or HTTP bearer
- or none
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Name of the collection
Query parameters
If true, wait for changes to actually happen. If false - let changes happen in background. Default is true.
Defines source of truth for snapshot recovery:
NoSync means - restore snapshot without any additional synchronization. Snapshot means - prefer snapshot data over the current state. Replica means - prefer existing data over the snapshot.
Defines source of truth for snapshot recovery
Optional SHA256 checksum to verify snapshot integrity before recovery.
Request body multipart/form-data
Response
successful operation
Example response
{
"time": 0.002,
"status": "ok"
}Changes
- info
api tag
Snapshotsadded - info
api tag
collectionsremoved - info
api tag
snapshotsremoved
- info