You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: guides/Usage.md
+12-3Lines changed: 12 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -161,11 +161,15 @@ You can also pass a list of `event_ids` instead of recorded event structs to lin
161
161
162
162
There are two ways to delete streams. Soft delete and Hard delete.
163
163
164
+
Use soft delete when you no longer care about a streams events, but want to preserve the full history of events.
165
+
166
+
Use hard delete when you want a stream to go away more than a bad case of viral gastroenteritis (for example GDPR compliance).
167
+
164
168
### Soft delete
165
169
166
170
Will mark the stream as deleted, but will not delete its events. Events from soft deleted streams will still appear in the globally ordered all events ($all) stream and in any linked streams.
167
171
168
-
A soft deleted stream cannot be read nor appended to. Subscriptions to the deleted stream will not receive any events.
172
+
A soft deleted stream cannot be read nor appended to. Subscriptions to the deleted stream will not receive any events but subscriptions containing linked events from the deleted stream, such as the global all events stream, will still receive events from the deleted stream.
169
173
170
174
#### Examples
171
175
@@ -186,7 +190,7 @@ Delete stream will use soft delete by default so you can omit the type:
186
190
187
191
### Hard delete
188
192
189
-
Will permanently delete the stream and its events. This is irreversible and will remove data. Events will be removed from the globally ordered all events ($all) stream and any linked streams.
193
+
Will permanently delete the stream and its events. **This is irreversible and will remove data**. Events will be removed from the globally ordered all events ($all) stream and any linked streams.
190
194
191
195
After being hard deleted, a stream can later be appended to and read as if had never existed.
0 commit comments