Skip to content

Prerequisites for Windows

Jump to bottom Edit New page
haczprox edited this page Apr 26, 2016 · 3 revisions

YCSB is made to run on Windows systems given some additional software. The following instructions are broken into sections based on running from an existing release and building from the source. Users are encouraged to rely on published releases where possible.

Running from a release

These instructions cover running the YCSB client on your Windows machine. It does not cover any steps needed to run any datastore instances you may wish to evaluate. Please see the documentation for a given datastore to see what steps are needed to run an instance on Windows.

Needed software

Java Runtime Environment

The YCSB client and each datastore binding is written in the Java language. In order to run the client you will need a compatible Java Runtime Environment (JRE); YCSB is developed to work with both the Oracle Java SE and the OpenJDK runtimes. Ensure you follow the instructions to add the java command to your system path.

After you have installed a JRE, add an environment variable named "JAVA_HOME" that points to the installation. This folder should include both folders named 'bin' and 'lib'. For example, the default location for the Oracle Java SE JRE version 1.8.0_45 is C:\Program Files\Java\jre1.8.0_45. For more information on setting environment variables see the 'How to set the path and environment variables in Windows' entry on Computer Hope.

Python 2.7

YCSB relies on a Python 2.7 script to handle setting up the proper runtime environment for Java. You will need to install the Python interpreter.

Means to expand tar.gz files

YCSB uses Gzip compressed Tar files to distribute its framework, datastore bindings, and related materials. You will need some means to uncompress these files. The following are meant to be examples, if you use them you need only pick one:

  • 7-Zip is open source software for compression available in a variety of language localizations. For more information see the 7-Zip project page
  • Cygwin is a collection of open source tools that includes the GNU tar program. For more information see the Cygwin project page
  • WinZip is a proprietary application for working with compressed files, with a free trial period. For more information see the WinZip product page

For more information on opening tar.gz files see this article from Tom Harrison.

Verify things work

  1. Download the latest version of YCSB as explained in the Getting Started guide
  2. Use the program of your choice to decompress the contents of the YCSB release into a known location (e.g. C:\YCSB-0.1.4\)
  3. Change into said directory
  4. Use python to execute the bin\ycsb script

Example with python.exe installed in C:\Python27\, using the 'basic' datastore binding that only echoes transactions:

        C:\> cd YCSB-0.1.4
        C:\YCSB-0.1.4> C:\Python27\python.exe bin\ycsb load basic -P workloads\workloada -p recordcount=4
        ….SNIP….

You should see four INSERT statements, followed by some stats prefixed with [OVERALL], [CLEANUP], and [INSERT]. There should be no errors.

Building from source

Needed software

Java Development Environment

In order to build the YCSB framework you will need a Java Development Environment (JDK). Please note that this is a different software distribution than the Java Runtime Environment mentioned above. YCSB should build properly with either the Oracle Java SE or OpenJDK development environments.

After you have installed a JDK, add an environment variable named "JAVA_HOME" that points to the installation. This folder should include both folders named 'bin' and 'lib'. For example, the default location for the Oracle Java SE JDK version 1.8.0_45 is C:\Program Files\Java\jdk1.8.0_45. For more information on setting environment variables see the 'How to set the path and environment variables in Windows' entry on Computer Hope.

Maven

YCSB uses Apache Maven to manage its build process. To build from source you will need to set up Maven and ensure that it is available in your system path.

Git

YCSB uses git for its version control, hosted by GitHub. The instructions below will include both downloading source directly and checking out a working copy of our version control system. In order to check out the working copy, you will need to set up access to GitHub on your machine.

First build

  1. Obtain the source, either by using git to clone the repository as explained in the Getting Started guide or by downloading a zip file from the web site
  • If you clone the git repository, change directory into the checkout before continuing
  • If you download the zip file, uncompress it into a known location (e.g. C:\YCSB-master) and change directory into that location before continuing
  1. Run Maven with the 'package' goal to build the project and create a binary distribution tar.gz file.

Example with the downloaded source decompressed into C:\YCSB-master\:

        C:\> cd YCSB-master
        C:\YCSB-master> mvn package
        ….SNIP….
        [INFO] ------------------------------------------------------------------------
        [INFO] BUILD SUCCESS
        [INFO] ------------------------------------------------------------------------
        [INFO] Total time: 06:14 min
        [INFO] Finished at: Mon Jul 06 00:34:07 CDT 2015
        [INFO] Final Memory: 81M/756M
        [INFO] ------------------------------------------------------------------------

If you so desire, you can now take the tar.gz distribution file from distribution\target\ and use it by following the instructions above for running from a release.

Add a custom footer
Add a custom sidebar
Clone this wiki locally