Skip to content

Update user guide wrt force_new #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
forman merged 2 commits into from
Mar 8, 2024
Merged

Update user guide wrt force_new #76

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
882f70a
Update user guide wrt `force_new`
forman Mar 8, 2024
b00ae1c
Update docs/guide.md
forman Mar 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions docs/guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -532,6 +532,27 @@ passed using the optional `target_storage_options` setting.
}
```

Sometimes you may want to start a new target dataset from scratch when calling
`zappend`. A typical case is testing if a given configuration yields the desired
results. The configuration flag `force_new` can be used to delete existing
target datasets (and an existing lock) upfront.

```json
{
"target_dir": "s3://wqservices/cubes/chl-2023.zarr",
"force_new": true
}
```

However, keep in mind that the deletion is not a transaction that can be rolled
back. Therefore, a log message with warning level will be emitted if the
`force_new` flag is set.

!!! danger "Setting `force_new`"
The configuration flag `force_new` will force generating a new
target dataset. If it already exists, it will be **permanently deleted**!
If the deletion fails, there will be no rollback.

### Slice Datasets

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