database

May 1, 2021

Changes in this version

+ var ErrIndexWrongArity = errors.New("wrong index arity")

+ func CastConversion(v document.Value, path document.Path, targetType document.ValueType) (document.Value, error)

+ func LosslessNumbersConversion(v document.Value, path document.Path, targetType document.ValueType) (document.Value, error)

+ type ConversionFunc func(v document.Value, path document.Path, targetType document.ValueType) (document.Value, error)

type FieldConstraint

+ IsUnique bool

type FieldConstraints

+ func (f FieldConstraints) ConvertValueAtPath(path document.Path, v document.Value, conversionFn ConversionFunc) (document.Value, error)

+ func (f FieldConstraints) Get(path document.Path) *FieldConstraint

type Index

+ func (idx *Index) Arity() int

+ func (idx *Index) EncodeValueBuffer(vb *document.ValueBuffer) ([]byte, error)

+ func (idx *Index) IsComposite() bool

type IndexInfo

+ Paths []document.Path

+ Types []document.ValueType

+ type Pivot []document.Value

+ func (pivot Pivot) IsAny() bool

Mar 16, 2021

Changes in this version

+ var ErrIndexDuplicateValue = errors.New("duplicate value")

+ type Catalog struct

+ func NewCatalog() *Catalog

+ func (c *Catalog) AddFieldConstraint(tx *Transaction, tableName string, fc FieldConstraint) error

+ func (c *Catalog) Clone() *Catalog

+ func (c *Catalog) CreateIndex(tx *Transaction, opts IndexInfo) error

+ func (c *Catalog) CreateTable(tx *Transaction, tableName string, info *TableInfo) error

+ func (c *Catalog) DropIndex(tx *Transaction, name string) error

+ func (c *Catalog) DropTable(tx *Transaction, tableName string) error

+ func (c *Catalog) GetIndex(tx *Transaction, indexName string) (*Index, error)

+ func (c *Catalog) GetTable(tx *Transaction, tableName string) (*Table, error)

+ func (c *Catalog) ListIndexes(tableName string) []string

+ func (c *Catalog) Load(tx *Transaction) error

+ func (c *Catalog) ReIndex(tx *Transaction, indexName string) error

+ func (c *Catalog) ReIndexAll(tx *Transaction) error

+ func (c *Catalog) RenameTable(tx *Transaction, oldName, newName string) error

type Database

+ func (db *Database) Catalog() *Catalog

type FieldConstraint

+ InferredBy []document.Path

+ IsInferred bool

+ func (f *FieldConstraint) IsEqual(other *FieldConstraint) (bool, error)

+ func (f *FieldConstraint) MergeInferred(other *FieldConstraint)

+ func (f *FieldConstraint) String() string

type FieldConstraints

+ func NewFieldConstraints(userConstraints []*FieldConstraint) (FieldConstraints, error)

+ func (f *FieldConstraints) Add(newFc *FieldConstraint) error

+ func (f FieldConstraints) ConvertDocument(d document.Document) (*document.FieldBuffer, error)

+ func (f FieldConstraints) Infer() (FieldConstraints, error)

type Index

+ Info *IndexInfo

+ func NewIndex(tx engine.Transaction, idxName string, opts *IndexInfo) *Index

+ func (idx *Index) AscendGreaterOrEqual(pivot document.Value, fn func(val, key []byte) error) error

+ func (idx *Index) Delete(v document.Value, k []byte) error

+ func (idx *Index) DescendLessOrEqual(pivot document.Value, fn func(val, key []byte) error) error

+ func (idx *Index) EncodeValue(v document.Value) ([]byte, error)

+ func (idx *Index) Set(v document.Value, k []byte) error

+ func (idx *Index) Truncate() error

+ type IndexInfo struct

+ IndexName string

+ Path document.Path

+ TableName string

+ Type document.ValueType

+ Unique bool

+ func (i *IndexInfo) ScanDocument(d document.Document) error

+ func (i *IndexInfo) ToDocument() document.Document

+ func (i IndexInfo) Clone() *IndexInfo

+ type Indexes []*Index

+ func (i Indexes) GetIndex(name string) *Index

+ func (i Indexes) GetIndexByPath(p document.Path) *Index

type Table

+ func (t *Table) EncodeValue(v document.Value) ([]byte, error)

type TableInfo

+ func (ti *TableInfo) Clone() *TableInfo

type Transaction

+ func (tx *Transaction) AddFieldConstraint(tableName string, fc FieldConstraint) error

Jan 26, 2021

Changes in this version

type Table

+ func (t *Table) AscendGreaterOrEqual(pivot document.Value, fn func(d document.Document) error) error

+ func (t *Table) DescendLessOrEqual(pivot document.Value, fn func(d document.Document) error) error

