modusdb

README

Docs · Discord

ModusDB is a high-performance, transactional database system. It's designed to be type-first, schema-agnostic, and portable. ModusDB provides object-oriented APIs that makes it simple to build new apps, paired with support for advanced use cases through the Dgraph Query Language (DQL). A dynamic schema allows for natural relations to be expressed in your data with performance that scales with your use case.

ModusDB is available as a Go package for running in-process, providing low-latency reads, writes, and vector searches. We’ve made trade-offs to prioritize speed and simplicity.

The modus framework is optimized for apps that require sub-second response times. ModusDB augments polyglot functions with simple to use data and vector storage. When paired together, you can build a complete AI semantic search or retrieval-augmented generation (RAG) feature with a single framework.

Quickstart

package main

import (
  "github.com/hypermodeinc/modusdb"
)

type User struct {
  Gid  uint64 `json:"gid,omitempty"`
  Id   string `json:"id,omitempty" db:"constraint=unique"`
  Name string `json:"name,omitempty"`
  Age  int    `json:"age,omitempty"`
}

func main() {
  engine, err := modusdb.NewEngine(modusdb.NewDefaultConfig("/local/modusdb"))
  if err != nil {
    panic(err)
  }
  defer engine.Close()

  gid, user, err := modusdb.Upsert(ns, User{
    Id:   "123",
    Name: "A",
    Age:  10,
  })
  if err != nil {
    panic(err)
  }
  fmt.Println(user)

  _, queriedUser, err := modusdb.Get[User](ns, gid)
  if err != nil {
    panic(err)
  }
  fmt.Println(queriedUser)

  _, _, err = modusdb.Delete[User](ns, gid)
  if err != nil {
    panic(err)
  }
}

Open Source

The modus framework, including modusDB, is developed by Hypermode as an open-source project, integral but independent from Hypermode.

We welcome external contributions. See the CONTRIBUTING.md file if you would like to get involved.

Modus and its components are © Hypermode Inc., and licensed under the terms of the Apache License, Version 2.0. See the LICENSE file for a complete copy of the license. If you have any questions about modus licensing, or need an alternate license or other arrangement, please contact us at hello@hypermode.com.

Acknowledgements

ModusDB builds heavily upon packages from the open source projects of Dgraph (graph query processing and transaction management), Badger (data storage), and Ristretto (cache). We expect the architecture and implementations of modusDB and Dgraph to expand in differentiation over time as the projects optimize for different core use cases, while maintaining Dgraph Query Language (DQL) compatibility.

Documentation

Index

• Variables
• func Create[T any](ctx context.Context, engine *Engine, object T, nsId ...uint64) (uint64, T, error)
• func Delete[T any, R UniqueField](ctx context.Context, engine *Engine, uniqueField R, nsId ...uint64) (uint64, T, error)
• func Get[T any, R UniqueField](ctx context.Context, engine *Engine, uniqueField R, nsId ...uint64) (uint64, T, error)
• func Query[T any](ctx context.Context, engine *Engine, queryParams QueryParams, nsId ...uint64) ([]uint64, []T, error)
• func Upsert[T any](ctx context.Context, engine *Engine, object T, nsId ...uint64) (uint64, T, bool, error)
• type Config
  • func NewDefaultConfig(dir string) Config
  • func (cc Config) WithLimitNormalizeNode(d int) Config
• type ConstrainedField
• type Engine
  • func NewEngine(conf Config) (*Engine, error)
  • func (engine *Engine) Close()
  • func (engine *Engine) CreateNamespace() (*Namespace, error)
  • func (engine *Engine) DropAll(ctx context.Context) error
  • func (engine *Engine) GetDefaultNamespace() *Namespace
  • func (engine *Engine) GetNamespace(nsID uint64) (*Namespace, error)
  • func (ns *Engine) LeaseUIDs(numUIDs uint64) (*pb.AssignedIds, error)
  • func (engine *Engine) Load(ctx context.Context, schemaPath, dataPath string) error
  • func (engine *Engine) LoadData(inCtx context.Context, dataDir string) error
• type Filter
• type ModusDbOption
  • func WithNamespace(ns uint64) ModusDbOption
• type Namespace
  • func (ns *Namespace) AlterSchema(ctx context.Context, sch string) error
  • func (ns *Namespace) DropData(ctx context.Context) error
  • func (ns *Namespace) ID() uint64
  • func (n *Namespace) Load(ctx context.Context, schemaPath, dataPath string) error
  • func (n *Namespace) LoadData(inCtx context.Context, dataDir string) error
  • func (ns *Namespace) Mutate(ctx context.Context, ms []*api.Mutation) (map[string]uint64, error)
  • func (ns *Namespace) Query(ctx context.Context, query string) (*api.Response, error)
• type Pagination
• type QueryParams
• type Sorting
• type StringPredicate
• type UniqueField
• type VectorPredicate

