Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

modusgraph

package module

Go to main page

Versions in this module

v0

v0.2.0

Jul 23, 2025

Changes in this version

+ var ErrInvalidCacheSize = errors.New("cache size must be zero or positive")

+ func Shutdown()

type ClientOpt

+ func WithCacheSizeMB(size int) ClientOpt

+ func WithMaxEdgeTraversal(max int) ClientOpt

type Config

+ func (cc Config) WithCacheSizeMB(size int) Config

+ type UniqueError = dg.UniqueError

v0.2.0-preview1

Jun 18, 2025

v0.1.0

May 21, 2025

Changes in this version

+ const DgraphURIPrefix

+ const FileURIPrefix

+ var ErrClosedEngine = errors.New("modusDB engine is closed")

+ var ErrEmptyDataDir = errors.New("data directory is required")

+ var ErrNonExistentDB = errors.New("namespace does not exist")

+ var ErrSingletonOnly = errors.New("only one instance of modusDB can exist in a process")

+ 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 ResetSingleton()

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

+ type Client interface

+ Close func()

+ Delete func(context.Context, []string) error

+ DgraphClient func() (*dgo.Dgraph, func(), error)

+ DropAll func(context.Context) error

+ DropData func(context.Context) error

+ Get func(context.Context, any, string) error

+ GetSchema func(context.Context) (string, error)

+ Insert func(context.Context, any) error

+ Query func(context.Context, any) *dg.Query

+ QueryRaw func(context.Context, string, map[string]string) ([]byte, error)

+ Update func(context.Context, any) error

+ UpdateSchema func(context.Context, ...any) error

+ Upsert func(context.Context, any) error

+ func NewClient(uri string, opts ...ClientOpt) (Client, error)

+ type ClientOpt func(*clientOptions)

+ func WithAutoSchema(enable bool) ClientOpt

+ func WithLogger(logger logr.Logger) ClientOpt

+ func WithNamespace(namespace string) ClientOpt

+ func WithPoolSize(size int) ClientOpt

+ type Config struct

+ func NewDefaultConfig(dir string) Config

+ func (cc Config) WithLimitNormalizeNode(d int) Config

+ func (cc Config) WithLogger(logger logr.Logger) Config

+ type ConstrainedField struct

+ Key string

+ Value any

+ type Engine struct

+ 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) GetClient() (*dgo.Dgraph, error)

+ func (engine *Engine) GetDefaultNamespace() *Namespace

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

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

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

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

+ type Filter struct

+ And *Filter

+ Field string

+ Not *Filter

+ Or *Filter

+ String StringPredicate

+ Vector VectorPredicate

+ type ModusDbOption func(*modusDbOptions)

+ func WithNamespaceOLD(ns uint64) ModusDbOption

+ type Namespace struct

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

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

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

+ func (ns *Namespace) DropAll(ctx context.Context) error

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

+ func (ns *Namespace) ID() uint64

+ 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)

+ func (ns *Namespace) QueryWithVars(ctx context.Context, query string, vars map[string]string) (*api.Response, error)

+ type Pagination struct

+ After string

+ Limit int64

+ Offset int64

+ type QueryParams struct

+ Filter *Filter

+ Pagination *Pagination

+ Sorting *Sorting

+ type Sorting struct

+ OrderAscField string

+ OrderDescField string

+ OrderDescFirst bool

+ type StringPredicate struct

+ AllOfTerms []string

+ AllOfText []string

+ AnyOfTerms []string

+ AnyOfText []string

+ Equals string

+ GreaterOrEqual string

+ GreaterThan string

+ LessOrEqual string

+ LessThan string

+ RegExp string

+ type UniqueField interface

+ type VectorPredicate struct

+ SimilarTo []float32

+ TopK int64