temporalio / helm-charts

Temporal Helm charts
MIT License
312 stars 339 forks source link

[Bug] Incorrect Usage of `temporal-sql-tool` described in README #364

Closed lauerdev closed 1 year ago

lauerdev commented 1 year ago

What are you really trying to do?

Update the README to match the correct usage of the tool.

Describe the bug

The README describes two usages of the temporal-sql-tool create-database command: ./temporal-sql-tool create-database -database temporal ./temporal-sql-tool create-database -database temporal_visbility

However, per the tool's help page global arguments must be supplied prior to any commands:

NAME:
   temporal-sql-tool - Command line tool for temporal sql operations

USAGE:
   temporal-sql-tool [global options] command [command options] [arguments...]

Supplying the -database argument after the create-database command results in an "Incorrect Usage" error: Incorrect Usage: flag provided but not defined: -database

The two usages in the README should be reordered as follows: ./temporal-sql-tool -database temporal create-database ./temporal-sql-tool -database temporal_visbility create-database

Minimal Reproduction

N/A

Environment/Versions

Additional context

nkranes-frameio commented 1 year ago

./temporal-sql-tool -database temporal_visbility create-database

temporal_visibility