blobs

README

fdb-blobs

WARNING - under construction :-)

A blob store for FoundationDB that handles arbitrary size blobs by splitting the data into chunks.

Tests

Start all the services:

docker compose up -d

Run all tests:

docker compose exec blobs go test

Run a specific test:

docker compose exec blobs go test -run TestCreate

Sending arguments to go test:

docker compose exec blobs go test -cover

Running fuzz tests:

docker compose exec blobs go test -fuzz FuzzChunkSizes

MIT License

Copyright (c) 2023 Sune Simonsen mailto:sune@we-knowhow.dk

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Documentation

Index

• Variables
• type Blob
  • func (blob *Blob) Content(ctx context.Context) ([]byte, error)
  • func (blob *Blob) CreatedAt() (time.Time, error)
  • func (blob *Blob) Id() Id
  • func (blob *Blob) Len() (int, error)
  • func (blob *Blob) Reader() (*Reader, error)
• type Id
  • func (id Id) FDBKey() fdb.Key
• type Option
  • func WithChunkSize(chunkSize int) Option
  • func WithChunksPerTransaction(chunksPerTransaction int) Option
  • func WithSystemTime(systemTime SystemTime) Option
• type Reader
  • func (br *Reader) Read(buf []byte) (int, error)
• type Store
  • func NewStore(db fdb.Database, ns string, opts ...Option) (*Store, error)
  • func (store *Store) Blob(id Id) (*Blob, error)
  • func (store *Store) CommitUpload(tr fdb.Transaction, uploadToken UploadToken) (Id, error)
  • func (store *Store) Create(ctx context.Context, r io.Reader) (*Blob, error)
  • func (store *Store) DeleteRemovedBlobsBefore(date time.Time) ([]Id, error)
  • func (store *Store) DeleteUploadsStartedBefore(date time.Time) ([]Id, error)
  • func (store *Store) RemoveBlob(id Id) error
  • func (store *Store) Upload(ctx context.Context, r io.Reader) (UploadToken, error)
• type SystemTime
• type UploadToken

Variables

var BlobNotFoundError = errors.New("blob not found")

Types

type Blob

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

func (*Blob) Content

func (blob *Blob) Content(ctx context.Context) ([]byte, error)

func (*Blob) CreatedAt

func (blob *Blob) CreatedAt() (time.Time, error)

func (*Blob) Id

func (blob *Blob) Id() Id

func (*Blob) Len

func (blob *Blob) Len() (int, error)

func (*Blob) Reader

func (blob *Blob) Reader() (*Reader, error)

type Id

type Id string

func (Id) FDBKey

func (id Id) FDBKey() fdb.Key

type Option

type Option func(br *Store) error

func WithChunkSize

func WithChunkSize(chunkSize int) Option

func WithChunksPerTransaction

func WithChunksPerTransaction(chunksPerTransaction int) Option

func WithSystemTime

func WithSystemTime(systemTime SystemTime) Option

type Reader

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

func (*Reader) Read

func (br *Reader) Read(buf []byte) (int, error)

type Store

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

func NewStore

func NewStore(db fdb.Database, ns string, opts ...Option) (*Store, error)

func (*Store) Blob

func (store *Store) Blob(id Id) (*Blob, error)

func (*Store) CommitUpload

func (store *Store) CommitUpload(tr fdb.Transaction, uploadToken UploadToken) (Id, error)

func (*Store) Create

func (store *Store) Create(ctx context.Context, r io.Reader) (*Blob, error)

func (*Store) DeleteRemovedBlobsBefore

func (store *Store) DeleteRemovedBlobsBefore(date time.Time) ([]Id, error)

func (*Store) DeleteUploadsStartedBefore

func (store *Store) DeleteUploadsStartedBefore(date time.Time) ([]Id, error)

func (*Store) RemoveBlob

func (store *Store) RemoveBlob(id Id) error

func (*Store) Upload

func (store *Store) Upload(ctx context.Context, r io.Reader) (UploadToken, error)

type SystemTime

type SystemTime interface {
	Now() time.Time
}

type UploadToken

type UploadToken interface {
	// contains filtered or unexported methods
}