github.com/i5heu/ouroboros-db

⚠️ This Project is still in development and not ready for production use. ⚠️

OuroborosDB

A embedded database built around the concept of event trees, emphasizing data deduplication and data integrity checks. By structuring data into event trees, OuroborosDB ensures efficient and intuitive data management. Key features include:

• Data Deduplication: Eliminates redundant data through efficient chunking and hashing mechanisms.
• Data Integrity Checks: Uses SHA-512 hashes to verify the integrity of stored data.
• Event-Based Architecture: Organizes data hierarchically for easy retrieval and management.
• Scalable Concurrent Processing: Optimized for concurrent processing to handle large-scale data.
• Log Management and Indexing: Provides efficient logging and indexing for performance monitoring.
• Non-Deletable Events: Once stored, events cannot be deleted or altered, ensuring the immutability and auditability of the data.
• (To be implemented) Temporary Events: Allows the creation of temporary events that can be marked as temporary and safely cleaned up later for short-term data storage needs.

Table of Contents

• OuroborosDB
  • Table of Contents
  • Installation
  • Usage
    • Initialization
    • Storing Files
    • Retrieving Files
    • Event Tree Management
      • Creating Root Event
      • Fetching Root Events by Title
      • Creating Child Events
      • Fetching Child Events
  • Testing
  • Benchmarking
    • Benchmark current state of the codebase
    • Benchmark Versions
  • OuroborosDB Performance Version Differences
  • OuroborosDB Performance Changelog
  • Current Features
  • Future Features
  • Current Problems and things to research:
  • Name and Logo
  • License

Installation

OuroborosDB requires Go 1.21.5+

go get -u github.com/i5heu/OuroborosDB

Usage

Initialization

OuroborosDB can be initialized with a configuration struct that includes paths for storage and other settings.

import "OuroborosDB"

func initializeDB() *OuroborosDB.OuroborosDB {
    db, err := OuroborosDB.NewOuroborosDB(OuroborosDB.Config{
        Paths:                     []string{"./data/storage"},
        MinimumFreeGB:             1,
        GarbageCollectionInterval: 10, // Minutes
    })
    if err != nil {
        log.Fatalf("Failed to initialize OuroborosDB: %v", err)
    }
    return db
}

Storing Files

Files can be stored within events using the StoreFile method.

import (
    "OuroborosDB/internal/storage"
    "OuroborosDB"
)

func storeFile(db *OuroborosDB.OuroborosDB, parentEvent storage.Event) storage.Event {
    fileContent := []byte("This is a sample file content")
    metadata := []byte("sample.txt")

    event, err := db.DB.StoreFile(storage.StoreFileOptions{
        EventToAppendTo: parentEvent,
        Metadata:        metadata,
        File:            fileContent,
    })
    if err != nil {
        log.Fatalf("Failed to store file: %v", err)
    }
    return event
}

Retrieving Files

Files can be retrieved by providing the event from which they were stored.

func retrieveFile(db *OuroborosDB.OuroborosDB, event storage.Event) []byte {
    content, err := db.DB.GetFile(event)
    if err != nil {
        log.Fatalf("Failed to retrieve file: %v", err)
    }
    return content
}

Event Tree Management

Creating Root Event

Create a root event to represent the top level of an event tree.

func createRootEvent(db *OuroborosDB.OuroborosDB, title string) storage.Event {
    rootEvent, err := db.DB.CreateRootEvent(title)
    if err != nil {
        log.Fatalf("Failed to create root event: %v", err)
    }
    return rootEvent
}

Fetching Root Events by Title

func getRootEventsByTitle(db *OuroborosDB.OuroborosDB, title string) []storage.Event {
    events, err := db.DB.GetRootEventsWithTitle(title)
    if err != nil {
        log.Fatalf("Failed to fetch root events by title: %v", err)
    }
    return events
}

Creating Child Events

func createChildEvent(db *OuroborosDB.OuroborosDB, parentEvent storage.Event) storage.Event {
    childEvent, err := db.DB.CreateNewEvent(storage.EventOptions{
        HashOfParentEvent: parentEvent.EventHash,
    })
    if err != nil {
        log.Fatalf("Failed to create child event: %v", err)
    }
    return childEvent
}

