mirror of
https://github.com/nosqlbench/nosqlbench.git
synced 2024-11-28 19:44:02 -06:00
doc updates
This commit is contained in:
parent
4dd86283d4
commit
2c76b40ff2
@ -31,7 +31,7 @@ CREATE TABLE baselines.keyvalue (
|
||||
|
||||
Let's break down each of those command line options.
|
||||
|
||||
`start` tells nosqlbench to start an activity.
|
||||
`run` tells nosqlbench to run an activity.
|
||||
|
||||
`driver=...` is used to specify the activity type (driver). In this case we are using `cql`, which tells nosqlbench to
|
||||
use the DataStax Java Driver and execute CQL statements against a database.
|
||||
@ -58,7 +58,7 @@ generating for CQL statements.
|
||||
|
||||
Go ahead and execute the following command:
|
||||
|
||||
./nb start driver=stdout workload=cql-keyvalue tags=phase:rampup cycles=10
|
||||
./nb run driver=stdout workload=cql-keyvalue tags=phase:rampup cycles=10
|
||||
|
||||
You should see 10 of the following statements in your console
|
||||
|
||||
@ -79,7 +79,7 @@ NoSQLBench deterministically generates data, so the generated values will be the
|
||||
|
||||
Now we are ready to write some data to our database. Go ahead and execute the following from your command line:
|
||||
|
||||
./nb start driver=cql workload=cql-keyvalue tags=phase:rampup host=<dse-host-or-ip> cycles=100k --progress console:1s
|
||||
./nb run driver=cql workload=cql-keyvalue tags=phase:rampup host=<dse-host-or-ip> cycles=100k --progress console:1s
|
||||
|
||||
Note the differences between this and the command that we used to generate the schema.
|
||||
|
||||
@ -121,7 +121,7 @@ cql-keyvalue: 100.00%/Finished (details: min=0 cycle=100000 max=100000)
|
||||
Now that we have a base dataset of 100k rows in the database, we will now run a mixed read / write workload, by default
|
||||
this runs a 50% read / 50% write workload.
|
||||
|
||||
./nb start driver=cql workload=cql-keyvalue tags=phase:main host=<dse-host-or-ip> cycles=100k cyclerate=5000 threads=50 --progress console:1s
|
||||
./nb run driver=cql workload=cql-keyvalue tags=phase:main host=<dse-host-or-ip> cycles=100k cyclerate=5000 threads=50 --progress console:1s
|
||||
|
||||
You should see output that looks like this:
|
||||
|
||||
|
@ -5,27 +5,39 @@ weight: 20
|
||||
|
||||
# Quick Start Example
|
||||
|
||||
## Downloading
|
||||
## Getting NoSQLBench
|
||||
|
||||
NoSQLBench is packaged directly as a Linux binary named `nb` and as an executable Java jar named `nb.jar`.
|
||||
|
||||
## Downloading
|
||||
|
||||
The Linux binary is recommended, since it comes with its own JVM and eliminates the need to manage Java downloads. Both
|
||||
can be obtained at the releases section of the main NoSQLBench project:
|
||||
|
||||
- [NoSQLBench Releases](https://github.com/nosqlbench/nosqlbench/releases)
|
||||
|
||||
:::info
|
||||
Once you download the binary, you may need to `chmod +x nb` to make it
|
||||
executable.
|
||||
:::
|
||||
|
||||
:::info
|
||||
If you choose to use the nb.jar instead of the binary, it is recommended
|
||||
to run it with at least Java 12.
|
||||
Once you download the binary, you may need to `chmod +x nb` to make it executable. In order to run AppImage binaries,
|
||||
like nb, you need to have fuse support on your system. This is already provided on most distributions. If after
|
||||
downloading and executing nb, you get an error, please consult the
|
||||
[AppImage troubleshooting page](https://docs.appimage.org/user-guide/run-appimages.html#troubleshooting).
|
||||
|
||||
:::
|
||||
|
||||
This documentation assumes you are using the Linux binary initiating NoSqlBench commands with `./nb`. If you are using
|
||||
the jar, just replace `./nb` with `java -jar nb.jar` when running commands.
|
||||
the jar, just replace `./nb` with `java -jar nb.jar` when running commands. If you are using the jar version, Java 14 is
|
||||
recommended, and will be required soon.
|
||||
|
||||
## Run a cluster
|
||||
|
||||
This section requires you to have a CQL system to connect to.
|
||||
If you don’t already have one, you can start an instance of DSE with this one-liner:
|
||||
|
||||
docker run -e DS_LICENSE=accept --name my-dse -p 9042:9042 -d datastax/dse-server:6.7.7
|
||||
|
||||
or consult the instructions at the
|
||||
[Apache Cassandra docker hub landing page](https://hub.docker.com/_/cassandra).
|
||||
|
||||
## Running
|
||||
|
||||
@ -44,9 +56,11 @@ If you want a simple list of yamls which contain named scenarios, run:
|
||||
./nb --list-workloads
|
||||
|
||||
:::info
|
||||
|
||||
Note: These commands will include workloads that were shipped with nb and workloads in your local directory. To learn
|
||||
more about how to design custom workloads see
|
||||
[designing workloads](/index.html#/docs/designing_workloads.html)
|
||||
|
||||
:::
|
||||
|
||||
To provide your own contact points (comma separated), add the `hosts=` parameter
|
||||
|
Loading…
Reference in New Issue
Block a user