FSDB is a collection of Go libraries providing a key-value store on your file system
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bucket
hybrid
local
.editorconfig Add EditorConfig file Jan 1, 2018
.gitignore Remove Bazel related files Apr 26, 2018
LICENSE
README.md
doc.go Split libs into their own repositories May 28, 2018
doc_test.go
error.go Fix typos May 28, 2018
error_test.go
fsdb.go
go.mod
go.sum
key.go
key_test.go

README.md

GoDoc Go Report Card

FSDB

FSDB is a collection of Go libraries providing a key-value store on your file system.

(Example code on godoc)

Why?

tl;dr: It's for larger (10k+ per entry), less latency sensitive data store.

Most key-value store libraries are optimized for small, in-memory size. Even for on-disk libraries, they are usually not optimized for larger (10k+) values. Also on-disk libraries usually uses write amplify for better performance, which means they will take more disk space than the actual data stored. FSDB store the data as-is or use optional gzip compression, making it a better solution for companies that need to store huge amount of data and is less sensitive to data latency.

FSDB could also be used as the last layer of your layered key-value stores: Use in-memory libraries for samllest, most time sensitive data; Use other on-disk libraries for larger, less time sensitive data; And use FSDB for largest, least latency sensitive data.

Further more, FSDB provided a hybrid implementation, which allows you to put some of your data on a remote bucket (AWS S3, Google Cloud Storage, etc.), providing an exra layer for larger and higher latency data.

It can also be used to implement mocks of remote libraries. For example, package bucket uses local FSDB to implement its mock for testing.

Highlights

FSDB has a minimal overhead, which means its performance is almost identical to the disk I/O performance. The local implementation has no locks. The hybrid implementation only has an optional row lock, please refer to the package documentation for more details.

The local and hybrid implementation has the same interface, which means you can use the local implementation first, and move the the hybrid implementation later as your data grows.

Packages Index

  • Package fsdb defines the interface. It does not provide implementations.
  • Package local provides the local implementation.
  • Package hybrid provides the hybrid implementation.
  • Package bucket defines the bucket interface. It does not provide implementations. Implementations for AWS S3 and Google Cloud Storage can be found in external libraries. There's also an implementation based on Go-Cloud Blob interface so you can use any Go-Cloud Blob implementation in hybrid FSDB.

Test

All packages provide its own tests can be run with go test. If you want to test every package within this repository, you can use vgo by running vgo test all under the repository root directory.

There are some tests with sleep calls, you can skip them by running go test -short instead. Package local provides a benchmark test can be run with go test -bench ..

License

BSD License.