README
¶
CanoDB
Introduction
CanoDB is a distributed key-value database. It provides TCP client and server, expanding the goLevelDB database.
Features
- Implemented by pure Go, lightweight and fast.
- Based on TCP/IP protocol, supports SSL/TLS encryption.
Requirements
- The environmental requirement is at least
Go 1.22.
Usage
The client part is introduced into the code through go import. The server part is compiled and run in binary form or Docker image form.
Client
Download client package:
go get github.com/lindsuen/canodb/client
Import client package and connect to a database:
import "github.com/lindsuen/canodb/client"
// ...
// The default port of CanoDB server is 4644.
db, err := client.Connect("127.0.0.1:4644")
// ...
defer db.Close()
// ...
Read or modify the database content:
// ...
err := db.Put([]byte("key"), []byte("value"))
// ...
err = db.Delete([]byte("key"))
// ...
value, err = db.Get([]byte("key"))
// ...
Server
Place the downloaded or compiled binary file canodb in the corresponding directory, and then execute:
./canodb
Build
It is recommended to build on the Debian or Ubuntu operating system. The make tool is necessary, and you can install it through the command apt install -y build-essential.
Binary
cd canodb/ && go build -o bin/canodb -ldflags "-s -w" .
Docker
cd canodb/ && make build
docker build --no-cache -t canodb/canodb-server:latest .
TODO
- Synchronize data in the cluster by gRPC protocol.
License
BSD-2-Clause license
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package leveldb provides implementation of LevelDB key/value database.
|
Package leveldb provides implementation of LevelDB key/value database. |
|
cache
Package cache provides interface and implementation of a cache algorithms.
|
Package cache provides interface and implementation of a cache algorithms. |
|
comparer
Package comparer provides interface and implementation for ordering sets of data.
|
Package comparer provides interface and implementation for ordering sets of data. |
|
errors
Package errors provides common error types used throughout leveldb.
|
Package errors provides common error types used throughout leveldb. |
|
filter
Package filter provides interface and implementation of probabilistic data structure.
|
Package filter provides interface and implementation of probabilistic data structure. |
|
iterator
Package iterator provides interface and implementation to traverse over contents of a database.
|
Package iterator provides interface and implementation to traverse over contents of a database. |
|
journal
Package journal reads and writes sequences of journals.
|
Package journal reads and writes sequences of journals. |
|
memdb
Package memdb provides in-memory key/value database implementation.
|
Package memdb provides in-memory key/value database implementation. |
|
opt
Package opt provides sets of options used by LevelDB.
|
Package opt provides sets of options used by LevelDB. |
|
storage
Package storage provides storage abstraction for LevelDB.
|
Package storage provides storage abstraction for LevelDB. |
|
table
Package table allows read and write sorted key/value.
|
Package table allows read and write sorted key/value. |
|
util
Package util provides utilities used throughout leveldb.
|
Package util provides utilities used throughout leveldb. |
Click to show internal directories.
Click to hide internal directories.