https://github.com/slatedb/slatedb-go
A cloud native embedded storage engine built on object storage.
https://github.com/slatedb/slatedb-go
database embedded-database golang lsm-tree object-storage rocksdb storage-engine
Last synced: 12 months ago
JSON representation
A cloud native embedded storage engine built on object storage.
- Host: GitHub
- URL: https://github.com/slatedb/slatedb-go
- Owner: slatedb
- License: apache-2.0
- Created: 2024-09-11T05:20:51.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-24T20:10:51.000Z (about 1 year ago)
- Last Synced: 2025-01-28T09:29:02.278Z (about 1 year ago)
- Topics: database, embedded-database, golang, lsm-tree, object-storage, rocksdb, storage-engine
- Language: Go
- Homepage: https://slatedb.io
- Size: 390 KB
- Stars: 72
- Watchers: 6
- Forks: 12
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
## Introduction
slatedb-go is a Go port of [slatedb](https://github.com/slatedb/slatedb)
SlateDB is an embedded storage engine built as a [log-structured merge-tree](https://en.wikipedia.org/wiki/Log-structured_merge-tree). Unlike traditional LSM-tree storage engines, SlateDB writes data to object storage (S3, GCS, ABS, MinIO, Tigris, and so on). Leveraging object storage allows SlateDB to provide bottomless storage capacity, high durability, and easy replication. The trade-off is that object storage has a higher latency and higher API cost than local disk.
To mitigate high write API costs (PUTs), SlateDB batches writes. Rather than writing every `put()` call to object storage, MemTables are flushed periodically to object storage as a string-sorted table (SST). The flush interval is configurable.
Checkout [slatedb.io](https://slatedb.io) to learn more.
## Get Started
```Go
package main
import (
"context"
"fmt"
"log/slog"
"time"
"github.com/slatedb/slatedb-go/slatedb"
"github.com/thanos-io/objstore"
)
func main() {
bucket := objstore.NewInMemBucket()
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
db, _ := slatedb.Open(ctx, "/tmp/testDB", bucket)
key := []byte("key1")
value := []byte("value1")
db.Put(key, value)
fmt.Println("Put:", string(key), string(value))
data, _ := db.Get(ctx, key)
fmt.Println("Get:", string(key), string(data))
db.Delete(key)
_, err := db.Get(ctx, key)
if err != nil && err.Error() == "key not found" {
fmt.Println("Delete:", string(key))
} else {
slog.Error("Unable to delete", "error", err)
}
if err := db.Close(); err != nil {
slog.Error("Error closing db", "error", err)
}
}
```
## Features
SlateDB is currently in the early stages of development. It is not yet ready for production use.
## License
SlateDB is licensed under the Apache License, Version 2.0.
## FAQ
1. Why is there a Go port instead of using Go binding ?
We wanted developers using this library in Go to be able to easily understand and modify(if needed) the internals without having to learn a new language.
Go developers will also have an option to use Go binding(when it is ready) if they can use cgo/ffi.
2. Is there a risk of a drift between the inner workings of the Rust and Go implementation?
We will try to keep it close to the Rust implementation.