dbset

Documentation

Index

• type DBSet
  • func NewDBSet(db sql.Executor, st *sqlstore.SyncedTable, keyLen, maxDepth int) *DBSet
  • func (d *DBSet) Add(k rangesync.KeyBytes) error
  • func (d *DBSet) Advance() error
  • func (d *DBSet) Copy(syncScope bool) rangesync.OrderedSet
  • func (d *DBSet) Empty() (bool, error)
  • func (d *DBSet) EnsureLoaded() error
  • func (d *DBSet) GetRangeInfo(x, y rangesync.KeyBytes) (rangesync.RangeInfo, error)
  • func (d *DBSet) Has(k rangesync.KeyBytes) (bool, error)
  • func (d *DBSet) Items() rangesync.SeqResult
  • func (d *DBSet) Receive(k rangesync.KeyBytes) error
  • func (d *DBSet) Received() rangesync.SeqResult
  • func (d *DBSet) Recent(since time.Time) (rangesync.SeqResult, int)
  • func (d *DBSet) Release() error
  • func (d *DBSet) SplitRange(x, y rangesync.KeyBytes, count int) (rangesync.SplitInfo, error)

Types

type DBSet

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

DBSet is an implementation of rangesync.OrderedSet that uses an SQL database as its backing store. It uses an FPTree to perform efficient range queries.

func NewDBSet

func NewDBSet(
	db sql.Executor,
	st *sqlstore.SyncedTable,
	keyLen, maxDepth int,
) *DBSet

NewDBSet creates a new DBSet.

func (*DBSet) Add

func (d *DBSet) Add(k rangesync.KeyBytes) error

Add adds an item to the DBSet. Implements rangesync.OrderedSet.

func (*DBSet) Advance

func (d *DBSet) Advance() error

Advance advances the DBSet to the latest state of the underlying database table.

func (*DBSet) Copy

func (d *DBSet) Copy(syncScope bool) rangesync.OrderedSet

Copy creates a copy of the DBSet. Implements rangesync.OrderedSet.

func (*DBSet) Empty

func (d *DBSet) Empty() (bool, error)

Empty returns true if the DBSet is empty. Implements rangesync.OrderedSet.

func (*DBSet) EnsureLoaded

func (d *DBSet) EnsureLoaded() error

EnsureLoaded ensures that the DBSet is loaded and ready to be used.

func (*DBSet) GetRangeInfo

func (d *DBSet) GetRangeInfo(x, y rangesync.KeyBytes) (rangesync.RangeInfo, error)

GetRangeInfo returns information about the range of items in the DBSet. Implements rangesync.OrderedSet.

func (*DBSet) Has

func (d *DBSet) Has(k rangesync.KeyBytes) (bool, error)

Has returns true if the DBSet contains the given item.

func (*DBSet) Items

func (d *DBSet) Items() rangesync.SeqResult

Items returns a sequence of all items in the DBSet. Implements rangesync.OrderedSet.

func (*DBSet) Receive

func (d *DBSet) Receive(k rangesync.KeyBytes) error

Receive handles a newly received item, arranging for it to be returned as part of the sequence returned by Received. Implements rangesync.OrderedSet.

func (*DBSet) Received

func (d *DBSet) Received() rangesync.SeqResult

Received returns a sequence of all items that have been received. Implements rangesync.OrderedSet.

func (*DBSet) Recent

func (d *DBSet) Recent(since time.Time) (rangesync.SeqResult, int)

Recent returns a sequence of items that have been added to the DBSet since the given time.

func (*DBSet) Release

func (d *DBSet) Release() error

Release releases resources associated with the DBSet.

func (*DBSet) SplitRange

func (d *DBSet) SplitRange(x, y rangesync.KeyBytes, count int) (rangesync.SplitInfo, error)

SplitRange splits the range of items in the DBSet into two parts, returning information about eachn part and the middle item. Implements rangesync.OrderedSet.