docstore

Documentation

Index

• Variables
• type Document
• type IndexConfig
• type QueryOptions
• type QueryResult
• type Store
• type WhereFilter
• type WriteOptions

Variables

var (
	ErrNotFound       = errors.New("document not found")
	ErrConflict       = errors.New("document already exists")
	ErrInvalidIndex   = errors.New("field is not indexed")
	ErrInvalidRequest = errors.New("invalid document request")
)

Types

type Document

type Document struct {
	Collection string
	ID         string
	Value      []byte
	Version    int64
	CreatedAt  time.Time
	UpdatedAt  time.Time
	ExpiresAt  *time.Time
}

type IndexConfig

type IndexConfig struct {
	Fields       []string `json:"fields"`
	SearchFields []string `json:"searchFields"`
}

type QueryOptions

type QueryOptions struct {
	Where  *WhereFilter
	Search string
	Limit  int
	Cursor string
}

type QueryResult

type QueryResult struct {
	Documents  []Document
	NextCursor string
	HasMore    bool
}

type Store

type Store interface {
	MigrateDocs(ctx context.Context) error
	ConfigureIndexes(ctx context.Context, db int, collection string, cfg IndexConfig) (IndexConfig, error)
	GetIndexConfig(ctx context.Context, db int, collection string) (IndexConfig, error)
	PutDoc(ctx context.Context, db int, collection, id string, value []byte, opts WriteOptions, createOnly bool) (Document, bool, error)
	GetDoc(ctx context.Context, db int, collection, id string) (Document, error)
	DeleteDoc(ctx context.Context, db int, collection, id string) (bool, error)
	QueryDocs(ctx context.Context, db int, collection string, opts QueryOptions) (QueryResult, error)
}

type WhereFilter

type WhereFilter struct {
	Field string
	Op    string
	Value string
}

type WriteOptions

type WriteOptions struct {
	IndexedFields []string
	SearchFields  []string
	TTL           time.Duration
}