Fetching Child Events

func getChildEvents(db *OuroborosDB.OuroborosDB, parentEvent storage.Event) []storage.Event {
    children, err := db.Index.GetDirectChildrenOfEvent(parentEvent.EventHash)
    if err != nil {
        log.Fatalf("Failed to fetch child events: %v", err)
    }
    return children
}

Testing

  go test ./...

Benchmarking

Benchmark current state of the codebase

  go test -run='^$' -bench=.

Benchmark Versions

Works with committed changes and version/commits that are reachable by git checkout.
You also need to have installed benchstat to compare the benchmarks, install it with go get golang.org/x/perf/cmd/benchstat@latest

  # add versions to bench.sh
  bash bench.sh
  # Now look in benchmarks/combined_benchmarks_comparison to see the results

OuroborosDB Performance Version Differences

goos: linux
goarch: arm64
pkg: github.com/i5heu/ouroboros-db
                                                                             │ benchmarks/v0.0.5.txt │       benchmarks/v0.0.8.txt        │       benchmarks/v0.0.16.txt       │        benchmarks/v0.0.17.txt         │
                                                                             │        sec/op         │    sec/op     vs base              │    sec/op     vs base              │    sec/op      vs base                │
_setupDBWithData/RebuildIndex-8                                                         655.2m ±  4%   650.3m ±  2%       ~ (p=0.699 n=6)   644.2m ±  3%       ~ (p=0.699 n=6)   2506.8m ± 58%  +282.58% (p=0.002 n=6)
_Index_RebuildingIndex/RebuildIndex-8                                                   20.71m ± 16%   20.97m ± 11%       ~ (p=0.699 n=6)   20.88m ± 17%       ~ (p=0.699 n=6)    26.50m ±  3%   +27.94% (p=0.002 n=6)
_Index_GetDirectChildrenOfEvent/GetChildrenOfEvent-8                                    4.992µ ±  3%   4.944µ ±  4%       ~ (p=0.485 n=6)   4.614µ ±  4%  -7.58% (p=0.002 n=6)    5.150µ ±  2%    +3.17% (p=0.009 n=6)
_Index_GetChildrenHashesOfEvent/GetChildrenHashesOfEvent-8                              77.94n ±  1%   77.63n ±  2%       ~ (p=0.240 n=6)   77.28n ±  4%       ~ (p=0.699 n=6)   113.65n ±  3%   +45.82% (p=0.002 n=6)
_DB_StoreFile/StoreFile-8                                                               184.8µ ±  3%   186.4µ ±  1%       ~ (p=0.132 n=6)   184.7µ ±  3%       ~ (p=0.818 n=6)    358.9µ ±  6%   +94.22% (p=0.002 n=6)
_DB_GetFile/GetFile-8                                                                   3.683µ ±  5%   3.631µ ±  5%       ~ (p=0.368 n=6)   3.716µ ±  6%       ~ (p=0.556 n=6)    3.738µ ±  1%         ~ (p=0.126 n=6)
_DB_GetEvent/GetEvent-8                                                                 6.271µ ±  2%   6.283µ ±  2%       ~ (p=0.699 n=6)   6.173µ ±  5%       ~ (p=0.589 n=6)    6.521µ ±  2%    +3.99% (p=0.002 n=6)
_DB_GetMetadata/GetMetadata-8                                                           4.059µ ±  2%   4.078µ ±  5%       ~ (p=1.000 n=6)   4.041µ ±  3%       ~ (p=0.394 n=6)    4.072µ ±  4%         ~ (p=0.818 n=6)
_DB_GetAllRootEvents/GetAllRootEvents-8                                                 19.74m ±  2%   19.24m ±  3%  -2.52% (p=0.026 n=6)   19.89m ±  5%       ~ (p=0.937 n=6)    21.04m ±  1%    +6.59% (p=0.002 n=6)
_DB_GetRootIndex/GetRootIndex-8                                                         2.464m ±  4%   2.497m ±  5%       ~ (p=0.132 n=6)   2.474m ±  5%       ~ (p=0.589 n=6)    2.428m ±  4%         ~ (p=0.699 n=6)
_DB_GetRootEventsWithTitle/GetRootEventsWithTitle-8                                     12.26µ ±  3%   12.18µ ±  5%       ~ (p=0.818 n=6)   12.26µ ±  4%       ~ (p=0.937 n=6)    13.38µ ±  2%    +9.13% (p=0.002 n=6)
_DB_CreateRootEvent/CreateRootEvent-8                                                   131.0µ ±  4%   130.7µ ±  3%       ~ (p=0.485 n=6)   130.9µ ± 10%       ~ (p=0.937 n=6)    241.3µ ±  4%   +84.19% (p=0.002 n=6)
_DB_CreateNewEvent/CreateNewEvent-8                                                     50.87µ ± 16%   50.14µ ± 17%       ~ (p=0.589 n=6)   49.52µ ± 18%       ~ (p=0.937 n=6)    85.56µ ±  4%   +68.21% (p=0.002 n=6)
_DB_fastMeta/CreateNewEvent_with_FastMeta-8                                                                                                                                       88.08µ ±  5%
_DB_fastMeta/GetEvent_with_FastMeta-8                                                                                                                                             6.377µ ±  2%
_Index_GetParentHashOfEvent/GetParentHashOfEvent-8                                                                                                                                135.2n ±  4%
_Index_RebuildIFastMeta/RebuildFastMeta-8                                                                                                                                         1.108m ±  8%
_Index_GetEventHashesByFastMetaParameter/GetEventHashesByFastMetaParameter-8                                                                                                      71.30n ±  1%
_Index_GetEventsByFastMeta/GetEventsByFastMeta-8                                                                                                                                  3.928m ±  1%
geomean                                                                                 110.4µ         110.1µ        -0.34%                 109.4µ        -0.95%                  75.34µ         +35.87%

