YCSB

• JDBC Binding
• YSQL Binding
• YCQL Binding

Overview

This uses a YCQL-specific binding to test the YCQL API using the YCSB benchmark.

Running the benchmark

1. Prerequisites

Download the YCSB binaries. You can do this by running the following commands.

$ cd $HOME
$ wget https://github.com/yugabyte/YCSB/releases/download/1.0/ycsb.tar.gz
$ tar -zxvf ycsb.tar.gz
$ cd YCSB

Make sure you have the YCQL shell ycqlsh exported to the PATH variable. You can download ycqlsh if you do not have it.

$ export PATH=$PATH:/path/to/ycqlsh

2. Start YugabyteDB

Start your YugabyteDB cluster by following the steps for manual deployment.

3. Configure db.properties

Update the file db.properties in the YCSB directory with the following contents. Remember to put the correct value for the IP address in the hosts field.

hosts=<ip>
port=9042
cassandra.username=yugabyte

For details on other configuration parameters, like username, password, connection parameters, etc., see YugabyteCQL binding.

4. Run the benchmark

There is a handy script run_ycql.sh that loads and runs all the workloads.

$ ./run_ycql.sh --ip <ip>

The above command workload will run the workload on a table with 1 million rows. If you want to run the benchmark on a table with a different row count:

$ ./run_ycql.sh --ip <ip> --recordcount <number of rows>

5. Verify results

The script creates 2 result files per workload, one for the loading and one for the execution phase with the details of throughput and latency. For example, for workloada, it creates workloada-ycql-load.dat and workloada-ycql-transaction.dat

6. Run individual workloads (optional)

Connect to the database using ycqlsh.

$ ./bin/ycqlsh <ip>

Create the ycsb keyspace.

ycqlsh> CREATE KEYSPACE ycsb;

Connect to the created keyspace.

ycqlsh> USE ycsb;

Create the table.

ycqlsh:ycsb> create table usertable (
                y_id varchar primary key,
                field0 varchar, field1 varchar, field2 varchar, field3 varchar,
                field4 varchar, field5 varchar, field6 varchar, field7 varchar,
                field8 varchar, field9 varchar);

Before starting the yugabyteCQL workload, you first need to load the data.

$ ./bin/ycsb load yugabyteCQL -s \
      -P db.properties           \
      -P workloads/workloada     \
      -p recordcount=1000000     \
      -p operationcount=10000000 \
      -p threadcount=32          \
      -p maxexecutiontime=180

Then, you can run the workload:

$ ./bin/ycsb run yugabyteCQL -s  \
      -P db.properties           \
      -P workloads/workloada     \
      -p recordcount=1000000     \
      -p operationcount=10000000 \
      -p threadcount=256         \
      -p maxexecutiontime=180

To run the other workloads (for example, workloadb), all you need to do is change that argument in the above command.

$ ./bin/ycsb run yugabyteCQL -s  \
      -P db.properties           \
      -P workloads/workloadb     \
      -p recordcount=1000000     \
      -p operationcount=10000000 \
      -p threadcount=256         \
      -p maxexecutiontime=180

Expected results

Setup

When run on a 3-node cluster with each a c5.4xlarge AWS instance (16 cores, 32 GB of RAM and 2 EBS volumes) all belonging to the same AZ with the client VM running in the same AZ we get the following results:

1 Million Rows