RocksDB Java Example


Rocksdb belongs to an embedded database and has no network interaction interface. It must be deployed on the same server as the service. Rocksdb is an embedded kV system developed by Facebook company on the basis of leveldb. It optimizes and enhances leveldb in many aspects, which is more like a complete product. It has the following characteristics:

  • High performance: rocksdb uses a log structure database engine, written entirely in C + + for maximum performance. Keys and values are byte streams of any size.
  • Optimized for fast storage: rocksdb is optimized for fast, low latency storage such as flash drives and high-speed disk drives. Rocksdb takes full advantage of the high read / write rate provided by flash or ram.
  • Strong adaptability: rocksdb can adapt to different workloads. From database storage engines such as myrocks to application data caching to embedded workloads, rocksdb can be used to meet various data requirements.
  • Basic and advanced database operations: rocksdb provides some basic operations, such as opening and closing databases, reading and writing, merging and compressing filters and other advanced operations.

The following documents are referred to:

  • RocksJava Basics
  • Getting started with Java rocksdb

Maven dependence( pom.xml )


For a complete code example, please refer to:

import org.rocksdb.*;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

public class RocksDBExample {

    private static final String dbPath   = "./rocksdb-data/";
    private static final String cfdbPath = "./rocksdb-data-cf/";

    static {

    public void testDefaultColumnFamily() {
        System.out.println("testDefaultColumnFamily begin...");
        //If the file does not exist, create the file first
        try (final Options options = new Options().setCreateIfMissing(true)) {
            try (final RocksDB rocksDB =, dbPath)) {
                //Simple key value
                byte[] key = "Hello".getBytes();
                rocksDB.put(key, "World".getBytes());

                System.out.println(new String(rocksDB.get(key)));

                rocksDB.put("SecondKey".getBytes(), "SecondValue".getBytes());

                //Query primary key through list
                List keys = Arrays.asList(key, "SecondKey".getBytes(), "missKey".getBytes());
                List values = rocksDB.multiGetAsList(keys);
                for (int i = 0; i < keys.size(); i++) {
                    System.out.println("multiGet " + new String(keys.get(i)) + ":" + (values.get(i) != null ? new String(values.get(i)) : null));

                //Print all [key - value]
                RocksIterator iter = rocksDB.newIterator();
                for (iter.seekToFirst(); iter.isValid(); {
                    System.out.println("iterator key:" + new String(iter.key()) + ", iter value:" + new String(iter.value()));

                //Delete a key
                System.out.println("after remove key:" + new String(key));

                iter = rocksDB.newIterator();
                for (iter.seekToFirst(); iter.isValid(); {
                    System.out.println("iterator key:" + new String(iter.key()) + ", iter value:" + new String(iter.value()));
        } catch (RocksDBException e) {

    //Using a specific column family to open a database, you can understand a column family as a table in a relational database
    public void testCertainColumnFamily() {
        System.out.println("\ntestCertainColumnFamily begin...");
        try (final ColumnFamilyOptions cfOpts = new ColumnFamilyOptions().optimizeUniversalStyleCompaction()) {
            String cfName = "my-first-columnfamily";
            // list of column family descriptors, first entry must always be default column family
            final List cfDescriptors = Arrays.asList(
                    new ColumnFamilyDescriptor(RocksDB.DEFAULT_COLUMN_FAMILY, cfOpts),
                    new ColumnFamilyDescriptor(cfName.getBytes(), cfOpts)

            List cfHandles = new ArrayList<>();
            try (final DBOptions dbOptions = new DBOptions().setCreateIfMissing(true).setCreateMissingColumnFamilies(true);
                 final RocksDB rocksDB =, cfdbPath, cfDescriptors, cfHandles)) {
                ColumnFamilyHandle cfHandle = -> {
                    try {
                        return (new String(x.getName())).equals(cfName);
                    } catch (RocksDBException e) {
                        return false;

                //Write key / value
                String key = "FirstKey";
                rocksDB.put(cfHandle, key.getBytes(), "FirstValue".getBytes());
                //Query single key
                byte[] getValue = rocksDB.get(cfHandle, key.getBytes());
                System.out.println("get Value : " + new String(getValue));
                //Write the second key / value
                rocksDB.put(cfHandle, "SecondKey".getBytes(), "SecondValue".getBytes());

                List keys = Arrays.asList(key.getBytes(), "SecondKey".getBytes());
                List cfHandleList = Arrays.asList(cfHandle, cfHandle);
                //Query multiple keys
                List values = rocksDB.multiGetAsList(cfHandleList, keys);
                for (int i = 0; i < keys.size(); i++) {
                    System.out.println("multiGet:" + new String(keys.get(i)) + "--" + (values.get(i) == null ? null : new String(values.get(i))));

                //Delete single key
                rocksDB.delete(cfHandle, key.getBytes());

                RocksIterator iter = rocksDB.newIterator(cfHandle);
                for (iter.seekToFirst(); iter.isValid(); {
                    System.out.println("iterator:" + new String(iter.key()) + ":" + new String(iter.value()));
            } finally {
                // NOTE frees the column family handles before freeing the db
                for (final ColumnFamilyHandle cfHandle : cfHandles) {
        } catch (RocksDBException e) {
        } // frees the column family options

    public static void main(String[] args) throws Exception {
        RocksDBExample test = new RocksDBExample();