OuroborosDB Performance Changelog

• v0.0.14 - Major refactor of the Event type and introduction of FastMeta which should speed up search
• v0.0.3 - Switch from gob to protobuf for serialization
• v0.0.2 - Create tests and benchmarks

Current Features

• Data Deduplication
• Basic Data Store and Retrieval
• Data Integrity Checks
• Child to Parent Index

Future Features

• Full Text Search
• Is the deletion of not Temporary Events a good idea?
  • Maybe if only some superUser can delete them with a key or something.
• It would be nice to have pipelines that can run custom JS or webassembly to do arbitrary things.
  • With http routing we could build a webserver that can run inside a "pipeline" in the database. sksksk
  • They should be usable as scraper or time or event based notificators.
  • Like if this event gets a child recursively, upload this tree to a server.
    • this would need a virtual folder structure that is represented in an event.
    • with this we could also build a webdav server that can be used to access parts of the database.

Current Problems and things to research:

• Garbage Collection would delete Chunks that in the process of being used in a new event
• Deletion of Temporary Events is not yet discovered
• We have EventChilds that are used as either
  • A Item in the "category" of the Event
  • New Information that replaces it's Parent
  • Changes to the Parent (think patches)
    We need to reflect this in the Event Structure to lower chunk lookups
    If we implement a potential DeltaEvent, we need to provide tooling for it.
    • is it like git where we have a diff of the file?
    • is it a new file that replaces the old one?
    • we already have the chunk system in place. But this seams to not be suitable for text files - so we would need a text based delta event?

Name and Logo

The name "OuroborosDB" is derived from the ancient symbol "Ouroboros," a representation of cyclical events, continuity, and endless return. Historically, it's been a potent symbol across various cultures, signifying the eternal cycle of life, death, and rebirth. In the context of this database, the Ouroboros symbolizes the perpetual preservation and renewal of data. While the traditional Ouroboros depicts a serpent consuming its tail, our version deviates, hinting at both reverence for historical cycles and the importance of continuous adaptation in the face of change.

License

OuroborosDB (c) 2024 Mia Heidenstedt and contributors

SPDX-License-Identifier: AGPL-3.0