persistence

Documentation

Index

• Variables
• func Clean(db *sql.DB, tableName string) error
• func CreateTable(db *sql.DB, tableName string) error
• type DBOption
  • func WithDB(db *sql.DB) DBOption
  • func WithRetentionPolicy(maxMessages int, maxDuration time.Duration) DBOption
• type DBStore
  • func NewDBStore(log *zap.Logger, options ...DBOption) (*DBStore, error)
  • func (d *DBStore) Count() (int, error)
  • func (d *DBStore) GetAll() ([]gowakuPersistence.StoredMessage, error)
  • func (d *DBStore) GetStoredMessage(row *sql.Rows) (gowakuPersistence.StoredMessage, error)
  • func (d *DBStore) MostRecentTimestamp() (int64, error)
  • func (d *DBStore) Put(env *protocol.Envelope) error
  • func (d *DBStore) Query(query *pb.HistoryQuery) (*pb.Index, []gowakuPersistence.StoredMessage, error)
  • func (d *DBStore) Start(timesource timesource.Timesource) error
  • func (d *DBStore) Stop()
• type Queries
  • func NewQueries(tbl string, db *sql.DB) (*Queries, error)
  • func (q Queries) Delete() string
  • func (q Queries) Exists() string
  • func (q Queries) Get() string
  • func (q Queries) GetSize() string
  • func (q Queries) Limit() string
  • func (q Queries) Offset() string
  • func (q Queries) Prefix() string
  • func (q Queries) Put() string
  • func (q Queries) Query() string

Variables

var ErrInvalidCursor = errors.New("invalid cursor")

Functions

func Clean

func Clean(db *sql.DB, tableName string) error

func CreateTable

func CreateTable(db *sql.DB, tableName string) error

CreateTable creates the table that will persist the peers

Types

type DBOption

type DBOption func(*DBStore) error

DBOption is an optional setting that can be used to configure the DBStore

func WithDB

func WithDB(db *sql.DB) DBOption

WithDB is a DBOption that lets you use any custom *sql.DB with a DBStore.

func WithRetentionPolicy

func WithRetentionPolicy(maxMessages int, maxDuration time.Duration) DBOption

WithRetentionPolicy is a DBOption that specifies the max number of messages to be stored and duration before they're removed from the message store

type DBStore

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

DBStore is a MessageProvider that has a *sql.DB connection

func NewDBStore

func NewDBStore(log *zap.Logger, options ...DBOption) (*DBStore, error)

Creates a new DB store using the db specified via options. It will create a messages table if it does not exist and clean up records according to the retention policy used

func (*DBStore) Count

func (d *DBStore) Count() (int, error)

Count returns the number of rows in the message table

func (*DBStore) GetAll

func (d *DBStore) GetAll() ([]gowakuPersistence.StoredMessage, error)

GetAll returns all the stored WakuMessages

func (*DBStore) GetStoredMessage

func (d *DBStore) GetStoredMessage(row *sql.Rows) (gowakuPersistence.StoredMessage, error)

GetStoredMessage is a helper function used to convert a `*sql.Rows` into a `StoredMessage`

func (*DBStore) MostRecentTimestamp

func (d *DBStore) MostRecentTimestamp() (int64, error)

MostRecentTimestamp returns an unix timestamp with the most recent senderTimestamp in the message table

func (*DBStore) Put

func (d *DBStore) Put(env *protocol.Envelope) error

Put inserts a WakuMessage into the DB

func (*DBStore) Query

func (d *DBStore) Query(query *pb.HistoryQuery) (*pb.Index, []gowakuPersistence.StoredMessage, error)

Query retrieves messages from the DB

func (*DBStore) Start

func (d *DBStore) Start(timesource timesource.Timesource) error

func (*DBStore) Stop

func (d *DBStore) Stop()

Stop closes a DB connection

type Queries

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

Queries are the sqlite queries for a given table.

func NewQueries

func NewQueries(tbl string, db *sql.DB) (*Queries, error)

NewQueries creates a new set of queries for the passed table

func (Queries) Delete

func (q Queries) Delete() string

Delete returns the query for deleting a row.

func (Queries) Exists

func (q Queries) Exists() string

Exists returns the query for determining if a row exists.

func (Queries) Get

func (q Queries) Get() string

Get returns the query for getting a row.

func (Queries) GetSize

func (q Queries) GetSize() string

GetSize returns the query for determining the size of a value.

func (Queries) Limit

func (q Queries) Limit() string

Limit returns the query fragment for limiting results.

func (Queries) Offset

func (q Queries) Offset() string

Offset returns the query fragment for returning rows from a given offset.

func (Queries) Prefix

func (q Queries) Prefix() string

Prefix returns the query fragment for getting a rows with a key prefix.

func (Queries) Put

func (q Queries) Put() string

Put returns the query for putting a row.

func (Queries) Query

func (q Queries) Query() string

Query returns the query for getting multiple rows.