Variables

var (
	ErrSingletonOnly = errors.New("only one modusDB engine is supported")
	ErrEmptyDataDir  = errors.New("data directory is required")
	ErrClosedEngine  = errors.New("modusDB engine is closed")
	ErrNonExistentDB = errors.New("namespace does not exist")
)

Functions

func Create

func Create[T any](ctx context.Context, engine *Engine, object T,
	nsId ...uint64) (uint64, T, error)

func Delete

func Delete[T any, R UniqueField](ctx context.Context, engine *Engine, uniqueField R,
	nsId ...uint64) (uint64, T, error)

func Get

func Get[T any, R UniqueField](ctx context.Context, engine *Engine, uniqueField R,
	nsId ...uint64) (uint64, T, error)

func Query

func Query[T any](ctx context.Context, engine *Engine, queryParams QueryParams,
	nsId ...uint64) ([]uint64, []T, error)

func Upsert

func Upsert[T any](ctx context.Context, engine *Engine, object T,
	nsId ...uint64) (uint64, T, bool, error)

Types

type Config

type Config struct {
	// contains filtered or unexported fields
}

func NewDefaultConfig

func NewDefaultConfig(dir string) Config

func (Config) WithLimitNormalizeNode

func (cc Config) WithLimitNormalizeNode(d int) Config

type ConstrainedField

type ConstrainedField struct {
	Key   string
	Value any
}

type Engine

type Engine struct {
	// contains filtered or unexported fields
}

Engine is an instance of modusDB. For now, we only support one instance of modusDB per process.

func NewEngine

func NewEngine(conf Config) (*Engine, error)

NewEngine returns a new modusDB instance.

func (*Engine) Close

func (engine *Engine) Close()

Close closes the modusDB instance.

func (*Engine) CreateNamespace

func (engine *Engine) CreateNamespace() (*Namespace, error)

func (*Engine) DropAll

func (engine *Engine) DropAll(ctx context.Context) error

DropAll drops all the data and schema in the modusDB instance.

func (*Engine) GetDefaultNamespace

func (engine *Engine) GetDefaultNamespace() *Namespace

func (*Engine) GetNamespace

func (engine *Engine) GetNamespace(nsID uint64) (*Namespace, error)

func (*Engine) LeaseUIDs

func (ns *Engine) LeaseUIDs(numUIDs uint64) (*pb.AssignedIds, error)

func (*Engine) Load

func (engine *Engine) Load(ctx context.Context, schemaPath, dataPath string) error

func (*Engine) LoadData

func (engine *Engine) LoadData(inCtx context.Context, dataDir string) error

type Filter

type Filter struct {
	Field  string
	String StringPredicate
	Vector VectorPredicate
	And    *Filter
	Or     *Filter
	Not    *Filter
}

type ModusDbOption

type ModusDbOption func(*modusDbOptions)

func WithNamespace

func WithNamespace(ns uint64) ModusDbOption

type Namespace

type Namespace struct {
	// contains filtered or unexported fields
}

Namespace is one of the namespaces in modusDB.

func (*Namespace) AlterSchema

func (ns *Namespace) AlterSchema(ctx context.Context, sch string) error

func (*Namespace) DropData

func (ns *Namespace) DropData(ctx context.Context) error

DropData drops all the data in the modusDB instance.

func (*Namespace) ID

func (ns *Namespace) ID() uint64

func (*Namespace) Load

func (n *Namespace) Load(ctx context.Context, schemaPath, dataPath string) error

func (*Namespace) LoadData

func (n *Namespace) LoadData(inCtx context.Context, dataDir string) error

TODO: Add support for CSV file

func (*Namespace) Mutate

func (ns *Namespace) Mutate(ctx context.Context, ms []*api.Mutation) (map[string]uint64, error)

func (*Namespace) Query

func (ns *Namespace) Query(ctx context.Context, query string) (*api.Response, error)

Query performs query or mutation or upsert on the given modusDB instance.

type Pagination

type Pagination struct {
	Limit  int64
	Offset int64
	After  string
}

type QueryParams

type QueryParams struct {
	Filter     *Filter
	Pagination *Pagination
	Sorting    *Sorting
}

type Sorting

type Sorting struct {
	OrderAscField  string
	OrderDescField string
	OrderDescFirst bool
}

type StringPredicate

type StringPredicate struct {
	Equals         string
	LessThan       string
	LessOrEqual    string
	GreaterThan    string
	GreaterOrEqual string
	AllOfTerms     []string
	AnyOfTerms     []string
	AllOfText      []string
	AnyOfText      []string
	RegExp         string
}

type UniqueField

type UniqueField interface {
	uint64 | ConstrainedField
}

type VectorPredicate

type VectorPredicate struct {
	SimilarTo []float32
	TopK      int64
}