YCSB

• JDBC Binding
• YSQL Binding
• YCQL Binding

Overview

This uses a YSQL-specific binding to test the YSQL 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 YSQL shell ysqlsh exported to the PATH variable. You can download ysqlsh if you do not have it.

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

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 values for the IP addresses in the db.url field.

db.driver=org.postgresql.Driver
db.url=jdbc:postgresql://<ip1>:5433/ycsb;jdbc:postgresql://<ip2>:5433/ycsb;jdbc:postgresql://<ip3>:5433/ycsb;
db.user=yugabyte
db.passwd=

Details about other configuration parameters are described in Core Properties on the YCSB repository.

4. Run the benchmark

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

$ ./run_ysql.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_ysql.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-ysql-load.dat and workloada-ysql-transaction.dat

6. Run individual workloads (optional)

Connect to the database using ysqlsh.

$ ./bin/ysqlsh -h <ip>

Create the ycsb database.

yugabyte=# CREATE DATABASE ycsb;

Connect to the created database.

yugabyte=# \c ycsb

Create the table.

ycsb=# CREATE TABLE usertable (
           YCSB_KEY VARCHAR(255) PRIMARY KEY,
           FIELD0 TEXT, FIELD1 TEXT, FIELD2 TEXT, FIELD3 TEXT,
           FIELD4 TEXT, FIELD5 TEXT, FIELD6 TEXT, FIELD7 TEXT,
           FIELD8 TEXT, FIELD9 TEXT);

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

$ ./bin/ycsb load yugabyteSQL -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 yugabyteSQL -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 yugabyteSQL -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 node on 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, you get the following results:

1 Million Rows