+ func (t *Table) EncodeValueToKey(v document.Value) ([]byte, error)

Nov 12, 2020

Changes in this version

type FieldConstraint

+ DefaultValue document.Value

+ func (f *FieldConstraint) HasDefaultValue() bool

+ type FieldConstraints []FieldConstraint

+ func (f FieldConstraints) Convert(d document.Document) (*document.FieldBuffer, error)

+ func (f FieldConstraints) ValidateDocument(d document.Document) (document.Document, error)

type Transaction

+ func (tx *Transaction) AddField(name string, fc FieldConstraint) error

Sep 26, 2020

Changes in this version

type Database

+ Codec encoding.Codec

+ func (db *Database) BeginTx(opts *TxOptions) (*Transaction, error)

+ func (db *Database) GetAttachedTx() *Transaction

type IndexConfig

+ Type document.ValueType

+ type Options struct

+ Codec encoding.Codec

type Table

+ func (t *Table) Tx() *Transaction

type Transaction

+ func (tx *Transaction) DB() *Database

+ type TxOptions struct

+ Attached bool

+ ReadOnly bool

Aug 25, 2020

Changes in this version

type Index

+ Opts IndexConfig

type Table

+ func (t *Table) Info() (*TableInfo, error)

+ func (t *Table) Name() string

+ func (t *Table) ReIndex() error

+ type TableInfo struct

+ FieldConstraints []FieldConstraint

+ func (ti *TableInfo) GetPrimaryKey() *FieldConstraint

+ func (ti *TableInfo) ScanDocument(d document.Document) error

+ func (ti *TableInfo) ToDocument() document.Document

type Transaction

+ func (tx *Transaction) RenameTable(oldName, newName string) error

Jun 28, 2020

Changes in this version

+ var ErrDocumentNotFound = errors.New("document not found")

+ var ErrDuplicateDocument = errors.New("duplicate document")

+ var ErrIndexAlreadyExists = errors.New("index already exists")

+ var ErrIndexNotFound = errors.New("index not found")

+ var ErrTableAlreadyExists = errors.New("table already exists")

+ var ErrTableNotFound = errors.New("table not found")

+ type Database struct

+ func New(ng engine.Engine) (*Database, error)

+ func (db *Database) Begin(writable bool) (*Transaction, error)

+ func (db *Database) Close() error

+ type FieldConstraint struct

+ IsNotNull bool

+ IsPrimaryKey bool

+ Path document.ValuePath

+ Type document.ValueType

+ func (f *FieldConstraint) ScanDocument(d document.Document) error

+ func (f *FieldConstraint) ToDocument() document.Document

+ type Index struct

+ IndexName string

+ Path document.ValuePath

+ TableName string

+ Unique bool

+ type IndexConfig struct

+ IndexName string

+ Path document.ValuePath

+ TableName string

+ Unique bool

+ func (i *IndexConfig) ScanDocument(d document.Document) error

+ func (i *IndexConfig) ToDocument() document.Document

+ type Table struct

+ Store engine.Store

+ func (t *Table) Config() (*TableConfig, error)

+ func (t *Table) Delete(key []byte) error

+ func (t *Table) GetDocument(key []byte) (document.Document, error)

+ func (t *Table) Indexes() (map[string]Index, error)

+ func (t *Table) Insert(d document.Document) ([]byte, error)

+ func (t *Table) Iterate(fn func(d document.Document) error) error

+ func (t *Table) Replace(key []byte, d document.Document) error

+ func (t *Table) TableName() string

+ func (t *Table) Truncate() error

+ func (t *Table) ValidateConstraints(d document.Document) (document.Document, error)

+ type TableConfig struct

+ FieldConstraints []FieldConstraint

+ LastKey int64

+ func (t *TableConfig) ScanDocument(d document.Document) error

+ func (t *TableConfig) ToDocument() document.Document

+ func (t TableConfig) GetPrimaryKey() *FieldConstraint

+ type Transaction struct

+ Tx engine.Transaction

+ func (tx *Transaction) Commit() error

+ func (tx *Transaction) Promote() error

+ func (tx *Transaction) Rollback() error

+ func (tx *Transaction) Writable() bool

+ func (tx Transaction) CreateIndex(opts IndexConfig) error

+ func (tx Transaction) CreateTable(name string, cfg *TableConfig) error

+ func (tx Transaction) DropIndex(name string) error

+ func (tx Transaction) DropTable(name string) error

+ func (tx Transaction) GetIndex(name string) (*Index, error)

+ func (tx Transaction) GetTable(name string) (*Table, error)

+ func (tx Transaction) ListIndexes() ([]*IndexConfig, error)

+ func (tx Transaction) ListTables() ([]string, error)

+ func (tx Transaction) ReIndex(indexName string) error

+ func (tx Transaction) ReIndexAll() error