Skip to content

Commit 28fff99

Browse files
committed
Fix stream creation process documentation for performance tool
Fixes #44
1 parent 9824915 commit 28fff99

File tree

1 file changed

+2
-10
lines changed

1 file changed

+2
-10
lines changed

src/docs/asciidoc/performance-tool.adoc

+2-10
Original file line numberDiff line numberDiff line change
@@ -237,23 +237,15 @@ java -jar stream-perf-test.jar --streams stream1,stream2,stream3 \
237237
--producers 3 --consumers 3
238238
----
239239

240-
If you do not want the tool to create and delete streams for a run, because they are already created,
241-
use the `--pre-declared` option:
242-
243-
----
244-
java -jar stream-perf-test.jar --streams stream1,stream2,stream3 \
245-
--producers 3 --consumers 3 \
246-
--pre-declared
247-
----
248-
249240
The stream creation process has the following semantics:
250241

251242
* the tool always tries to create streams.
252243
* if the target streams already exist and have the exact same properties
253244
as the ones the tool uses (see <<performance-tool-retention,retention>> below), the
254245
run will start normally as stream creation is idempotent.
255246
* if the target streams already exist but do not have the exact same properties
256-
as the ones the tool uses, the creation process will fail, and the run will not start.
247+
as the ones the tool uses, the run will start normally as well, the tool will output a warning.
248+
* for any other errors during creation, the run will stop.
257249
* the streams are not deleted after the run.
258250
* if you want the tool to delete the streams after a run, use the `--delete-streams` flag.
259251

0 commit comments

Comments
 (0)