artbits/quickio

A Java embedded database.

QuickIO

QuickIO is a Java embedded database. The underlying layer is based on the LevelDB engine and Java NIO design, and uses Protostaff to serialize/deserialize data. Support the storage of document, key-value and file type data. Directly using Java code to operate databases is simple, flexible, and efficient.

Features

• Embedded databases like SQLite do not need to be installed or independent processes.
• NoSQL databases like MongoDB or Diskv are very simple to use.
• Support the storage of document, key-value and file type data.
• Unique index is supported to meet the requirement of fast query.
• Simple API, elegant operation using Java Lambda expressions.
• Fast reading and writing to meet the use scenarios of small and medium-sized data.

Download

Gradle:

repositories {
    maven { url 'https://www.jitpack.io' }
}

dependencies {
    implementation 'com.github.artbits:quickio:1.4.1'
}

Maven:

<repository>
    <id>jitpack.io</id>
    <url>https://www.jitpack.io</url>
</repository>

<dependency>
    <groupId>com.github.artbits</groupId>
    <artifactId>quickio</artifactId>
    <version>1.4.1</version>
</dependency>

Usage

Store data of document type.

JDB db = QuickIO.db("example_db");
Collection<Document> collection = db.collection(Document.class);

collection.save(new Document().put("city", "Canton").put("area", 7434.4));

Document document = collection.findOne(d -> "Canton".equals(d.get("city")));
Optional.ofNullable(document).ifPresent(IOEntity::printJson);

Custom entity classes are stored according to the data of document type.

public class Book extends IOEntity {
    public String name;
    public String author;
    public Double price;
    
    public static Book of(Consumer<Book> consumer) {
        Book book = new Book();
        consumer.accept(book);
        return book;
    }
}


JDB db = QuickIO.db("example_db");
Collection<Book> collection = db.collection(Book.class);

collection.save(Book.of(b -> {
    b.name = "On java 8";
    b.author = "Bruce Eckel";
    b.price = 129.8;
}));

List<Book> books = collection.findAll();
books.forEach(IOEntity::printJson);

Store data of Key-Value type, and support any key and value that can be serialized and deserialized.

JKV kv = QuickIO.kv("example_kv");
kv.set("Pi", 3.14);
kv.set(3.14, "Pi");

double d = kv.get("Pi", Double.class);
String s = kv.get(3.14, String.class);
QuickIO.println("%s = %f", s, d);

Stores data for file types.

JTin tin = QuickIO.tin("example_tin");
tin.put("photo.png", new File("..."));

File file = tin.get("photo.png");
Optional.ofNullable(file).ifPresent(f -> QuickIO.println(f.getPath()));

Links

• APIs:
  • DB - Document storage
  • KV - Key-Value storage
  • Tin - File storage
• Thanks:
  • LevelDB
  • LevelDB-Beta
  • Protostuff

License

Copyright 2022 Zhang Guanhu

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.