lyl156 / nutsdb

A simple, fast, embeddable, persistent key/value store written in pure Go. It supports fully serializable transactions and many data structures such as list, set, sorted set.

What is NutsDB?

English | 简体中文

NutsDB is a simple, fast, embeddable and persistent key/value store written in pure Go.

It supports fully serializable transactions and many data structures such as list、set、sorted set. All operations happen inside a Tx. Tx represents a transaction, which can be read-only or read-write. Read-only transactions can read values for a given bucket and a given key or iterate over a set of key-value pairs. Read-write transactions can read, update and delete keys from the DB.

Announcement

• v0.14.0 release, see for details: https://github.com/nutsdb/nutsdb/releases/tag/v0.14.0
• v0.13.0 release, see for details: https://github.com/nutsdb/nutsdb/releases/tag/v0.13.0
• v0.12.6 release, see for details: https://github.com/nutsdb/nutsdb/releases/tag/v0.12.6
• v0.12.4 release, see for details: https://github.com/nutsdb/nutsdb/releases/tag/v0.12.4

📢 Note: Starting from v0.9.0, defaultSegmentSize in DefaultOptions has been adjusted from 8MB to 256MB. The original value is the default value, which needs to be manually changed to 8MB, otherwise the original data will not be parsed. The reason for the size adjustment here is that there is a cache for file descriptors starting from v0.9.0 (detail see nutsdb#164 ), so users need to look at the number of fds they use on the server, which can be set manually. If you have any questions, you can open an issue.

Architecture

Welcome contributions to NutsDB.

Quick start

Install NutsDB

To start using NutsDB, first needs Go installed (version 1.11+ is required). and run go get:

go get -u github.com/nutsdb/nutsdb

Opening a database

To open your database, use the nutsdb.Open() function,with the appropriate options.The Dir , EntryIdxMode and SegmentSize options are must be specified by the client. About options see here for detail.

package main

import (
    "log"

    "github.com/nutsdb/nutsdb"
)

func main() {
    // Open the database located in the /tmp/nutsdb directory.
    // It will be created if it doesn't exist.
    db, err := nutsdb.Open(
        nutsdb.DefaultOptions,
        nutsdb.WithDir("/tmp/nutsdb"),
    )
    if err != nil {
        log.Fatal(err)
    }
    defer db.Close()

    ...
}

Documentation

Buckets

• Using buckets

Pairs

• Using key/value pairs

Iterator

• Iterating over keys

Data Structures

• List
• Set
• Sorted Set

Database Options

• Options

More Operation

• More Operation

Comparison

• Comparison

Benchmark

• Benchmark

Contributing

See CONTRIBUTING for details on submitting patches and the contribution workflow.

Acknowledgements

This package is inspired by the following:

• Bitcask-intro
• BoltDB
• BuntDB
• Redis
• Sorted Set

License

The NutsDB is open-sourced software licensed under the Apache 2.0 license.