store

Documentation

Index

• Constants
• Variables
• func NewDatabaseExistError(name string) error
• func NewDatabaseNotExistError(name string) error
• func NewDatabaseOptionsInvalidError(opts any) error
• func NewObjectNotExistError(key Key) error
• func NewSchemaNotExistError(name string) error
• type Collection
• type Database
• type DatabaseOperation
• type DatabaseOptions
• type DocumentOperation
• type IndexOperation
• type Key
• type LimitOption
  • func NewLimitOptionWith(limit int) *LimitOption
• type Object
• type OffsetOption
  • func NewOffsetOption(offset uint) *OffsetOption
• type Option
• type Order
• type OrderOption
  • func NewOrderOptionWith(order Order) *OrderOption
• type ResultSet
• type Schema
• type Store
• type Transaction
• type TransactionOperation

Constants

const (
	OrderNone = Order(0)
	OrderAsc  = Order(1)
	OrderDesc = Order(2)
)

Order options.

Variables

var (
	ErrNotExist = errors.New("not exist")
	ErrExist    = errors.New("exist")
	ErrInvalid  = errors.New("invalid")
)

var NoLimit = int(0)

NoLimit represents a no limit option.

var NoOffset = uint(0)

NoOffset represents a no offset option.

Functions

func NewDatabaseExistError

func NewDatabaseExistError(name string) error

func NewDatabaseNotExistError

func NewDatabaseNotExistError(name string) error

func NewDatabaseOptionsInvalidError

func NewDatabaseOptionsInvalidError(opts any) error

func NewObjectNotExistError

func NewObjectNotExistError(key Key) error

func NewSchemaNotExistError

func NewSchemaNotExistError(name string) error

Types

type Collection

type Collection = document.Collection

type Database

type Database interface {
	// Name returns the unique name.
	Name() string
	// Options returns the database options.
	Options() DatabaseOptions
	// Transact begin a new transaction.
	Transact(write bool) (Transaction, error)
}

Database represents a database interface.

type DatabaseOperation

type DatabaseOperation interface {
	// CreateCollection creates a new collection.
	CreateCollection(ctx context.Context, col Collection) error
	// GetCollection returns the specified collection.
	GetCollection(ctx context.Context, name string) (Collection, error)
	// RemoveCollection removes the specified collection.
	RemoveCollection(ctx context.Context, name string) error
	// TruncateCollections removes all collections.
	TruncateCollections(ctx context.Context) error
}

DatabaseOperation represents a database operation.

type DatabaseOptions

type DatabaseOptions = map[string]interface{}

DatabaseOptions represents a database options.

type DocumentOperation

type DocumentOperation interface {
	// InsertDocument puts a document object with the specified primary key.
	InsertDocument(ctx context.Context, docKey Key, obj Object) error
	// FindDocuments returns a result set matching the specified key.
	FindDocuments(ctx context.Context, docKey Key, opts ...Option) (ResultSet, error)
	// UpdateDocument updates a document object with the specified primary key.
	UpdateDocument(ctx context.Context, docKey Key, obj Object) error
	// RemoveDocument removes a document object with the specified primary key.
	RemoveDocument(ctx context.Context, docKey Key) error
	// RemoveDocuments removes document objects with the specified primary key.
	RemoveDocuments(ctx context.Context, docKey Key) error
	// TruncateDocuments removes all document objects.
	TruncateDocuments(ctx context.Context) error
}

DocumentOperation represents a document operation.

type IndexOperation

type IndexOperation interface {
	// InsertIndex puts a secondary index with the primary key.
	InsertIndex(ctx context.Context, idxKey Key, key Key) error
	// RemoveIndex removes the specified secondary index.
	RemoveIndex(ctx context.Context, idxKey Key) error
	// FindDocumentsByIndex returns a result set matching the specified index key.
	FindDocumentsByIndex(ctx context.Context, indexKey Key, opts ...Option) (ResultSet, error)
	// TruncateIndexes removes all secondary indexes.
	TruncateIndexes(ctx context.Context) error
}

IndexOperation represents a secondary index operation.

type Key

type Key = document.Key

Key represents an object key.

type LimitOption

type LimitOption struct {
	Limit int
}

LimitOption represents a limit option.

func NewLimitOptionWith

func NewLimitOptionWith(limit int) *LimitOption

NewLimitOptionWith returns a new limit option.

type Object

type Object = document.Object

Object represents a store object.

type OffsetOption

type OffsetOption struct {
	Offset uint
}

OffsetOption represents an offset option.

func NewOffsetOption

func NewOffsetOption(offset uint) *OffsetOption

NewLimitOption returns a new offset option.

type Option

type Option = any

Option represents a option.

type Order

type Order = int

Order represents a order.

type OrderOption

type OrderOption struct {
	Order Order
}

OrderOption represents a order option.

func NewOrderOptionWith

func NewOrderOptionWith(order Order) *OrderOption

NewOrderOptionWith returns a new order option.

type ResultSet

type ResultSet interface {
	// Next moves the cursor forward next object from its current position.
	Next() bool
	// Object returns an object in the current position.
	Object() Object
	// Object returns all objects in the result set.
	Objects() []Object
}

ResultSet represents a result set which includes query execution results.

type Schema

type Schema = document.Schema

type Store

type Store interface {
	// SetDocumentCoder sets the document coder.
	SetDocumentCoder(coder document.Coder)
	// SetKeyCoder sets the key coder.
	SetKeyCoder(coder document.KeyCoder)
	// CreateDatabase creates a new database.
	CreateDatabase(ctx context.Context, name string) error
	// GetDatabase retruns the specified database.
	GetDatabase(ctx context.Context, name string) (Database, error)
	// RemoveDatabase removes the specified database.
	RemoveDatabase(ctx context.Context, name string) error
	// ListDatabases returns the all databases.
	ListDatabases(ctx context.Context) ([]Database, error)
}

Store represents a store interface.

type Transaction

type Transaction interface {
	TransactionOperation
	// Database returns the transaction database.
	Database() Database
	// Commit commits this transaction.
	Commit(ctx context.Context) error
	// Cancel cancels this transaction.
	Cancel(ctx context.Context) error
}

Transaction represents a transaction interface.

type TransactionOperation

type TransactionOperation interface {
	DatabaseOperation
	DocumentOperation
	IndexOperation
}

TransactionOperation represents a transaction operation.