poki

README

Poki

Poki is a gRPC and protobuf based database inspired by CouchDB.

Features

NONE!

Roadmap

• Store protobuf messages via BoltDB.
• Implement all CouchApp functions (validator, updater, map, reduce, rereduce, transform).

FAQ

• Why?
  • JSON has some issues with databases. Protobuf makes document storage stricter and easier to manage at the same time.

Documentation

Index

• type Client
  • func DialServer(ctx context.Context, addr net.Addr) (*Client, error)
  • func (c *Client) StoreDocument(id string, payload *any.Any) (string, error)
• type MetaData
• type Post
• type PostRev

Types

type Client

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

Client connects to a poki server and allows requests to be made

func DialServer

func DialServer(ctx context.Context, addr net.Addr) (*Client, error)

DialServer establishes a connection to the poki server

func (*Client) StoreDocument

func (c *Client) StoreDocument(id string, payload *any.Any) (string, error)

StoreDocument will attempt to store the document in the poki server. Upon successful completion, a revision ID will be returned.

type MetaData

type MetaData struct {
	Title string
}

type Post

type Post struct {
	Path string
	Raw  []byte
	Meta MetaData
}

type PostRev

type PostRev struct {
	Post
	RevisionID string
}