puzzledb-go

README

PuzzleDB aspires to be a high-performance, distributed, cloud-native, multi-API, multi-model database. This Technology Preview version has been developed in the Go language.

What is PuzzleDB

PuzzleDB is a multi-data model database capable of handling key-value, relational, and document models. Additionally, PuzzleDB is a multi-interface database, compatible with existing database protocols such as PostgreSQL, MySQL, Redis, and MongoDB.

PuzzleDB is a distributed database framework supporting various data models and protocols. It is designed as a flexible, scalable, and efficient database framework suitable for various environments.

PuzzleDB accommodates existing query protocols such as PostgreSQL, MySQL, MongoDB, and Redis within a distributed, pluggable database framework. Consequently, developers can seamlessly start using PuzzleDB as a scalable, high-performance distributed database with existing database client drivers, eliminating any learning curve.

Key Features

PuzzleDB has the following features:

• Flexibility: PuzzleDB allows for extensibility through its plugin architecture and pluggable modules for queries, data models, storage, and more.

• Scalability: PuzzleDB seamlessly transitions from an in-memory standalone storage plugin module to a scalable, shared-nothing, horizontally distributed database using an ordered distributed key-value store plugin module.

• Facility: PuzzleDB supports major database model and protocol plugin modules, such as PostgreSQL, Redis, MongoDB, and MySQL, simplifying application migration.

• Safety: PuzzleDB offers ACID-compliant plugin modules, enabling the development of intuitive and secure applications.

• Efficiency: PuzzleDB manages various database data models, including key-value, document, and relational, by consolidating them into a single core model.

Get Started

See the following guide to learn about how to get started.

• Quick Start

How does PuzzleDB work?

For information on the concept and architecture of PuzzleDB, refer to the following concept documents:

• Design Concepts

  • Layer Concept

  • Data Model

  • Storage Concept

  • Consistency Model

  • Coordinator Concept

  • Authentication Concept

  • Plug-In Concept

Supported Protocols

PuzzleDB supports the following protocols:

• Compatibility

  • PostgreSQL

  • MySQL

  • MongoDB

  • Redis

Roadmap

PuzzleDB is currently in a technical preview release stage. At present, it is in the process of developing and testing a distributed plugin for the upcoming release. The development roadmap for PuzzleDB is outlined below.

User Guides

• Get Started

  • Quick Start

    • puzzledb-server

  • Configuring PullzeDB

• Operation

  • CLI (puzzledb-cli)

  • Distributed Tracing

• Benchmarking

  • puzzledb-bench

• Distribution

  • Docker Hub (cybergarage/puzzledb)

Developer Guides

• References

  • go-Reference

• Contributing (Planning)

  • Coding Guidelines

• Building and Testing

  • Build on macOS

  • Build on Ubuntu

• Extending PuzzleDB

  • Plug-In Concept

  • Plug-in Services

    • Building User Plug-ins

• Specification

  • Coordinator Specification

    • Coordinator Messaging Specification

    • Coordinator Key-Value Store Specification

  • Store Specification

    • Store Key-Value Specification

  • Transversed Specifications

    • Key-Value Store Specification

Related Projects

PuzzleDB is being developed in collaboration with the following Cybergarage projects:

• go-cbor

• go-logger

• go-mongo

• go-mysql

• go-pict

• go-postgresql

• go-redis

• go-safecast

• go-sqlparser

• go-sqltest

• go-tracing