Installation

Mon, 01 Jan 0001 00:00:00 +0000

Requirements

Go 1.25 or later

Install via Go Modules

Add Zestor to your project:

go get github.com/zestor-dev/zestor

Import

Import the packages you need:

import (
 "github.com/zestor-dev/zestor/store"
 "github.com/zestor-dev/zestor/store/gomap" // In-memory store
)

For persistent storage with SQLite:

import (
 "github.com/zestor-dev/zestor/store"
 "github.com/zestor-dev/zestor/store/sqlite" // SQLite store
 "github.com/zestor-dev/zestor/codec" // Serialization codecs
)

For PostgreSQL (server-backed persistence and cross-process watch):

import (
 "github.com/zestor-dev/zestor/store"
 "github.com/zestor-dev/zestor/store/postgres"
 "github.com/zestor-dev/zestor/codec"
)

Package Overview

Package	Description
`store`	Core interfaces, types, and options
`store/gomap`	In-memory implementation
`store/sqlite`	SQLite-backed persistent implementation
`store/postgres`	PostgreSQL-backed implementation
`codec`	Serialization codecs (JSON, Protobuf, YAML)

Verify Installation

Create a simple test file:

Quick Start

Mon, 01 Jan 0001 00:00:00 +0000

This guide walks you through building a simple application using Zestor.

Create a Store

First, define your data type and create a store. Zestor ships several implementations; three common ones are below.

In-Memory Store (gomap)

Best for: caching, testing, ephemeral data.

package main

import (
 "fmt"
 "github.com/zestor-dev/zestor/store"
 "github.com/zestor-dev/zestor/store/gomap"
)

type User struct {
 Name string
 Email string
 Role string
}

func main() {
 // Create a new in-memory store
 s := gomap.NewMemStore[User](store.StoreOptions[User]{})
 defer s.Close()
}

SQLite Store (sqlite)

Best for: persistence, desktop apps, CLI tools.

Getting Started on Zestor