Skip to content
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

Jump to bottom

updating docs to drop using --wipe flag #440

Merged
merged 4 commits into from
Aug 1, 2024
Merged

updating docs to drop using --wipe flag #440

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4868851
updating docs to drop using `--wipe` flag
muhamadazmy Aug 1, 2024
9a4d53b
use <NODE_NAME> instead of ${HOST}
muhamadazmy Aug 1, 2024
a6413a4
Apply PR comments
muhamadazmy Aug 1, 2024
bd68eba
apply PR comments
muhamadazmy Aug 1, 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
8 changes: 4 additions & 4 deletions docs/develop/local_dev.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,10 +117,10 @@ import clsx from "clsx";
<details>
<summary> Wiping Restate </summary>

To start the Restate Server from a clean slate and wipe ongoing invocations and K/V state:
To start the Restate Server from a clean slate, stop the server then wipe ongoing invocations and K/V state:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To start the Restate Server from a clean slate, stop the server then wipe ongoing invocations and K/V state:
To start the Restate Server from a clean slate, stop the server and then delete the data directory:


```shell
restate-server --wipe all
rm -rf <BASE_DIR>/${HOST}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe replace ${HOST} with <NODE_NAME>. By default <NODE_NAME> == ${HOST} but one can configure it to something else.

```

</details>
Expand All @@ -146,7 +146,7 @@ import clsx from "clsx";

[Cancel](/operate/invocation#cancelling-invocations) a single invocation or a batch of invocations.
Use `--kill` to [kill](/operate/invocation#killing-invocations) the invocation.
To remove all invocations, restart the server with `--wipe all`.
To remove all invocations, stop the server then do `rm -rf <BASE_DIR>/${HOST}`.

```shell
restate invocation cancel <INVOCATION_ID>
Expand All @@ -167,7 +167,7 @@ import clsx from "clsx";
<CH.Scrollycoding className={clsx("single-item", "short-code")}>

Clear the K/V state of a Virtual Object or Workflows.
To clear all state, restart the server with `--wipe all`.
To clear all state, stop the server then do `rm -rf <BASE_DIR>/${HOST}`.

```shell
restate kv clear <OBJECT_OR_WORKFLOW_NAME>
Expand Down
Loading