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 BlobReader
• type BlobStore
  • func NewFdbStore(db fdb.Database, ns string, opts ...Option) (BlobStore, error)
• type Id
  • func (id Id) FDBKey() fdb.Key
• type Option
  • func WithChunkSize(chunkSize int) Option
  • func WithChunksPerTransaction(chunksPerTransaction int) Option
• type UploadToken

Variables

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

Types

type BlobReader

type BlobReader interface {
	io.Reader
}

type BlobStore

type BlobStore interface {
	Read(cxt context.Context, id Id) ([]byte, error)
	Upload(ctx context.Context, r io.Reader) (UploadToken, error)
	CommitUpload(tr fdb.Transaction, uploadToken UploadToken) Id
	Create(ctx context.Context, r io.Reader) (Id, error)
	BlobReader(id Id) (BlobReader, error)
	Len(id Id) (uint64, error)
	CreatedAt(id Id) (time.Time, error)
}

func NewFdbStore

func NewFdbStore(db fdb.Database, ns string, opts ...Option) (BlobStore, error)

type Id

type Id string

func (Id) FDBKey

func (id Id) FDBKey() fdb.Key

type Option

type Option func(br *fdbBlobStore) error

func WithChunkSize

func WithChunkSize(chunkSize int) Option

func WithChunksPerTransaction

func WithChunksPerTransaction(chunksPerTransaction int) Option

type UploadToken

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