Skip to content

Commit 06310d8

Browse files
authored
Merge pull request #142 from HarperDB/plexus_start_time
add replication docs for startTime and copyTablesToCatchUp
2 parents 93ea87b + 3e99e9e commit 06310d8

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

docs/deployments/configuration.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -206,15 +206,21 @@ replication:
206206

207207
`routes` - _Type_: array;
208208

209-
An array of routes to connect to other nodes. Each element in the array can be either a string or an object with `hostname` and `port` properties.
209+
An array of routes to connect to other nodes. Each element in the array can be either a string or an object with `hostname`, `port` and optionally `startTime` properties.
210+
211+
`startTime` - _Type_: string; ISO formatted UTC date string.
212+
213+
Replication will attempt to catch up on all remote data upon setup. To start replication from a specific date, set this property.
210214

211215
```yaml
212216
replication:
217+
copyTablesToCatchUp: true
213218
hostname: server-one
214219
routes:
215220
- wss://server-two:9925 # URL based route
216221
- hostname: server-three # define a hostname and port
217222
port: 9930
223+
startTime: 2024-02-06T15:30:00Z
218224
```
219225

220226
`port` - _Type_: integer; _Default_: 9925 (the operations API port `operationsApi.port`)
@@ -229,6 +235,10 @@ The port to use for secure replication connections.
229235

230236
When true, HarperDB will verify certificates against the Node.js bundled CA store. The bundled CA store is a snapshot of the Mozilla CA store that is fixed at release time.
231237

238+
`copyTablesToCatchUp` - _Type_: boolean; _Default_: true
239+
240+
Replication will first attempt to catch up using the audit log. If unsuccessful, it will perform a full table copy. When set to `false`, replication will only use the audit log.
241+
232242
***
233243

234244
### `clustering` using NATS

0 commit comments

Comments
 (0)