Skip to content

Commit 9ca3e96

Browse files
authored
Merge pull request #76 from bcdev/forman-guide_upd_wrt_force_new
Update user guide wrt `force_new`
2 parents 249b7e8 + b00ae1c commit 9ca3e96

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

docs/guide.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -532,6 +532,27 @@ passed using the optional `target_storage_options` setting.
532532
}
533533
```
534534

535+
Sometimes you may want to start a new target dataset from scratch when calling
536+
`zappend`. A typical case is testing if a given configuration yields the desired
537+
results. The configuration flag `force_new` can be used to delete existing
538+
target datasets (and an existing lock) upfront.
539+
540+
```json
541+
{
542+
"target_dir": "s3://wqservices/cubes/chl-2023.zarr",
543+
"force_new": true
544+
}
545+
```
546+
547+
However, keep in mind that the deletion is not a transaction that can be rolled
548+
back. Therefore, a log message with warning level will be emitted if the
549+
`force_new` flag is set.
550+
551+
!!! danger "Setting `force_new`"
552+
The configuration flag `force_new` will force generating a new
553+
target dataset. If it already exists, it will be **permanently deleted**!
554+
If the deletion fails, there will be no rollback.
555+
535556
### Slice Datasets
536557

537558
If the slice paths passed to the `zappend` tool are given as URIs,

0 commit comments

Comments
 (0)