README
¶
MySQL Storage for Tessera
This directory contains the implementation of a storage backend for Tessera using MySQL. This allows Tessera to leverage MySQL as its underlying database for storing checkpoint, entry hashes and data in tiles format.
Design
See MySQL storage design documentation.
Requirements
- A running MySQL server instance. This storage implementation has been tested against MySQL 8.4.
Usage
Constructing the Storage Object
Here is an example code snippet to initialise the MySQL storage in Tessera.
import (
"context"
"github.com/transparency-dev/tessera"
"github.com/transparency-dev/tessera/storage/mysql"
"k8s.io/klog/v2"
)
func main() {
mysqlURI := "user:password@tcp(db:3306)/tessera"
db, err := sql.Open("mysql", mysqlURI)
if err != nil {
klog.Exitf("Failed to connect to DB: %v", err)
}
storage, err := mysql.New(ctx, db)
if err != nil {
klog.Exitf("Failed to create new MySQL storage: %v", err)
}
}
Example personality
See MySQL conformance example.
Future Work
Documentation
¶
Overview ¶
Package mysql contains a MySQL-based storage implementation for Tessera.
Index ¶
- type MigrationStorage
- type Storage
- func (s *Storage) Appender(ctx context.Context, opts *tessera.AppendOptions) (*tessera.Appender, tessera.LogReader, error)
- func (s *Storage) IntegratedSize(ctx context.Context) (uint64, error)
- func (s *Storage) MigrationWriter(ctx context.Context, opts *tessera.MigrationOptions) (migrate.MigrationWriter, tessera.LogReader, error)
- func (s *Storage) NextIndex(ctx context.Context) (uint64, error)
- func (s *Storage) ReadCheckpoint(ctx context.Context) ([]byte, error)
- func (s *Storage) ReadEntryBundle(ctx context.Context, index uint64, p uint8) ([]byte, error)
- func (s *Storage) ReadTile(ctx context.Context, level, index uint64, p uint8) ([]byte, error)
- func (s *Storage) StreamEntries(ctx context.Context, startEntry, N uint64) iter.Seq2[stream.Bundle, error]
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type MigrationStorage ¶
type MigrationStorage struct {
// contains filtered or unexported fields
}
MigrationStorgage implements the tessera.MigrationTarget lifecycle contract.
func (*MigrationStorage) AwaitIntegration ¶
AwaitIntegration blocks until the local integrated tree has grown to the provided size.
This implements part of the tessera MigrationTarget lifecycle contract.
As well as waiting for the integration to reach the desired size, this method is where the integration process itself actually happens.
func (*MigrationStorage) IntegratedSize ¶
func (m *MigrationStorage) IntegratedSize(ctx context.Context) (uint64, error)
IntegratedSize returns the current size of the locally integrated log.
Implements the tessera MigrationTarget lifecycle contract.
func (*MigrationStorage) SetEntryBundle ¶
func (m *MigrationStorage) SetEntryBundle(ctx context.Context, index uint64, partial uint8, bundle []byte) error
SetEntryBundle stores the provided serialised entry bundle at the location implied by the provided entry bundle index and partial size.
Implements the tessera MigrationTarget lifecycle contract.
type Storage ¶
type Storage struct {
// contains filtered or unexported fields
}
Storage is a MySQL-based storage implementation for Tessera.
func (*Storage) Appender ¶
func (s *Storage) Appender(ctx context.Context, opts *tessera.AppendOptions) (*tessera.Appender, tessera.LogReader, error)
Note that `tessera.WithCheckpointSigner()` is mandatory in the `opts` argument.
func (*Storage) IntegratedSize ¶
IntegratedSize returns the current size of the integrated tree.
This is part of the tessera LogReader contract.
func (*Storage) MigrationWriter ¶
func (s *Storage) MigrationWriter(ctx context.Context, opts *tessera.MigrationOptions) (migrate.MigrationWriter, tessera.LogReader, error)
MigrationWriter creates a new MySQL storage for the MigrationTarget lifecycle mode.
func (*Storage) NextIndex ¶
NextIndex returns the next available leaf index.
Currently, this is the same as the integrated size since new leaves are integrated synchronously. This is part of the tessera LogReader contract.
func (*Storage) ReadCheckpoint ¶
ReadCheckpoint returns the latest stored checkpoint. If the checkpoint is not found, it returns os.ErrNotExist.
func (*Storage) ReadEntryBundle ¶
ReadEntryBundle returns the log entries at the given index. If the entry bundle is not found, it returns os.ErrNotExist.
Note that if a partial tile is requested, but a larger tile is available, this will return the largest tile available. This could be trimmed to return only the number of entries specifically requested if this behaviour becomes problematic.
func (*Storage) ReadTile ¶
ReadTile returns a full tile or a partial tile at the given level, index and treeSize. If the tile is not found, it returns os.ErrNotExist.
Note that if a partial tile is requested, but a larger tile is available, this will return the largest tile available. This could be trimmed to return only the number of entries specifically requested if this behaviour becomes problematic.
func (*Storage) StreamEntries ¶
func (s *Storage) StreamEntries(ctx context.Context, startEntry, N uint64) iter.Seq2[stream.Bundle, error]
StreamEntries() returns functions `next` and `cancel` which act like a pull iterator for consecutive entry bundles, starting with the entry bundle which contains the requested entry index.
This is part of the tessera LogReader contract.
Source Files