-
Notifications
You must be signed in to change notification settings - Fork 805
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.
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
Fix README for cassandra tool #553
Conversation
tools/cassandra/README.md
Outdated
@@ -6,19 +6,26 @@ How | |||
--- | |||
- Run make bins | |||
- You should see an executable `cadence-cassandra-tool` | |||
- Make sure you already created cadence and visibility keyspaces (see `keyspace.cql` in schema) | |||
|
|||
Setting up initial cassandra schema on a new cluster | |||
---------------------------------------------------- | |||
``` | |||
./cadence-cassandra-tool -ep 127.0.0.1 -k cadence setup-schema -v 0.0 -- this sets up just the schema version tables with initial version of 0.0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is a make target for this. You can just replace these with
make install-schema
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
make sense, added
tools/cassandra/README.md
Outdated
@@ -6,19 +6,26 @@ How | |||
--- | |||
- Run make bins | |||
- You should see an executable `cadence-cassandra-tool` | |||
- Make sure you already created cadence and visibility keyspaces (see `keyspace.cql` in schema) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a bit confusing. Aren't we creating this using the commands below? How will the user make sure they have already created the keyspaces.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
removed
make install-schema | ||
``` | ||
|
||
Setting up schema on a new cluster manually |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think this section is necessary If folks want to dig in, they can easily look up Makefile to see command breakdown.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Never mind, I see this is a repo for tools. Ignore this.
tools/cassandra/README.md
Outdated
@@ -7,18 +7,30 @@ How | |||
- Run make bins | |||
- You should see an executable `cadence-cassandra-tool` | |||
|
|||
Setting up initial cassandra schema on a new cluster | |||
Setting up cassandra schema on a new cluster using Makefile |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can avoid "using Makefile". It's a bit confusing, Instead, you call it out as a shortcut.
No description provided.