com.devsmart.microdb.Driver Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of microdb-runtime Show documentation

Runtime for MicroDb

There is a newer version: 0.3.17

package com.devsmart.microdb;


import com.devsmart.ubjson.UBObject;
import com.devsmart.ubjson.UBValue;

import java.io.IOException;
import java.util.UUID;

public interface Driver {

    void close();

    UBObject getMeta() throws IOException;

    void saveMeta(UBObject obj) throws IOException;

    /**
     * loads the database value with {@code key}
     *
     * @param key
     * @return the value stored in the database or null if it does not exist
     * @throws IOException
     */
    UBValue get(UUID key) throws IOException;

    /**
     * inserts a new value into the the database.
     *
     * @param id    the new object key. This value should have originated from a call to {@code genId()}
     * @param value
     * @throws IOException
     */
    void insert(UUID id, UBValue value) throws IOException;

    UUID genId();

    /**
     * replace value with key {@code id} with new value {@code value}.
     * If a value with with {@code id} does not exist, insert the key-value
     * pair.
     *
     * @param id
     * @param value
     * @throws IOException
     */
    void update(UUID id, UBValue value) throws IOException;

    /**
     * delete the database object with key {@code key}
     *
     * @param key
     * @throws IOException
     */
    void delete(UUID key) throws IOException;

    long incrementLongField(String fieldName);

    > Cursor queryIndex(String indexName, T min, boolean minInclusive, T max, boolean maxInclusive) throws IOException;

    > void addIndex(String indexName, MapFunction mapFunction) throws IOException;

    void recomputeIndex(String indexName);

    void deleteIndex(String indexName);

    void beginTransaction() throws IOException;

    void commitTransaction() throws IOException;

    void rollbackTransaction() throws IOException;

    void compact() throws IOException;
}