https://github.com/rjl493456442/flatdb

https://github.com/rjl493456442/flatdb

Last synced: 16 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/rjl493456442/flatdb
• Owner: rjl493456442
• Created: 2020-11-02T07:49:44.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2020-11-02T12:08:01.000Z (about 4 years ago)
• Last Synced: 2024-10-13T15:07:31.896Z (about 1 month ago)
• Language: Go
• Size: 6.84 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## FlatDB

FlatDatabase is the "database" based on the raw file. It can be used in some special scenarios where the **random read is not required** and **all writes are append only**. In this case the flatDatabase can offer you the best write/iteration performance.

### Installation

```shell script

go install github.com/rjl493456442/flatdb

```

### Example Usage

```go

package flatdb

import "fmt"

func ExampleFlatDB() {

	// Initialize the empty flatdb with "write-only" mode.

	flatdb, err := NewFlatDatabase("path/to/flatdb", false)

	if err != nil {

		fmt.Printf("Failed to initialize flatdb, error: %v\n", err)

	}

	flatdb.Put([]byte{0x01, 0x02, 0x03}, []byte{0x1a, 0x1b, 0x1c})

	flatdb.Put([]byte{0x04, 0x05, 0x06}, []byte{0x2a, 0x2b, 0x2c})

	flatdb.Put([]byte{0x07, 0x08, 0x09}, []byte{0x3a, 0x3b, 0x3c})

	// Call the commit to flush out all the database content.

	// In the mean time the database is converted into the

	// "read-only" mode.

	if err := flatdb.Commit(); err != nil {

		fmt.Printf("Failed to commit flatdb, error: %v\n", err)

	}

	//  Random read is not allowed!!

	//

	//	flatdb.Get([]byte{0x01, 0x02, 0x03})

	// The only meaningful way to "read" the database is using

	// the iteration. The iteration order is exactly same with

	// the write order.

	iter := flatdb.NewIterator(nil, nil)

	defer iter.Release()

	for iter.Next() {

		fmt.Println(iter.Key())

		fmt.Println(iter.Value())

	}

	// Output:

	// [1 2 3]

	// [26 27 28]

	// [4 5 6]

	// [42 43 44]

	// [7 8 9]

	// [58 59 60]

}

```